curl -X GET 'https://api.goatpay.com.br/v1/payment-pix/get/clx_transacao' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Pagamento PIX encontrado",
"data": {
"id": "clx_transacao",
"accountId": "clx_conta",
"type": "PIX_IN",
"direction": "IN",
"status": "PENDING",
"amount": 100,
"feeAmount": 12,
"netAmount": 88,
"coverFee": false,
"currency": "BRL",
"description": "Pedido 123",
"externalReference": "pedido-123",
"referenceId": "txid_abc",
"endToEndId": null,
"pixKey": null,
"pixKeyType": null,
"copyPaste": "00020101021226730014br.gov.bcb.pix...",
"qrcodeUrl": "https://pay.goatpay.com.br/p/clx_transacao",
"completedAt": null,
"expiresAt": "2026-05-31T18:00:00.000Z",
"createdAt": "2026-05-31T11:00:00.000Z",
"updatedAt": "2026-05-31T11:00:00.000Z"
},
"requestId": "req_abc123"
}
Receber
Consultar cobrança PIX
Consulta cobrança PIX (receber) pelo ID interno GoatPay ou externalReference. Para polling de status, prefira GET /payment-pix/status/{id}.
GET
/
payment-pix
/
get
/
{id}
curl -X GET 'https://api.goatpay.com.br/v1/payment-pix/get/clx_transacao' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Pagamento PIX encontrado",
"data": {
"id": "clx_transacao",
"accountId": "clx_conta",
"type": "PIX_IN",
"direction": "IN",
"status": "PENDING",
"amount": 100,
"feeAmount": 12,
"netAmount": 88,
"coverFee": false,
"currency": "BRL",
"description": "Pedido 123",
"externalReference": "pedido-123",
"referenceId": "txid_abc",
"endToEndId": null,
"pixKey": null,
"pixKeyType": null,
"copyPaste": "00020101021226730014br.gov.bcb.pix...",
"qrcodeUrl": "https://pay.goatpay.com.br/p/clx_transacao",
"completedAt": null,
"expiresAt": "2026-05-31T18:00:00.000Z",
"createdAt": "2026-05-31T11:00:00.000Z",
"updatedAt": "2026-05-31T11:00:00.000Z"
},
"requestId": "req_abc123"
}
curl -X GET 'https://api.goatpay.com.br/v1/payment-pix/get/clx_transacao' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Pagamento PIX encontrado",
"data": {
"id": "clx_transacao",
"accountId": "clx_conta",
"type": "PIX_IN",
"direction": "IN",
"status": "PENDING",
"amount": 100,
"feeAmount": 12,
"netAmount": 88,
"coverFee": false,
"currency": "BRL",
"description": "Pedido 123",
"externalReference": "pedido-123",
"referenceId": "txid_abc",
"endToEndId": null,
"pixKey": null,
"pixKeyType": null,
"copyPaste": "00020101021226730014br.gov.bcb.pix...",
"qrcodeUrl": "https://pay.goatpay.com.br/p/clx_transacao",
"completedAt": null,
"expiresAt": "2026-05-31T18:00:00.000Z",
"createdAt": "2026-05-31T11:00:00.000Z",
"updatedAt": "2026-05-31T11: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
| Status | Significado |
|---|---|
| PENDING | Aguardando pagamento |
| PROCESSING | Em processamento |
| COMPLETED | Recebido com sucesso |
| FAILED | Falhou |
| CANCELED | Cancelado ou QR expirado |
| REVERSED | Estorno concluído |
Campos em data
| Campo | Descrição |
|---|---|
| id | ID da transação |
| type | PIX_IN ou PIX_SPLIT_IN |
| status | Ver tabela acima |
| amount | Valor bruto |
| netAmount | Valor líquido |
| feeAmount | Tarifa da operação |
| copyPaste | Copia e cola (pendente ou processando) |
| qrcodeUrl | URL da imagem do QR (pendente ou processando) |
| endToEndId | Identificador E2E após pagamento |
| payer | Pagador PIX Padrão (name + document) após o pagamento |
| expiresAt | Expiração do QR |
| completedAt | Data de conclusão |
Desde 15/08/2026,
qrCodeBase64 não é retornado neste endpoint — apenas em POST /payment-pix/create. Webhooks (payment.created) também não incluem QR; persista a resposta do create para exibir a imagem.Para polling de status sem QR Code nem copia e cola, use Consultar status.
Parâmetros de rota
string
required
ID da transação (
clx_...) ou externalReference enviado na criação.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)