Pular para o conteúdo principal
POST
/
transactions
/
{transactionId}
/
payments
/
{paymentId}
/
refund
Estornar payment
curl --request POST \
  --url https://api.sandbox.z2pay.com/transactions/{transactionId}/payments/{paymentId}/refund \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "reason": "<string>",
  "amount": 1
}
'
Cria um pedido de refund (estorno) para um payment específico. Suporta estorno parcial via campo amount (em centavos); quando omitido, estorna o valor total. O comportamento de aprovação depende da configuração refund.auto_approve da company (default: true):
  • Com auto-approve, o refund é criado, aprovado e processado no gateway imediatamente.
  • Sem auto-approve, o refund fica pendente de aprovação manual.
Este endpoint suporta idempotência. Envie o header Idempotency-Key para evitar estornos duplicados em caso de retry.
Os detalhes completos do recurso de refund (todos os status, fluxo de aprovação e endpoints dedicados) estão em Refunds.

Autorizações

​
x-api-key
string
header
obrigatório

API Key da Credential (gerada no Backoffice)

Cabeçalhos

​
Idempotency-Key
string

Chave única para garantir idempotência da requisição

Parâmetros de caminho

​
paymentId
string
obrigatório

ID do payment

​
transactionId
string
obrigatório

ID da transação

Corpo

application/json
​
reason
string
obrigatório
Required string length: 1 - 4000
​
amount
integer
Intervalo obrigatório: x >= 0

Resposta

Refund criado e processado