Skip to content

Extrato

Lista as transacoes da conta com paginacao e filtros.

Endpoint

GET /api/v2/external/statement

Headers

HeaderTipoObrigatorioDescricao
AuthorizationStringSimBearer {access_token}

Query Parameters

ParametroTipoObrigatorioDescricaoDefault
pageIntegerNaoNumero da pagina1
per_pageIntegerNaoItens por pagina (max 100)20
statusStringNaoFiltrar por status (pending, completed, failed)--
typeStringNaoFiltrar por tipo (pix, ted, internal)--
date_fromStringNaoData inicial (formato YYYY-MM-DD)--
date_toStringNaoData final (formato YYYY-MM-DD)--

Exemplo

bash
curl -X GET "https://api.owem.com.br/api/v2/external/statement?page=1&per_page=20&status=completed&date_from=2026-03-01&date_to=2026-03-07" \
  -H "Authorization: Bearer $TOKEN"

Resposta de Sucesso (200)

json
{
  "worked": true,
  "transactions": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "transaction_id": "PIXIN20260307a1b2c3d4e5f6",
      "end_to_end_id": "E37839059202603071530000001",
      "type": "pix",
      "status": "completed",
      "amount": 10000,
      "fee_amount": 0,
      "net_amount": 10000,
      "description": "Pedido #1234",
      "direction": "inbound",
      "counterparty_name": "Maria Santos",
      "created_at": "2026-03-07T15:30:00Z",
      "completed_at": "2026-03-07T15:30:02Z"
    },
    {
      "id": "f7e8d9c0-b1a2-4c3d-9e8f-7a6b5c4d3e2f",
      "transaction_id": "PIXOUT20260306x9y8z7w6v5u4",
      "end_to_end_id": "E37839059202603061200000005",
      "type": "pix",
      "status": "completed",
      "amount": 5000,
      "fee_amount": 50,
      "net_amount": 5050,
      "description": "Pagamento fornecedor",
      "direction": "outbound",
      "counterparty_name": "Joao Silva",
      "recipient_key": "12345678901",
      "created_at": "2026-03-06T12:00:00Z",
      "completed_at": "2026-03-06T12:00:03Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 42,
    "total_pages": 3
  }
}
CampoTipoDescricao
workedBooleantrue indica sucesso na operacao
transactionsArrayLista de transacoes
pagination.pageIntegerPagina atual
pagination.per_pageIntegerItens por pagina
pagination.totalIntegerTotal de transacoes encontradas
pagination.total_pagesIntegerTotal de paginas

Campos de cada transacao

CampoTipoDescricao
idStringUUID interno da transacao
transaction_idStringIdentificador publico da transacao
end_to_end_idStringE2E ID do BACEN
typeStringTipo (pix, ted, internal)
statusStringStatus da transacao
amountIntegerValor em centavos
fee_amountIntegerTarifa cobrada em centavos
net_amountIntegerValor liquido em centavos
descriptionStringDescricao da transacao
directionStringinbound (entrada) ou outbound (saida)
counterparty_nameStringNome da contraparte
recipient_keyStringChave PIX do destinatario (apenas saidas)
created_atStringData de criacao (ISO 8601)
completed_atStringData de conclusao (ISO 8601)

Resposta de Erro (401)

json
{
  "worked": false,
  "detail": "Token invalido ou expirado"
}

Paginacao

O limite maximo de per_page e 100. Para extrair grandes volumes, itere pelas paginas incrementando o parametro page ate que page atinja total_pages.

Owem Pay Instituição de Pagamento — ISPB 37839059