Skip to main content
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_pix_in",
        "type": "PIX_IN",
        "status": "COMPLETED",
        "amount": 100,
        "feeAmount": 3.5,
        "netAmount": 96.5,
        "coverFee": false,
        "currency": "BRL",
        "description": "Pedido 123",
        "externalReference": "pedido-123",
        "referenceId": "txid_abc",
        "endToEndId": "E12345678202505301234567890123456",
        "copyPaste": "000201010212...",
        "completedAt": "2026-06-01T12:30:00.000Z",
        "createdAt": "2026-06-01T12:00:00.000Z"
      }
    ],
    "page": 1,
    "pageSize": 50,
    "total": 0,
    "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_pix_in",
        "type": "PIX_IN",
        "status": "COMPLETED",
        "amount": 100,
        "feeAmount": 3.5,
        "netAmount": 96.5,
        "coverFee": false,
        "currency": "BRL",
        "description": "Pedido 123",
        "externalReference": "pedido-123",
        "referenceId": "txid_abc",
        "endToEndId": "E12345678202505301234567890123456",
        "copyPaste": "000201010212...",
        "completedAt": "2026-06-01T12:30:00.000Z",
        "createdAt": "2026-06-01T12:00:00.000Z"
      }
    ],
    "page": 1,
    "pageSize": 50,
    "total": 0,
    "pages": 1
  },
  "requestId": "req_abc"
}

​
Parâmetros de query

​
page
number
Número da página (padrão 1).
​
pageSize
number
Itens por página (padrão 50, máximo 100).
​
dateFrom
string
ISO 8601 — início do período (createdAt).
​
dateTo
string
ISO 8601 — fim do período (createdAt).
​
status
string
PENDING, PROCESSING, COMPLETED, FAILED, CANCELED ou REVERSED.
​
externalReference
string
Filtro exato pela referência externa.
​
search
string
Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.
​
subaccountId
string
Retorna apenas cobranças vinculadas à subconta merchant (mesmo ID enviado em POST /payment-pix/create). Alias: merchantSubaccountId. Com este filtro, o trilho PIX fixo da API key não é aplicado.
​
merchantSubaccountId
string
Mesmo filtro que subaccountId.

​
Campo subaccountId em cada item

Quando a cobrança foi criada com subconta, data.items[].subaccountId traz o ID da subconta. Cobranças na conta principal não incluem o campo.

Authorizations

​
X-API-Key
string
header
required

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

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
pageSize
integer
default:50
Required range: 1 <= x <= 100
​
dateFrom
string<date-time>
​
dateTo
string<date-time>
​
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELED,
REVERSED
​
externalReference
string
​
search
string

Busca parcial em id, description, externalReference, endToEndId, referenceId e pixKey.

​
subaccountId
string

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.

​
merchantSubaccountId
string

Mesmo filtro que subaccountId.

Response

Lista paginada de cobranças PIX.

​
success
boolean
required
​
message
string
required
​
data
object
required
​
requestId
string