Consultar cobrança PIX

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": "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,
    "payer": {
      "name": "João da Silva",
      "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"
}

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": "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,
    "payer": {
      "name": "João da Silva",
      "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/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": "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,
    "payer": {
      "name": "João da Silva",
      "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`

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)
qrCodeBase64 / qrcodeUrl	QR para exibir
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

Parâmetros de rota

string

required

ID da transação (clx_...) ou externalReference enviado na criação.

Authorizations

X-API-Key

string

header

required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Path Parameters

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.

Show child attributes

requestId

string

Criar cobrança Listar cobranças

Introdução

Webhooks

PIX

Conta

Loja

Subcontas

Consultar cobrança PIX

Envelope da resposta

Status em `data.status`

Campos em `data`

Parâmetros de rota

Authorizations

Path Parameters

Response

​Envelope da resposta

​Status em data.status

​Campos em data

​Parâmetros de rota

Authorizations

Path Parameters

Response

Envelope da resposta

Status em `data.status`

Campos em `data`

Parâmetros de rota