curl -X GET 'https://api.goatpay.com.br/v1/refunds/list?page=1&pageSize=50' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Reembolsos listados com sucesso",
"data": {
"items": [{
"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"
}
}],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
Reembolso
Listar reembolsos PIX
Lista depósitos com estorno solicitado, em andamento ou concluído.
GET
/
refunds
/
list
curl -X GET 'https://api.goatpay.com.br/v1/refunds/list?page=1&pageSize=50' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Reembolsos listados com sucesso",
"data": {
"items": [{
"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"
}
}],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
curl -X GET 'https://api.goatpay.com.br/v1/refunds/list?page=1&pageSize=50' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Reembolsos listados com sucesso",
"data": {
"items": [{
"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"
}
}],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
Parâmetros de query
number
Número da página (padrão 1).
number
Itens por página (padrão 50, máximo 100).
string
ISO 8601 — início do período (
createdAt).string
ISO 8601 — fim do período (
createdAt).string
PENDING, PROCESSING, COMPLETED, FAILED, CANCELED ou REVERSED.
string
Filtro exato pela referência externa.
string
Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.
Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Available options:
PENDING, PROCESSING, COMPLETED, FAILED, CANCELED, REVERSED Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.