Stater Platform
API Reference

Movimento do pagamento

GET /v1/payouts/:id/movement — atalho para o movimento contábil gerado.

Movimento associado ao pagamento

Atalho que retorna o movimento contábil (DEBIT/PIX_OUT) gerado por este pagamento, com lançamentos (entries) e metadata Pix completa (payer interno, beneficiary, endToEndId, paymentDate).

GET/v1/payouts/:id/movement

metadata.date está em UTC (com Z); createdAt e timestamps dos entries em UTC-3 (Brasília). amount é uma string com sinal — negativo nos lançamentos de DEBIT.

Path params

  • idObrigatório
    string
    Identificador do pagamento (cuid).

Headers

  • AuthorizationObrigatório
    string
    Bearer SUA_API_KEY

Exemplo de requisição

bash
curl https://api.staterpay.io/v1/payouts/cmoxample0001qkxyzpayout/movement \  -H "Authorization: Bearer SUA_API_KEY"

Resposta

  • id
    string
    Identificador do movimento.
  • type
    "DEBIT"
    Sempre DEBIT em payouts.
  • status
    "POSTED" | "PENDING" | "REVERSED"
    Estado contábil do movimento.
  • source
    "PIX_OUT"
    Origem fixa em payouts.
  • description
    string
    Descrição legível do movimento.
  • externalRef
    string | null
    Referência externa, quando informada.
  • feeAmount
    string | null
    Tarifa cobrada (centavos), quando aplicável.
  • reversesMovementId
    string | null
    Movimento reversado por este, em casos de estorno.
  • createdAt
    string (ISO-8601 UTC-3)
    Criação.
  • entries
    array
    Lançamentos contábeis: amount (negativo em DEBIT), balanceAfter, kind.
  • metadata.date
    string (ISO-8601 UTC)
    Carimbo do envio em UTC.
  • metadata.payer
    object
    Identificação interna: branch e account.
  • metadata.endToEndId
    string
    EndToEndId Pix de liquidação.
  • metadata.beneficiary
    object
    Destinatário com pixKey, pixKeyType, name, document, branch, account, ispb.
  • metadata.pixAccountId
    string
    Conta Pix de origem.
  • metadata.paymentDate
    string
    Data/hora exata da liquidação no provider.
json
{  "id": "cmoxample0001qkxyzmovement",  "type": "DEBIT",  "status": "POSTED",  "source": "PIX_OUT",  "description": "PIX enviado para fulano@example.com",  "externalRef": null,  "feeAmount": null,  "reversesMovementId": null,  "createdAt": "2026-05-07T19:00:19.307-03:00",  "entries": [    {      "id": "cmoxample0001qkxyzentry",      "accountId": "cmoxample0001qkxyzcoreaccount",      "amount": "-1",      "balanceAfter": "1391",      "kind": "PRIMARY",      "createdAt": "2026-05-07T19:00:19.308-03:00"    }  ],  "metadata": {    "date": "2026-05-07T22:00:19.301Z",    "payer": {      "branch": "1",      "account": "123456"    },    "endToEndId": "E37319859202605072200ZVSCKGQ5JI1",    "beneficiary": {      "pixKey": "fulano@example.com",      "pixKeyType": "EMAIL",      "name": "Fulano de Tal",      "document": "12345678900",      "branch": "1",      "account": "49773517",      "ispb": "18236120"    },    "pixAccountId": "cmoxample0001qkxyzaccount",    "paymentDate": "2026-05-07 22:00:29.725827+00:00"  }}
URL base:https://api.staterpay.io

Consultar pagamento por endToEndId

GET /v1/payouts/end-to-end-id/:endToEndId — consulta um payout pelo endToEndId Pix de liquidação.

Movimento por referência externa

GET /v1/payouts/external-ref/:reference/movement — movimento contábil pelo externalRef.

On this page

Path paramsHeadersExemplo de requisiçãoResposta