Skip to main content
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",
    "type": "PIX_IN",
    "status": "COMPLETED",
    "amount": 100,
    "feeAmount": 12,
    "netAmount": 88,
    "coverFee": false,
    "currency": "BRL",
    "description": "Pedido 123",
    "externalReference": "pedido-123",
    "referenceId": "txid_abc",
    "endToEndId": "E12345678202505301234567890123456",
    "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"
  },
  "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",
    "type": "PIX_IN",
    "status": "COMPLETED",
    "amount": 100,
    "feeAmount": 12,
    "netAmount": 88,
    "coverFee": false,
    "currency": "BRL",
    "description": "Pedido 123",
    "externalReference": "pedido-123",
    "referenceId": "txid_abc",
    "endToEndId": "E12345678202505301234567890123456",
    "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"
  },
  "requestId": "req_abc123"
}

​
Parâmetros de rota

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

​
Status em data.status

StatusSignificado
PENDINGAguardando pagamento
PROCESSINGEm processamento
COMPLETEDPago
FAILEDFalhou
CANCELEDCancelado ou QR expirado
REVERSEDEstornado

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

Cobrança PIX criada ou consultada.

​
success
boolean
required
Example:

true

​
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