Skip to main content
GET
https://api.owem.com.br
/
v4
/
i
/
ledger
/
end-to-end
/
{endToEndId}
Query by EndToEndId
curl --request GET \
  --url https://api.owem.com.br/v4/i/ledger/end-to-end/{endToEndId} \
  --header 'Authorization: <authorization>'
{
  "requestId": "2b49f82a-bca7-4774-ac2c-3b3733ad6a49",
  "success": true,
  "size": 1,
  "message": "Ledger consultado",
  "data": {
    "id": "E123456789202512230000000000003",
    "type": "debit",
    "reason": "pix_out:processing",
    "status": "succeeded",
    "grossAmount": 750.0,
    "feeAmount": 0,
    "netAmount": 750.0,
    "externalId": "TX-20251223-PIX-002",
    "endToEndId": "E123456789202512230000000000003",
    "entryId": null,
    "accountId": "123456789012",
    "userId": "usr_abc123def",
    "requestId": "M000000000a202512230000000000003",
    "createdAt": 1766523042000,
    "createdDate": "2025-12-23",
    "updatedAt": 1766533845420,
    "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"
    },
    "uid": "E123456789202512230000000000003"
  }
}

​
Purpose

This endpoint allows you to query an accounting entry by the PIX identifier (E2E).

​
Authentication

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

​
Path Parameters

​
endToEndId
string
required
PIX identifier (E2E). Must be the complete value returned by the bank. Typical format: 32+ alphanumeric characters (varies by issuer)

​
Response

​
requestId
string
UUID for tracking
​
success
boolean
Operation status
​
size
number
Number of records
​
message
string
Descriptive message (e.g., “Ledger consultado”)
​
data
object
{
  "requestId": "2b49f82a-bca7-4774-ac2c-3b3733ad6a49",
  "success": true,
  "size": 1,
  "message": "Ledger consultado",
  "data": {
    "id": "E123456789202512230000000000003",
    "type": "debit",
    "reason": "pix_out:processing",
    "status": "succeeded",
    "grossAmount": 750.0,
    "feeAmount": 0,
    "netAmount": 750.0,
    "externalId": "TX-20251223-PIX-002",
    "endToEndId": "E123456789202512230000000000003",
    "entryId": null,
    "accountId": "123456789012",
    "userId": "usr_abc123def",
    "requestId": "M000000000a202512230000000000003",
    "createdAt": 1766523042000,
    "createdDate": "2025-12-23",
    "updatedAt": 1766533845420,
    "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"
    },
    "uid": "E123456789202512230000000000003"
  }
}

​
Status Codes

HTTPDescription
200Success
400Malformed endToEndId
401Invalid credentials
403IP not allowlisted
404Entry not found
429Rate limit exceeded
500Internal error
The endToEndId is the unique identifier generated by the banking system for each PIX transaction.