Skip to main content
POST

Corpo da requisição

string
ID da cobrança PIX (depósito) na GoatPay. Obrigatório se não enviar e2eId.
string
EndToEndId do PIX recebido (alternativa ao transactionId).
string
ID único da devolução (1–35 alfanuméricos). Padrão: ID da transação.
number
Valor bruto a devolver — deve ser igual ao depósito (estorno integral).
string
ORIGINAL (PIX padrão) ou RETIRADA (PIX saque/troco). Padrão ORIGINAL.
string
Texto opcional para o pagador (máx. 140 caracteres).
Disponível no trilho PADRÃO. Estorno integral do depósito.

Authorizations

X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Body

application/json

Informe transactionId ou e2eId (pelo menos um).

transactionId
string

ID da cobrança PIX (depósito) na GoatPay.

e2eId
string

EndToEndId do PIX recebido.

refundId
string

ID único da devolução no SPI (alfanumérico). Padrão — ID da transação.

Required string length: 1 - 35
amount
number

Valor bruto a devolver; deve ser igual ao depósito (estorno integral).

nature
enum<string>
default:ORIGINAL

ORIGINAL (PIX padrão) ou RETIRADA (PIX saque/troco).

Available options:
ORIGINAL,
RETIRADA
description
string

Texto opcional exibido ao pagador.

Maximum string length: 140
subaccountId
string

ID da subconta; estorno debita saldo e taxa da subconta quando o depósito pertence a ela.

Response

Reembolso PIX solicitado ou consultado.

success
boolean
required
message
string
required
data
object
required

Transação exposta na API pública após sanitização. Não inclui provider, accountId, metadata, pixRail, direction, updatedAt nem providerStatus.

requestId
string