Skip to content

Statement

Lists account transactions with pagination and filters.

Endpoint

GET /api/v2/external/statement

Headers

HeaderTypeRequiredDescription
AuthorizationStringYesBearer {access_token}

Query Parameters

ParameterTypeRequiredDescriptionDefault
pageIntegerNoPage number1
per_pageIntegerNoItems per page (max 100)20
statusStringNoFilter by status (pending, completed, failed)--
typeStringNoFilter by type (pix, ted, internal)--
date_fromStringNoStart date (format YYYY-MM-DD)--
date_toStringNoEnd date (format YYYY-MM-DD)--

Example

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"

Success Response (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": "Order #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": "Supplier payment",
      "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
  }
}
FieldTypeDescription
workedBooleantrue indicates operation success
transactionsArrayList of transactions
pagination.pageIntegerCurrent page
pagination.per_pageIntegerItems per page
pagination.totalIntegerTotal transactions found
pagination.total_pagesIntegerTotal pages

Transaction fields

FieldTypeDescription
idStringInternal transaction UUID
transaction_idStringPublic transaction identifier
end_to_end_idStringBACEN E2E ID
typeStringType (pix, ted, internal)
statusStringTransaction status
amountIntegerAmount in cents
fee_amountIntegerFee charged in cents
net_amountIntegerNet amount in cents
descriptionStringTransaction description
directionStringinbound (incoming) or outbound (outgoing)
counterparty_nameStringCounterparty name
recipient_keyStringRecipient PIX key (outbound only)
created_atStringCreation date (ISO 8601)
completed_atStringCompletion date (ISO 8601)

Error Response (401)

json
{
  "worked": false,
  "detail": "Invalid or expired token"
}

Pagination

The maximum per_page limit is 100. To extract large volumes, iterate through pages by incrementing the page parameter until page reaches total_pages.

Owem Pay Instituição de Pagamento — ISPB 37839059