Cancelar um link de pagamento

curl -X POST https://api.therius.io/v1/payment-link/5b1f0a52-3c0e-4a52-9d57-0c1d7e9f2a10/cancel \ -H "Authorization: Bearer prv_production_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "merchantCode": "MERCHANT_001" }'

{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "url": "<string>", "type": "one-time", "status": "active", "amountMode": "fixed", "amount": { "currency": "USD", "value": 4999, "exponent": 2 }, "amountMin": 123, "amountMax": 123, "subscriptionPlanId": 123, "checkoutConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "title": "<string>", "description": "<string>", "reference": "<string>", "customerEmail": "<string>", "customerName": "<string>", "returnUrl": "<string>", "saveCardEnabled": true, "reusable": true, "maxUses": 123, "usesCount": 123, "environment": "production", "expiresAt": "2023-11-07T05:31:56Z", "usedAt": "2023-11-07T05:31:56Z", "createdAt": "2023-11-07T05:31:56Z" }

Exemplo

curl -X POST https://api.therius.io/v1/payment-link/5b1f0a52-3c0e-4a52-9d57-0c1d7e9f2a10/cancel \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "merchantCode": "MERCHANT_001" }'

Autorizações

Authorization

string

header

obrigatório

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Parâmetros de caminho

string<uuid>

obrigatório

The payment link id.

Corpo

application/json

merchantCode

string

Your merchant account identifier. Required if the key maps to more than one merchant account.

Resposta

The cancelled link (cancelling an already-cancelled link is a no-op)

string<uuid>

url

string<uri>

The hosted checkout URL to share with the payer.

type

enum<string>

Opções disponíveis:

one-time,

subscription

status

enum<string>

used once a single-use link takes its first successful payment, or a reusable link reaches maxUses.

Opções disponíveis:

active,

used,

expired,

cancelled

amountMode

enum<string>

Opções disponíveis:

fixed,

customer_entered

amount

object

Absent on subscription links. For customer_entered links only currency and exponent are set.

Show child attributes

amountMin

integer<int64>

Minimum payer-entered amount, minor units.

amountMax

integer<int64>

Maximum payer-entered amount, minor units.

subscriptionPlanId

integer<int64>

checkoutConfigId

string<uuid>

title

string

description

string

reference

string

customerEmail

string

customerName

string

returnUrl

string<uri>

saveCardEnabled

boolean

reusable

boolean

maxUses

integer

usesCount

integer

Number of successful payments taken through this link.

environment

enum<string>

Opções disponíveis:

production,

sandbox

expiresAt

string<date-time>

usedAt

string<date-time>

createdAt

string<date-time>

Pagamentos

Links de pagamento

Tokenização

Assinaturas

Subscription Plans

Sessão do SDK

Cancelar um link de pagamento

Exemplo

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Exemplo

Autorizações

Parâmetros de caminho

Corpo

Resposta

Exemplo