Estornar transação

posthttps://sandbox-api.rebornpay.io/v1/transactions/{id}/refundAuth obrigatória

Estorna uma transação **PAID** do seller autenticado (PIX). O estorno é **assíncrono**: a resposta retorna imediatamente com status `REFUND_PENDING` e HTTP 202. A confirmação chega via webhook `TRANSACTION_REFUNDED` quando o gateway processar o estorno. Em casos raros em que o gateway confirma de forma síncrona, o status já retorna `REFUNDED`. **Idempotência:** envie o header `Idempotency-Key` (recomendado). A chave é sempre persistida e retornada na resposta — use-a para retentativas seguras.

Headers

X-Api-Keystringrequired

API Key do seller (header)

Path Parameters

idstringrequired

UUID da transação

Body

application/json

amountnumber · int64optional

Valor do estorno em centavos. Omitir para estorno total.

Responses

200Estorno já existente (replay idempotente)

idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: REFUND_PENDING

REFUND_PENDINGPARTIALLY_REFUNDEDREFUNDED

amountinteger · int64required

Valor estornado em centavos

Example: 10000

originalAmountinteger · int64required

Valor original da transação em centavos

Example: 10000

createdAtstring · date-timerequired

Data/hora de criação da transação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

refundedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto o estorno está pendente.

idempotencyKeystringoptional

Chave de idempotência (enviada no header ou gerada pelo servidor)

202Estorno solicitado. Status inicial: REFUND_PENDING.

idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: REFUND_PENDING

REFUND_PENDINGPARTIALLY_REFUNDEDREFUNDED

amountinteger · int64required

Valor estornado em centavos

Example: 10000

originalAmountinteger · int64required

Valor original da transação em centavos

Example: 10000

createdAtstring · date-timerequired

Data/hora de criação da transação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

refundedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto o estorno está pendente.

idempotencyKeystringoptional

Chave de idempotência (enviada no header ou gerada pelo servidor)

401API Key ausente ou inválida

idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: REFUND_PENDING

REFUND_PENDINGPARTIALLY_REFUNDEDREFUNDED

amountinteger · int64required

Valor estornado em centavos

Example: 10000

originalAmountinteger · int64required

Valor original da transação em centavos

Example: 10000

createdAtstring · date-timerequired

Data/hora de criação da transação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

refundedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto o estorno está pendente.

idempotencyKeystringoptional

Chave de idempotência (enviada no header ou gerada pelo servidor)

404Transação não encontrada

idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: REFUND_PENDING

REFUND_PENDINGPARTIALLY_REFUNDEDREFUNDED

amountinteger · int64required

Valor estornado em centavos

Example: 10000

originalAmountinteger · int64required

Valor original da transação em centavos

Example: 10000

createdAtstring · date-timerequired

Data/hora de criação da transação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

refundedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto o estorno está pendente.

idempotencyKeystringoptional

Chave de idempotência (enviada no header ou gerada pelo servidor)

409Idempotency-Key reutilizada com parâmetros diferentes

idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: REFUND_PENDING

REFUND_PENDINGPARTIALLY_REFUNDEDREFUNDED

amountinteger · int64required

Valor estornado em centavos

Example: 10000

originalAmountinteger · int64required

Valor original da transação em centavos

Example: 10000

createdAtstring · date-timerequired

Data/hora de criação da transação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

refundedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto o estorno está pendente.

idempotencyKeystringoptional

Chave de idempotência (enviada no header ou gerada pelo servidor)

422Transação não pode ser estornada (status inválido ou já estornada)

idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: REFUND_PENDING

REFUND_PENDINGPARTIALLY_REFUNDEDREFUNDED

amountinteger · int64required

Valor estornado em centavos

Example: 10000

originalAmountinteger · int64required

Valor original da transação em centavos

Example: 10000

createdAtstring · date-timerequired

Data/hora de criação da transação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

refundedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto o estorno está pendente.

idempotencyKeystringoptional

Chave de idempotência (enviada no header ou gerada pelo servidor)

502Falha ao comunicar com o gateway de pagamento

idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: REFUND_PENDING

REFUND_PENDINGPARTIALLY_REFUNDEDREFUNDED

amountinteger · int64required

Valor estornado em centavos

Example: 10000

originalAmountinteger · int64required

Valor original da transação em centavos

Example: 10000

createdAtstring · date-timerequired

Data/hora de criação da transação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

refundedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto o estorno está pendente.

idempotencyKeystringoptional

Chave de idempotência (enviada no header ou gerada pelo servidor)

curl -X POST 'https://sandbox-api.rebornpay.io/v1/transactions/{id}/refund' \  -H 'X-Api-Key: $API_KEY' \  -H 'Content-Type: application/json'

200Response example

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "REFUND_PENDING",
  "amount": 10000,
  "originalAmount": 10000,
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z",
  "refundedAt": "2025-01-15T10:30:00Z",
  "idempotencyKey": "string"
}