Releve

Liste les transactions du compte avec pagination et filtres.

Endpoint

GET /api/external/statement

En-tetes

En-tete	Type	Obligatoire	Description
Authorization	String	Oui	ApiKey {client_id}:{client_secret}

Query Parameters

Parametre	Type	Obligatoire	Description	Defaut
page	Integer	Non	Numero de page	1
per_page	Integer	Non	Elements par page (max 100)	20
status	String	Non	Filtrer par statut (pending, completed, failed)	--
type	String	Non	Filtrer par type (pix, ted, internal)	--
date_from	String	Non	Date de debut (format YYYY-MM-DD)	--
date_to	String	Non	Date de fin (format YYYY-MM-DD)	--

Exemple

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

Reponse de Succes (200)

{
  "worked": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "transaction_id": "7popu57v6us7p6pcicgq12345",
      "end_to_end_id": "E37839059202603071530000001",
      "external_id": "order-9876",
      "type": "pix",
      "status": "completed",
      "amount": 300000,
      "fee_amount": 0,
      "net_amount": 300000,
      "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",
      "external_id": "invoice-4521",
      "type": "pix",
      "status": "completed",
      "amount": 500000,
      "fee_amount": 350,
      "net_amount": 500350,
      "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"
    }
  ],
  "page": 1,
  "per_page": 20
}

Champ	Type	Description
worked	Boolean	true indique le succes de l'operation
data	Array	Liste des transactions
page	Integer	Page actuelle
per_page	Integer	Elements par page

Champs de chaque transaction

Champ	Type	Description
id	String	UUID interne de la transaction
transaction_id	String	Identifiant public de la transaction
end_to_end_id	String	E2E ID du BACEN
external_id	String	Identifiant de votre systeme. null si non renseigne
type	String	Type (pix, ted, internal)
status	String	Statut de la transaction
amount	Integer	Montant en unites de base (/ 10 000 pour reais). 300000 = R$ 30,00
fee_amount	Integer	Frais factures en unites de base
net_amount	Integer	Montant net en unites de base
description	String	Description de la transaction
direction	String	inbound (entree) ou outbound (sortie)
counterparty_name	String	Nom de la contrepartie
recipient_key	String	Cle PIX du destinataire (uniquement pour les envois)
created_at	String	Date de creation (ISO 8601)
completed_at	String	Date de conclusion (ISO 8601)

Reponse d'Erreur (401)

{
  "error": {
    "status": 401,
    "message": "Missing API key credentials. Use Authorization: ApiKey <client_id>:<client_secret>"
  }
}

Pagination

La limite maximale de per_page est 100. Pour extraire de grands volumes, iterez sur les pages en incrementant le parametre page jusqu'a atteindre total_pages.