Estornar transação

POSThttps://{apiUrl}/transactions/{id}/refund

Atualizado em 25 de abril de 2025 · 1 min de leitura

Estornar uma transação paga

Endpoint: POST https://{apiUrl}/transactions/{id}/refund

Solicita o estorno de uma transação paga. Suporta estorno total ou parcial.

Parâmetros

POSThttps://{apiUrl}/transactions/{id}/refund

URL base da API

Token de autenticação

Path Params

idstringrequired

Identificador único da transação (UUID)

Body Params

amountintegeroptional

Valor em centavos a estornar. Se omitido, realiza o estorno total.

msgstringoptional

Mensagem explicando o motivo do estorno

curl --request POST \
  --url "https://{apiUrl}/transactions/{id}/refund" \
  --header "Content-Type: application/json" 
  --data '{}'

Response

Choose an example:

application/json

Tipo de estorno	Status resultante	Observação
Estorno total	`refunded`	Valor integral devolvido ao consumidor
Estorno parcial	`paid`	Status permanece `paid`; valores estornados ficam em `refunds.details`

json

{
  "status": "OK"
}

Responses

Esta página foi útil?