Emita um reembolso total ou parcial

POST

payment

{id}

refund

curl -X POST https://api.therius.io/v1/payment/9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e/refund \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001",
    "amount": { "currency": "USD", "value": 4999, "exponent": 2 }
  }'

{
  "id": "9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e",
  "status": "refunded",
  "paymentCode": "PC-1234567890",
  "orderCode": "ORDER-20240101-001",
  "merchantCode": "MERCHANT_001",
  "amount": { "currency": "USD", "value": 4999, "exponent": 2 }
}

Use POST /payment/{id}/refund para devolver fundos a um titular de cartão depois que um pagamento foi capturado e liquidado. Você pode emitir um único reembolso total ou vários reembolsos parciais — desde que o valor cumulativo reembolsado não exceda o total capturado originalmente. Os reembolsos costumam aparecer no extrato do titular do cartão dentro de 5–10 dias úteis, conforme o banco dele.

Identificar o pagamento

{id} é o id de pagamento do Therius devolvido por POST /payment/authorization e POST /payment/purchase. orderCode e paymentCode são os seus próprios campos de referência e não são aceitos aqui. Um id desconhecido ou não pertencente devolve 404.

Exemplos

Reembolso total

curl -X POST https://api.therius.io/v1/payment/9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e/refund \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001",
    "amount": { "currency": "USD", "value": 4999, "exponent": 2 }
  }'

{
  "id": "9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e",
  "status": "refunded",
  "paymentCode": "PC-1234567890",
  "orderCode": "ORDER-20240101-001",
  "merchantCode": "MERCHANT_001",
  "amount": { "currency": "USD", "value": 4999, "exponent": 2 }
}

Reembolso parcial

Reembolsar apenas parte de um pedido — por exemplo, um único item devolvido de uma compra com vários itens:

curl -X POST https://api.therius.io/v1/payment/9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e/refund \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001",
    "reference": "RETURN-98765",
    "amount": { "currency": "USD", "value": 1999, "exponent": 2 }
  }'

{
  "id": "9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e",
  "status": "refunded",
  "paymentCode": "PC-1234567890",
  "orderCode": "ORDER-20240101-001",
  "merchantCode": "MERCHANT_001",
  "amount": { "currency": "USD", "value": 1999, "exponent": 2 }
}

Você não pode reembolsar um pagamento que está no estado authorized (ainda não capturado). Para liberar uma autorização que não foi capturada, use Cancel em vez disso. Tentar reembolsar um pagamento não capturado devolve um erro.

Vários reembolsos parciais são permitidos. Você pode chamar este endpoint várias vezes contra o mesmo id de pagamento, desde que o valor cumulativo de reembolso não exceda o valor capturado original. Cada chamada deve usar um Idempotency-Key distinto.

Se você não tem certeza se um pagamento está no estado authorized ou captured, use Cancel or Refund em vez disso — ele detecta o estado automaticamente e toma a ação apropriada.

Autorizações

Authorization

string

header

obrigatório

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

Cabeçalhos

Idempotency-Key

string<uuid>

A UUID you generate per operation. Required in production. Retrying with the same key returns the original response.

Parâmetros de caminho

string<uuid>

obrigatório

The Therius payment id returned by POST /payment/authorization or POST /payment/purchase.

Corpo

application/json

merchantCode

string

obrigatório

Your merchant account identifier. Validated against the Bearer key's merchant; required if the key maps to more than one merchant account.

amount

object

obrigatório

Show child attributes

reference

string

Optional internal reference for this refund operation.

Resposta

200 - application/json

Refund result

Result of a capture, refund, cancel or cancel_or_refund.

string

The Therius payment id.

merchantCode

string

orderCode

string

paymentCode

string

Therius receipt ID.

amount

object

Show child attributes

status

enum<string>

Outcome of the operation.

Opções disponíveis:

captured,

refunded,

cancelled,

failed

curl -X POST https://api.therius.io/v1/payment/9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e/refund \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001",
    "amount": { "currency": "USD", "value": 4999, "exponent": 2 }
  }'

{
  "id": "9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e",
  "status": "refunded",
  "paymentCode": "PC-1234567890",
  "orderCode": "ORDER-20240101-001",
  "merchantCode": "MERCHANT_001",
  "amount": { "currency": "USD", "value": 4999, "exponent": 2 }
}

Pagamentos

Tokenização

Assinaturas

Planos

Sessão do SDK

Emita um reembolso total ou parcial

Identificar o pagamento

Exemplos

Reembolso total

Reembolso parcial

Autorizações

Cabeçalhos

Parâmetros de caminho

Corpo

Resposta

​Identificar o pagamento

​Exemplos

​Reembolso total

​Reembolso parcial

Autorizações

Cabeçalhos

Parâmetros de caminho

Corpo

Resposta

Identificar o pagamento

Exemplos

Reembolso total

Reembolso parcial