Skip to main content
POST
cURL

Escopo

O que esta chamada faz

Aprovar antecipa um reembolso que já vai acontecer: sem aprovação, ele é efetivado sozinho em autoApproveAt. Use quando não há motivo para esperar, por exemplo quando o comprador confirmou no atendimento que quer o dinheiro de volta. A resposta 200 traz o reembolso com status: "in_settlement": o estorno foi enviado à adquirente e vira refunded quando ela confirmar a devolução.
Só alcança solicitação aberta (refund_requested). Se o comprador desistiu, a venda voltou a paid, e a chamada responde 409 sem estornar nada.É a diferença para Reembolsar Pedido, que estorna na hora qualquer pedido pago. Numa automação disparada pelo webhook refund_requested, use esta rota: aquela estornaria a compra de quem já tinha desistido.

Repetir é seguro

Se a chamada der timeout, repita. Se a aprovação já tinha passado, a resposta é 200 com o estado atual, e nada é estornado de novo.

Erros

409

Exemplo

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

id
string
required

Id do pedido reembolsado ou com reembolso solicitado.

Response

Estorno enviado à adquirente. status vem in_settlement até ela confirmar a devolução, e aí vira refunded. Repetir a chamada devolve o estado atual, sem estornar de novo.

id
string
required
read-only

Id do pedido. É também o id do reembolso: é por ele que se consulta e aprova.

refId
string
required
read-only

Id curto do pedido, o mesmo que aparece no painel.

status
enum<string>
required

refund_requested: o comprador pediu e a janela está aberta; se ninguém agir, o reembolso é efetivado em autoApproveAt. in_settlement: aprovado, aguardando a adquirente confirmar a devolução. acquirer_error: a adquirente recusou o estorno. refunded: devolvido.

  • refund_requested - refund_requested
  • in_settlement - in_settlement
  • acquirer_error - acquirer_error
  • refunded - refunded
Available options:
refund_requested,
in_settlement,
acquirer_error,
refunded
amount
string<decimal>
required
read-only

Valor deste pedido, como string decimal.

Example:

"2.49"

currency
string
required
read-only

Moeda do pedido.

paymentMethod
string
required
read-only

Método de pagamento do pedido.

offerType
string
required
read-only

main, orderbump, upsell ou downsell.

parentOrderId
string | null
required
read-only

Id do pedido principal da mesma compra, quando este é order bump ou upsell.

reason
string | null
required
read-only

Motivo informado pelo comprador ao pedir o reembolso.

refundedBy
string | null
required
read-only

Quem acionou o reembolso: customer (pedido pelo comprador), producer (aprovado ou feito pelo produtor) ou admin (suporte da Cakto).

paidAt
string<date-time> | null
required
read-only

Quando o pedido foi pago.

requestedAt
string<date-time> | null
required
read-only

Quando o comprador pediu o reembolso. null em reembolso feito sem solicitação.

autoApproveAt
string<date-time> | null
required
read-only

Fim da janela da solicitação: se o comprador não cancelar e ninguém aprovar antes, o reembolso é efetivado automaticamente neste instante. null fora da janela.

settlementStartedAt
string<date-time> | null
required
read-only

Quando o estorno foi enviado à adquirente.

refundedAt
string<date-time> | null
required
read-only

Quando a adquirente confirmou a devolução. null enquanto não confirmou.

customer
object
required

Comprador: nome e contato para falar com ele dentro da janela.

product
object
required
offer
object | null
required