Pular para o conteúdo principal
cURL
Esta operação altera uma transação real e exige o escopo transactions:refund na chave. Confira a decisão de devolução antes de executar. O contrato não oferece valor parcial. Após timeout, consulte a transação antes de repetir.

Autorizações

Authorization
string
header
obrigatório

Chave secreta sk_live_ da empresa. Use somente no servidor.

Cabeçalhos

Idempotency-Key
string

Chave de idempotência: reenvios com a mesma chave numa transação já estornada retornam a transação atual sem reexecutar o estorno.

Parâmetros de caminho

id
string
obrigatório

Corpo

Pedido de estorno. O estorno é sempre do valor total; não há campo de valor.

reason
string

Motivo do estorno, opcional.

note
string

Observação sobre o estorno, opcional.

Maximum string length: 500

Resposta

Transação da empresa autenticada. Valores monetários são inteiros em centavos.

id
string
obrigatório
read-only
amount
integer
obrigatório
read-only

Valor bruto cobrado do comprador, em centavos.

net
integer
obrigatório
read-only

Valor líquido do vendedor, em centavos. Os números do exemplo são fictícios e não representam uma proposta de taxas.

productAmount
integer
obrigatório
read-only

Preço do produto, em centavos, antes de juros de parcelamento.

interestAmount
integer
obrigatório
read-only

Juros do parcelamento, em centavos.

interestMode
string | null
obrigatório
read-only

Quem paga os juros do parcelamento: absorb ou pass_to_customer.

mdrAmount
integer
obrigatório
read-only
fixedFeeAmount
integer
obrigatório
read-only
otherFeeAmount
integer
obrigatório
read-only
totalFeeAmount
integer
obrigatório
read-only
status
string
obrigatório
read-only

Status da transação: pending, approved, refused, refunded ou chargeback.

method
enum<string>
obrigatório

Método de pagamento: pix ou credit_card.

Opções disponíveis:
pix,
credit_card,
threeDs,
applepay,
googlepay
customer
object
obrigatório

Pagador da transação: { id, name, email }.

description
string
obrigatório
read-only

Descrição da venda. Vazia quando não informada.

installments
integer
obrigatório
read-only
createdAt
string<date-time>
obrigatório
read-only
paidAt
string<date-time> | null
obrigatório
read-only
refusal
object | null
obrigatório

Motivo detalhado de recusa devolvido pelo emissor do cartão, com orientação para recuperar a venda.

splits
object[]
obrigatório
read-only
checkoutSlug
string | null
obrigatório
read-only

Slug do link de checkout desta venda, e SÓ quando esse link ainda aceita uma compra nova - é com ele que o painel/app monta a URL para o vendedor reenviar ao comprador. null quando não há para onde mandar ninguém: venda sem link (cobrança direta por API), link pausado/arquivado, ou link que só vende assinatura. Reabrir o checkout cria uma cobrança NOVA - não quita a pendente, que segue até expirar.

disputedAt
string<date-time> | null
obrigatório
read-only

Quando a disputa entrou (Payment.chargedbackAt). null fora de disputa - inclusive numa disputa já revertida, que volta a approved e não deve seguir marcada.

reference
string | null
obrigatório
read-only

Pedido do seu sistema para esta venda: o ?ref= com que o checkout foi aberto, ou o exId da cobrança criada pela API. null quando não informado.

items
object[]
obrigatório
read-only
salesperson
object | null
obrigatório
origin
object | null
obrigatório

origin de cada linha da lista de transações do painel.