curl -X GET 'https://api.goatpay.com.br/v1/payment-pix/list?page=1&pageSize=50' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Pagamentos PIX listados",
"data": {
"items": [{
"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"
}],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
Receber
Listar cobranças PIX
Lista cobranças PIX (PIX_IN) com paginação e filtros.
GET
/
payment-pix
/
list
curl -X GET 'https://api.goatpay.com.br/v1/payment-pix/list?page=1&pageSize=50' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Pagamentos PIX listados",
"data": {
"items": [{
"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"
}],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
curl -X GET 'https://api.goatpay.com.br/v1/payment-pix/list?page=1&pageSize=50' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Pagamentos PIX listados",
"data": {
"items": [{
"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"
}],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
Parâmetros de query
number
Número da página (padrão 1).
number
Itens por página (padrão 50, máximo 100).
string
ISO 8601 — início do período (
createdAt).string
ISO 8601 — fim do período (
createdAt).string
PENDING, PROCESSING, COMPLETED, FAILED, CANCELED ou REVERSED.
string
Filtro exato pela referência externa.
string
Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.
Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Available options:
PENDING, PROCESSING, COMPLETED, FAILED, CANCELED, REVERSED Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.
Filtra transações vinculadas à subconta merchant (PIX com subaccountId na criação, movimentações internas, MED/reembolso, etc.). Alias de merchantSubaccountId. Quando informado, o filtro de trilho PIX da API key é ignorado.
Mesmo filtro que subaccountId.