Consultar status da cobrança PIX

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

{
  "success": true,
  "message": "Status do pagamento PIX consultado",
  "data": {
    "id": "clx_transacao",
    "status": "PENDING",
    "amount": 100,
    "netAmount": 99.2,
    "feeAmount": 0.8,
    "externalReference": "pedido-123",
    "endToEndId": null,
    "expiresAt": "2026-07-31T18:00:00.000Z",
    "completedAt": null,
    "createdAt": "2026-07-31T12:00:00.000Z"
  },
  "requestId": "req_abc123"
}

{
  "success": true,
  "message": "Status do pagamento PIX consultado",
  "data": {
    "id": "clx_transacao",
    "status": "COMPLETED",
    "amount": 100,
    "netAmount": 99.2,
    "feeAmount": 0.8,
    "externalReference": "pedido-123",
    "endToEndId": "E12345678202505301234567890123456",
    "expiresAt": "2026-07-31T18:00:00.000Z",
    "completedAt": "2026-07-31T12:05:00.000Z",
    "createdAt": "2026-07-31T12:00:00.000Z"
  },
  "requestId": "req_abc123"
}

GET

payment-pix

status

{id}

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

{
  "success": true,
  "message": "Status do pagamento PIX consultado",
  "data": {
    "id": "clx_transacao",
    "status": "PENDING",
    "amount": 100,
    "netAmount": 99.2,
    "feeAmount": 0.8,
    "externalReference": "pedido-123",
    "endToEndId": null,
    "expiresAt": "2026-07-31T18:00:00.000Z",
    "completedAt": null,
    "createdAt": "2026-07-31T12:00:00.000Z"
  },
  "requestId": "req_abc123"
}

{
  "success": true,
  "message": "Status do pagamento PIX consultado",
  "data": {
    "id": "clx_transacao",
    "status": "COMPLETED",
    "amount": 100,
    "netAmount": 99.2,
    "feeAmount": 0.8,
    "externalReference": "pedido-123",
    "endToEndId": "E12345678202505301234567890123456",
    "expiresAt": "2026-07-31T18:00:00.000Z",
    "completedAt": "2026-07-31T12:05:00.000Z",
    "createdAt": "2026-07-31T12:00:00.000Z"
  },
  "requestId": "req_abc123"
}

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

{
  "success": true,
  "message": "Status do pagamento PIX consultado",
  "data": {
    "id": "clx_transacao",
    "status": "PENDING",
    "amount": 100,
    "netAmount": 99.2,
    "feeAmount": 0.8,
    "externalReference": "pedido-123",
    "endToEndId": null,
    "expiresAt": "2026-07-31T18:00:00.000Z",
    "completedAt": null,
    "createdAt": "2026-07-31T12:00:00.000Z"
  },
  "requestId": "req_abc123"
}

{
  "success": true,
  "message": "Status do pagamento PIX consultado",
  "data": {
    "id": "clx_transacao",
    "status": "COMPLETED",
    "amount": 100,
    "netAmount": 99.2,
    "feeAmount": 0.8,
    "externalReference": "pedido-123",
    "endToEndId": "E12345678202505301234567890123456",
    "expiresAt": "2026-07-31T18:00:00.000Z",
    "completedAt": "2026-07-31T12:05:00.000Z",
    "createdAt": "2026-07-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
data	object	Status e campos essenciais (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
status	Ver tabela acima
amount	Valor bruto
netAmount	Valor líquido
feeAmount	Tarifa da operação
externalReference	Referência enviada na criação
endToEndId	Identificador E2E após pagamento
expiresAt	Expiração do QR
completedAt	Data de conclusão
createdAt	Data de criação

Para QR Code, copia e cola, pagador e demais detalhes, use Consultar cobrança. Em produção, prefira webhooks (payment.paid).

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

Status da cobrança PIX (payload enxuto para polling).

success

boolean

required

Example:

true

message

string

required

data

object

required

Show child attributes

requestId

string

Introdução

Webhooks

WebSocket

PIX

Conta

Loja

Subcontas

Consultar status da 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