Stater Platform
API Reference

Listar pagamentos enviados

GET /v1/payouts — histórico de payouts.

Lista pagamentos enviados

Lista os pagamentos enviados pela conta, mais recentes primeiro. A resposta é um array JSON direto (sem wrapper). O filtro limit controla o tamanho da página.

GET/v1/payouts

Diferente de /v1/charges, este endpoint não usa paginação por cursor — retorna apenas um array. Para detalhamento de um payout específico (incluindo recipientPreview e providerResponse), use GET /v1/payouts/:id.

Query string

  • status
    "PROCESSING" | "SUCCEEDED" | "FAILED" | "CANCELLED" | "REFUNDED"
    Filtra por estado.
  • limit
    number
    Tamanho da página. Padrão 20, máximo 100.

Headers

  • AuthorizationObrigatório
    string
    Bearer SUA_API_KEY

Exemplo de requisição

curl "https://api.staterpay.io/v1/payouts?limit=10" \  -H "Authorization: Bearer SUA_API_KEY"

Resposta

  • [].id
    string
    Identificador do payout.
  • [].pixAccountId
    string
    Conta Pix de origem.
  • [].movementId
    string
    Movimento contábil associado.
  • [].pixKey
    string
    Chave Pix de destino.
  • [].pixKeyType
    "EMAIL" | "PHONE" | "CPF" | "CNPJ" | "EVP"
    Tipo da chave.
  • [].amountCents
    string
    Valor enviado em centavos.
  • [].description
    string | null
    Descrição livre informada na criação.
  • [].status
    string
    Estado atual do payout.
  • [].endToEndId
    string | null
    Identificador Pix de liquidação (preenchido após sucesso).
  • [].providerTransactionId
    string
    ID da transação no provider.
  • [].lastError
    string | null
    Mensagem de erro do último submit, se houve falha.
  • [].submittedAt
    string (ISO-8601 UTC-3)
    Quando foi submetido ao provider.
  • [].resolvedAt
    string (ISO-8601 UTC-3) | null
    Quando o estado final foi atingido.
  • [].createdAt
    string (ISO-8601 UTC-3)
    Criação do registro.
json
[  {    "id": "cmoxample0001qkxyzpayout",    "pixAccountId": "cmoxample0001qkxyzaccount",    "movementId": "cmoxample0001qkxyzmovement",    "pixKey": "fulano@example.com",    "pixKeyType": "EMAIL",    "amountCents": "1",    "description": null,    "status": "SUCCEEDED",    "endToEndId": "E37319859202605072200ZVSCKGQ5JI1",    "providerTransactionId": "00000000",    "lastError": null,    "submittedAt": "2026-05-07T19:00:19.301-03:00",    "resolvedAt": "2026-05-07T19:00:37.498-03:00",    "createdAt": "2026-05-07T19:00:19.319-03:00"  },  {    "id": "cmoxample0002qkxyzpayout",    "pixAccountId": "cmoxample0001qkxyzaccount",    "movementId": "cmoxample0002qkxyzmovement",    "pixKey": "+5531999999999",    "pixKeyType": "PHONE",    "amountCents": "300",    "description": "Transferência Pix — Fulano de Tal",    "status": "SUCCEEDED",    "endToEndId": "E37319859202605062307O94fGvIFOVB",    "providerTransactionId": "00000001",    "lastError": null,    "submittedAt": "2026-05-06T20:07:22.852-03:00",    "resolvedAt": "2026-05-06T20:07:30.733-03:00",    "createdAt": "2026-05-06T20:07:22.886-03:00"  }]
URL base:https://api.staterpay.io

Enviar Pix via chave

POST /v1/payouts — cria pagamento Pix usando chave.

Consultar pagamento

GET /v1/payouts/:id — status, endToEndId e detalhes do erro quando aplicável.

On this page

Query stringHeadersExemplo de requisiçãoResposta