Skip to main content
POST
/
payments
/
{id}
/
refund
curl -X POST 'https://api.goatpay.com.br/v1/payments/clx_tx_card/refund' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "amount": 50.00 }'

{
  "success": true,
  "message": "Estorno solicitado",
  "data": {
    "refundId": "re_xxx",
    "status": "succeeded"
  },
  "requestId": "req_abc"
}

curl -X POST 'https://api.goatpay.com.br/v1/payments/clx_tx_card/refund' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "amount": 50.00 }'

{
  "success": true,
  "message": "Estorno solicitado",
  "data": {
    "refundId": "re_xxx",
    "status": "succeeded"
  },
  "requestId": "req_abc"
}

​
Parâmetros

​
id
string
required
ID da transação (transactionId do checkout ou do webhook).

​
Corpo (opcional)

​
amount
number
Valor parcial em BRL. Omita para estornar o líquido integral da transação.

​
Regras

  • Somente transações Stripe com status COMPLETED
  • Tipos elegíveis: depósitos/cobranças de cartão (CARD_CREDIT_IN e correlatos)
  • Pode haver taxa administrativa de reembolso conforme configuração da conta
Estornos são definitivos na Stripe. Valide o transactionId antes de chamar.
Permissão: payments/refund. Guia: Cartão Stripe Connect.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

Body

application/json
​
amount
number

Parcial em BRL. Omitir para estorno integral.

Required range: x >= 0.01

Response

200 - application/json

Estorno Stripe solicitado.

​
success
boolean
required
​
message
string
required
​
data
object
required
​
requestId
string