Reembolso
Solicitar reembolso PIX
Devolve um depósito PIX recebido (estorno no SPI).
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
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Body
application/json
Informe transactionId ou e2eId (pelo menos um).
ID da cobrança PIX (depósito) na GoatPay.
EndToEndId do PIX recebido.
ID único da devolução no SPI (alfanumérico). Padrão — ID da transação.
Required string length:
1 - 35Valor bruto a devolver; deve ser igual ao depósito (estorno integral).
ORIGINAL (PIX padrão) ou RETIRADA (PIX saque/troco).
Available options:
ORIGINAL, RETIRADA Texto opcional exibido ao pagador.
Maximum string length:
140ID da subconta; estorno debita saldo e taxa da subconta quando o depósito pertence a ela.

