Skip to main content
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": 8.5,
    "netAmount": 91.5,
    "coverFee": false,
    "currency": "BRL",
    "description": "Pedido 123",
    "externalReference": "pedido-123",
    "referenceId": "txid_dep_abc",
    "endToEndId": "E12345678202505301234567890123456",
    "createdAt": "2026-06-01T12:00:00.000Z",
    "completedAt": "2026-06-01T12:30:00.000Z",
    "refund": {
      "status": "COMPLETED",
      "refundId": "devolucao-pedido-123",
      "requestedAt": "2026-06-02T10:00:00.000Z",
      "completedAt": "2026-06-02T10:05:00.000Z",
      "debitNet": 91.5,
      "depositNet": 91.5,
      "transferFee": 2,
      "nature": "ORIGINAL",
      "description": "Estorno pedido 123"
    }
  },
  "requestId": "req_abc123"
}

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": 8.5,
    "netAmount": 91.5,
    "coverFee": false,
    "currency": "BRL",
    "description": "Pedido 123",
    "externalReference": "pedido-123",
    "referenceId": "txid_dep_abc",
    "endToEndId": "E12345678202505301234567890123456",
    "createdAt": "2026-06-01T12:00:00.000Z",
    "completedAt": "2026-06-01T12:30:00.000Z",
    "refund": {
      "status": "COMPLETED",
      "refundId": "devolucao-pedido-123",
      "requestedAt": "2026-06-02T10:00:00.000Z",
      "completedAt": "2026-06-02T10:05:00.000Z",
      "debitNet": 91.5,
      "depositNet": 91.5,
      "transferFee": 2,
      "nature": "ORIGINAL",
      "description": "Estorno pedido 123"
    }
  },
  "requestId": "req_abc123"
}

​
Parâmetros

​
id
string
required
ID da transação de depósito original, ID do reembolso ou endToEndId do PIX recebido.

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.)

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