curl -X GET 'https://api.goatpay.com.br/v1/refunds/get/clx_pix_in' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Reembolso consultado com sucesso",
"data": {
"id": "clx_pix_in",
"type": "PIX_IN",
"status": "REVERSED",
"amount": 100,
"feeAmount": 12,
"netAmount": 88,
"currency": "BRL",
"description": "Pedido 123",
"externalReference": "pedido-123",
"referenceId": "txid_abc",
"endToEndId": "E12345678202505301234567890123456",
"completedAt": "2026-05-31T12:00:00.000Z",
"createdAt": "2026-05-31T11:00:00.000Z",
"refund": {
"status": "COMPLETED",
"refundId": "devolucao-pedido-123",
"requestedAt": "2026-06-01T10:00:00.000Z",
"completedAt": "2026-06-01T10:05:00.000Z",
"debitNet": 88,
"depositNet": 100,
"transferFee": 0,
"nature": "ORIGINAL",
"description": "Estorno pedido #123"
}
},
"requestId": "req_abc"
}
Reembolso
Consultar reembolso PIX
Consulta estorno por ID da transação, refundId ou e2eId.
GET
/
refunds
/
get
/
{id}
curl -X GET 'https://api.goatpay.com.br/v1/refunds/get/clx_pix_in' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Reembolso consultado com sucesso",
"data": {
"id": "clx_pix_in",
"type": "PIX_IN",
"status": "REVERSED",
"amount": 100,
"feeAmount": 12,
"netAmount": 88,
"currency": "BRL",
"description": "Pedido 123",
"externalReference": "pedido-123",
"referenceId": "txid_abc",
"endToEndId": "E12345678202505301234567890123456",
"completedAt": "2026-05-31T12:00:00.000Z",
"createdAt": "2026-05-31T11:00:00.000Z",
"refund": {
"status": "COMPLETED",
"refundId": "devolucao-pedido-123",
"requestedAt": "2026-06-01T10:00:00.000Z",
"completedAt": "2026-06-01T10:05:00.000Z",
"debitNet": 88,
"depositNet": 100,
"transferFee": 0,
"nature": "ORIGINAL",
"description": "Estorno pedido #123"
}
},
"requestId": "req_abc"
}
curl -X GET 'https://api.goatpay.com.br/v1/refunds/get/clx_pix_in' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Reembolso consultado com sucesso",
"data": {
"id": "clx_pix_in",
"type": "PIX_IN",
"status": "REVERSED",
"amount": 100,
"feeAmount": 12,
"netAmount": 88,
"currency": "BRL",
"description": "Pedido 123",
"externalReference": "pedido-123",
"referenceId": "txid_abc",
"endToEndId": "E12345678202505301234567890123456",
"completedAt": "2026-05-31T12:00:00.000Z",
"createdAt": "2026-05-31T11:00:00.000Z",
"refund": {
"status": "COMPLETED",
"refundId": "devolucao-pedido-123",
"requestedAt": "2026-06-01T10:00:00.000Z",
"completedAt": "2026-06-01T10:05:00.000Z",
"debitNet": 88,
"depositNet": 100,
"transferFee": 0,
"nature": "ORIGINAL",
"description": "Estorno pedido #123"
}
},
"requestId": "req_abc"
}
Parâmetros
string
required
ID do recurso.
Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)

