Stater Platform
API Reference

Movimento por referência externa

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

Movimento do pagamento por externalRef

Atalho que retorna o movimento contábil (DEBIT/PIX_OUT) gerado pelo payout, identificado pelo externalRef informado na criação. Mesma estrutura de GET /v1/payouts/:id/movement.

GET/v1/payouts/external-ref/:reference/movement

Note que o externalRef no nível raiz é o do movimento contábil (geralmente null), distinto do externalRef do payout. Para recuperar a referência externa do payout em si, use GET /v1/payouts/external-ref/:reference.

Path params

  • referenceObrigatório
    string (≤ 64)
    externalRef informado na criação do payout.

Headers

  • AuthorizationObrigatório
    string
    Bearer SUA_API_KEY
  • X-Pix-Account-IdObrigatório
    string
    ID da conta Pix proprietária do payout.

Exemplo de requisição

bash
curl https://api.staterpay.io/v1/payouts/external-ref/pedido-2026-0001/movement \  -H "Authorization: Bearer SUA_API_KEY" \  -H "X-Pix-Account-Id: cmoxample0001qkxyzaccount"

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 (campo do próprio movimento; pode ser null mesmo quando o payout que o originou tem externalRef).
  • 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-12T14:56:50.003-03:00",  "entries": [    {      "id": "cmoxample0001qkxyzentry",      "accountId": "cmoxample0001qkxyzcoreaccount",      "amount": "-1",      "balanceAfter": "644",      "kind": "PRIMARY",      "createdAt": "2026-05-12T14:56:50.007-03:00"    }  ],  "metadata": {    "date": "2026-05-12T17:56:49.988Z",    "payer": {      "branch": "1",      "account": "123456"    },    "endToEndId": "E37319859202605121756NBC4AD2Z0P2",    "beneficiary": {      "pixKey": "fulano@example.com",      "pixKeyType": "EMAIL",      "name": "Fulano de Tal",      "document": "12345678900",      "branch": "1",      "account": "49773517",      "ispb": "18236120"    },    "pixAccountId": "cmoxample0001qkxyzaccount",    "paymentDate": "2026-05-12 17:57:01.772969+00:00"  }}
URL base:https://api.staterpay.io

Movimento do pagamento

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

Movimento por endToEndId

GET /v1/payouts/end-to-end-id/:endToEndId/movement — movimento contábil pelo endToEndId.

On this page

Path paramsHeadersExemplo de requisiçãoResposta