Skip to main content
POST
POST /payment/{id}/cancel anula uma autorização antes de ela ser capturada, liberando de imediato a retenção sobre os fundos do titular do cartão. Use isto quando um pedido é cancelado ou não pode ser cumprido depois que a autorização foi colocada. Se o pagamento já foi capturado e liquidado, use Refund em vez disso — você não pode cancelar um pagamento capturado.

​
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.

​
Exemplo

​
Cancelar uma autorização

Este endpoint só funciona para pagamentos no estado authorized. Se o pagamento já foi capturado, esta chamada devolve um erro. Use Refund para devolver fundos em um pagamento capturado, ou Cancel or Refund se você não conhece o estado atual.
Quando você cancela uma autorização, o saldo disponível do titular do cartão é restaurado de imediato do lado do Therius. O tempo refletido no extrato bancário do titular do cartão varia conforme o emissor — normalmente é de instantâneo a algumas horas, mas pode levar de 3 a 5 dias úteis para alguns emissores.

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

​
id
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.

​
reference
string

Optional internal reference for this cancellation.

Resposta

200 - application/json

Cancellation result

Result of a capture, refund, cancel or cancel_or_refund.

​
id
string

The Therius payment id.

​
merchantCode
string
​
orderCode
string
​
paymentCode
string

Therius receipt ID.

​
amount
object
​
status
enum<string>

Outcome of the operation.

Opções disponíveis:
captured,
refunded,
cancelled,
failed