Skip to main content
GET
https://api.owem.com.br
/
v4
/
i
/
ledger
Query Ledger
curl --request GET \
  --url https://api.owem.com.br/v4/i/ledger \
  --header 'Authorization: <authorization>'
{
  "requestId": "25ff16ac-80da-47a9-958d-58b8ff435afd",
  "success": true,
  "size": 1,
  "pagination": {
    "page": 1,
    "limit": 10,
    "orderBy": "desc",
    "total": 1,
    "totalPages": 1
  },
  "data": [
    {
      "id": "E123456789202512230000000000001",
      "type": "debit",
      "reason": "pix_out:processing",
      "status": "succeeded",
      "grossAmount": 0.01,
      "feeAmount": 0,
      "netAmount": 0.01,
      "externalId": "TX-20251223-TEST-001",
      "endToEndId": "E123456789202512230000000000001",
      "entryId": null,
      "accountId": "123456789012",
      "userId": "usr_abc123def",
      "requestId": "M000000000a202512230000000000001",
      "createdAt": 1766523042000,
      "createdDate": "2025-12-23",
      "updatedAt": 1766523045000,
      "updatedDate": "2025-12-23",
      "payer": {
        "ispb": "12345678",
        "personType": "company",
        "cpfCnpj": "XX123456000XXX",
        "name": "EXAMPLE COMPANY LTD",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456789012"
      },
      "receiver": {
        "ispb": "87654321",
        "personType": "person",
        "cpfCnpj": "XXX123456XX",
        "name": "JOHN DOE",
        "agency": "0001",
        "accountType": "CACC",
        "accountNumber": "00000000000012345678"
      }
    }
  ]
}

​
Purpose

This endpoint allows you to query the complete accounting history (ledger) of an account.

​
Authentication

​
Authorization
string
required
Basic Auth required in format: Basic {Base64(API_KEY:API_SECRET)}

​
Query Parameters

​
type
string
Operation type. Values: debit, credit
​
reason
string
Filter by operation reason. Possible values: - pix_in:qrcode_paid - pix_in:credited - pix_out:processing - pix_in:refunded_processing - pix_out:refunded_processing
​
status
string
Operation status. Values: processing, succeeded, failed
​
startDate
number
Start timestamp (in milliseconds)
​
endDate
number
End timestamp (in milliseconds)
​
page
number
default:"1"
Results page
​
limit
number
default:"100"
Maximum number of records (max. 100)

​
Response

​
requestId
string
UUID for tracking
​
success
boolean
Operation status
​
size
number
Number of records returned
​
pagination
object
​
data
array
{
  "requestId": "25ff16ac-80da-47a9-958d-58b8ff435afd",
  "success": true,
  "size": 1,
  "pagination": {
    "page": 1,
    "limit": 10,
    "orderBy": "desc",
    "total": 1,
    "totalPages": 1
  },
  "data": [
    {
      "id": "E123456789202512230000000000001",
      "type": "debit",
      "reason": "pix_out:processing",
      "status": "succeeded",
      "grossAmount": 0.01,
      "feeAmount": 0,
      "netAmount": 0.01,
      "externalId": "TX-20251223-TEST-001",
      "endToEndId": "E123456789202512230000000000001",
      "entryId": null,
      "accountId": "123456789012",
      "userId": "usr_abc123def",
      "requestId": "M000000000a202512230000000000001",
      "createdAt": 1766523042000,
      "createdDate": "2025-12-23",
      "updatedAt": 1766523045000,
      "updatedDate": "2025-12-23",
      "payer": {
        "ispb": "12345678",
        "personType": "company",
        "cpfCnpj": "XX123456000XXX",
        "name": "EXAMPLE COMPANY LTD",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456789012"
      },
      "receiver": {
        "ispb": "87654321",
        "personType": "person",
        "cpfCnpj": "XXX123456XX",
        "name": "JOHN DOE",
        "agency": "0001",
        "accountType": "CACC",
        "accountNumber": "00000000000012345678"
      }
    }
  ]
}

​
Status Codes

HTTPDescription
200Success
400Invalid parameter
401Invalid credentials
403IP not allowlisted
429Rate limit exceeded
500Internal error
The Ledger preserves complete history permanently and immutably. Use for reconciliation and auditing.