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",
"accountId": "clx_conta",
"type": "PIX_OUT",
"direction": "OUT",
"status": "COMPLETED",
"amount": 100,
"feeAmount": 12,
"netAmount": 88,
"coverFee": false,
"currency": "BRL",
"description": "Pedido 123",
"externalReference": "pedido-123",
"referenceId": "txid_abc",
"endToEndId": "E12345678202505301234567890123456",
"pixKey": null,
"pixKeyType": null,
"recipient": {
"name": "Maria Recebedora",
"document": "12345678909"
},
"copyPaste": "00020101021226730014br.gov.bcb.pix...",
"qrCodeBase64": "data:image/png;base64,...",
"qrcodeUrl": "https://...",
"completedAt": "2026-05-31T12:00:00.000Z",
"expiresAt": "2026-05-31T18:00:00.000Z",
"createdAt": "2026-05-31T11:00:00.000Z",
"updatedAt": "2026-05-31T12:00:00.000Z"
},
"requestId": "req_abc123"
}
Enviar
Consultar envio PIX
Consulta envio PIX (PIX_OUT) pelo ID interno ou externalReference. Para polling de status, prefira GET /transfer-pix/status/{id}.
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",
"accountId": "clx_conta",
"type": "PIX_OUT",
"direction": "OUT",
"status": "COMPLETED",
"amount": 100,
"feeAmount": 12,
"netAmount": 88,
"coverFee": false,
"currency": "BRL",
"description": "Pedido 123",
"externalReference": "pedido-123",
"referenceId": "txid_abc",
"endToEndId": "E12345678202505301234567890123456",
"pixKey": null,
"pixKeyType": null,
"recipient": {
"name": "Maria Recebedora",
"document": "12345678909"
},
"copyPaste": "00020101021226730014br.gov.bcb.pix...",
"qrCodeBase64": "data:image/png;base64,...",
"qrcodeUrl": "https://...",
"completedAt": "2026-05-31T12:00:00.000Z",
"expiresAt": "2026-05-31T18:00:00.000Z",
"createdAt": "2026-05-31T11:00:00.000Z",
"updatedAt": "2026-05-31T12: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",
"accountId": "clx_conta",
"type": "PIX_OUT",
"direction": "OUT",
"status": "COMPLETED",
"amount": 100,
"feeAmount": 12,
"netAmount": 88,
"coverFee": false,
"currency": "BRL",
"description": "Pedido 123",
"externalReference": "pedido-123",
"referenceId": "txid_abc",
"endToEndId": "E12345678202505301234567890123456",
"pixKey": null,
"pixKeyType": null,
"recipient": {
"name": "Maria Recebedora",
"document": "12345678909"
},
"copyPaste": "00020101021226730014br.gov.bcb.pix...",
"qrCodeBase64": "data:image/png;base64,...",
"qrcodeUrl": "https://...",
"completedAt": "2026-05-31T12:00:00.000Z",
"expiresAt": "2026-05-31T18:00:00.000Z",
"createdAt": "2026-05-31T11:00:00.000Z",
"updatedAt": "2026-05-31T12:00:00.000Z"
},
"requestId": "req_abc123"
}
Envelope da resposta
| Campo | Tipo | Descrição |
|---|---|---|
| success | boolean | true em sucesso HTTP 2xx |
| message | string | Mensagem legível (ex.: “Transação PIX encontrada”) |
| data | object | Payload do recurso (formato abaixo) |
| requestId | string | ID da requisição para suporte (req_...) |
Status em data.status (envio PIX)
| Status | Significado |
|---|---|
| PENDING | Em fila / aguardando SPI |
| PROCESSING | Processando |
| COMPLETED | Enviado com sucesso |
| FAILED | Falhou |
| CANCELED | Cancelado |
type: PIX_OUT e pixKey / endToEndId preenchidos após liquidação. Após liquidar, recipient traz name e document do favorecido (PIX Padrão).
Para polling de status sem dados do favorecido, use Consultar status.
Parâmetros de rota
string
required
ID da transação ou
externalReference.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)