Skip to main content
Use as rotas de conta para reconciliação e dashboards: saldo consolidado e extrato com todos os tipos de movimentação visíveis na conta (PIX, cripto, transferência interna, etc.). Permissões na API key: account/balance, account/transactions. Para enviar saldo a outra conta GoatPay, veja Transferência interna.

​
Saldo

GET /account/balance retorna o saldo da conta autenticada pela chave.
CampoSignificado
availableAmountTotal disponível (soma dos trilhos)
pendingAmountTotal pendente (aguardando liquidação)
livreSaldo do trilho PIX Livre (available, pending)
padraoSaldo do trilho Padrão — inclui withdrawable, locked24h, nextUnlockAt quando aplicável
{
  "currency": "BRL",
  "availableAmount": 1000,
  "pendingAmount": 0,
  "livre": { "available": 0, "pending": 0 },
  "padrao": {
    "available": 1000,
    "pending": 0,
    "withdrawable": 1000,
    "locked24h": 0,
    "nextUnlockAt": null
  }
}
O trilho da chave (PADRAO ou LIVRE) define onde novas operações entram; o saldo da resposta mostra ambos os trilhos quando a conta possui os dois.
Consultar saldo

​
Extrato

GET /account/transactions lista o ledger completo da conta — não apenas PIX-in ou PIX-out.
Lista específicaO que retorna
GET /payment-pix/listSó cobranças PIX_IN
GET /transfer-pix/listSó saídas PIX_OUT
GET /account/transactionsTodos os tipos (PIX_IN, PIX_OUT, CRYPTO_IN, INTERNAL_TRANSFER_OUT, etc.)

​
Paginação e filtros

ParâmetroDescrição
page / pageSizePaginação (padrão 50, máximo 100)
dateFrom / dateToPeríodo em createdAt (ISO 8601)
statusPENDING, PROCESSING, COMPLETED, FAILED, CANCELED, REVERSED
externalReferenceFiltro exato
searchBusca parcial em id, descrição, referência, endToEndId, referenceId, pixKey
Cada item do extrato segue o mesmo formato enxuto das rotas de PIX e cripto (referenceId em vez de IDs internos do processador; sem accountId, provider ou metadata). Resposta: items, page, pageSize, total, pages. Extrato da conta
Para status em tempo real, combine o extrato com Webhooks em vez de polling frequente.

​
Transferência interna

Transferência entre contas GoatPay pelo e-mail do destinatário — não é PIX para banco externo.
ItemDetalhe
TaxaSem taxa na transferência interna
DestinatáriorecipientEmail
TrilhoOrigem e destino no mesmo trilho da chave
Webhookstransfer.internal.completed (envio) · transfer.internal.received (destino)
Permissões: transfer-internal/create, transfer-internal/get, transfer-internal/list.

Guia completo

Fluxo, tipos e filtros.

Criar

Enviar para e-mail GoatPay.

Consultar

Por id ou externalReference.

Listar

Histórico interno.

​
Endpoints

AçãoRota
SaldoGET /account/balance
ExtratoGET /account/transactions