Skip to main content
GET
/
transfer-pix
/
get
/
{id}
curl -X GET 'https://api.goatpay.com.br/v1/transfer-pix/get/clx_transacao' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Transferência PIX encontrada",
  "data": {
    "id": "clx_transacao",
    "type": "PIX_OUT",
    "status": "COMPLETED",
    "amount": 50,
    "feeAmount": 2,
    "netAmount": 52,
    "coverFee": true,
    "currency": "BRL",
    "description": "Saque PIX",
    "externalReference": "saque-123",
    "referenceId": "txid_abc",
    "endToEndId": "E12345678202505301234567890123456",
    "pixKey": "12345678909",
    "pixKeyType": "CPF",
    "completedAt": "2026-06-01T13:05:00.000Z",
    "createdAt": "2026-06-01T13:00:00.000Z"
  },
  "requestId": "req_abc123"
}

curl -X GET 'https://api.goatpay.com.br/v1/transfer-pix/get/clx_transacao' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Transferência PIX encontrada",
  "data": {
    "id": "clx_transacao",
    "type": "PIX_OUT",
    "status": "COMPLETED",
    "amount": 50,
    "feeAmount": 2,
    "netAmount": 52,
    "coverFee": true,
    "currency": "BRL",
    "description": "Saque PIX",
    "externalReference": "saque-123",
    "referenceId": "txid_abc",
    "endToEndId": "E12345678202505301234567890123456",
    "pixKey": "12345678909",
    "pixKeyType": "CPF",
    "completedAt": "2026-06-01T13:05:00.000Z",
    "createdAt": "2026-06-01T13:00:00.000Z"
  },
  "requestId": "req_abc123"
}

​
Parâmetros de rota

​
id
string
required
ID da transação ou externalReference.

​
Campos principais em data

CampoDescrição
statusPENDING, PROCESSING, COMPLETED, FAILED, CANCELED
amountValor enviado ao destinatário
feeAmountTaxa GoatPay
netAmountTotal debitado da conta
referenceIdID de referência no processador de pagamento (quando existir)
endToEndIdIdentificador PIX no SPI (após liquidação)

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

Transferência PIX criada ou consultada.

​
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