Skip to main content
GET
https://api.owem.com.br
/
v4
/
i
/
ledger
/
external-id
/
{externalId}
Query by External ID
curl --request GET \
  --url https://api.owem.com.br/v4/i/ledger/external-id/{externalId} \
  --header 'Authorization: <authorization>'
{
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "success": true,
  "size": 1,
  "message": "Ledger consultado",
  "data": {
    "id": "E123456789202512230000000000002",
    "type": "debit",
    "reason": "pix_out:processing",
    "status": "succeeded",
    "grossAmount": 100.5,
    "feeAmount": 0.05,
    "netAmount": 100.55,
    "externalId": "TX-20251223-EXAMPLE-001",
    "endToEndId": "E123456789202512230000000000002",
    "entryId": null,
    "accountId": "123456789012",
    "userId": "usr_abc123def",
    "requestId": "M000000000a202512230000000000002",
    "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": "E123456789202512230000000000002"
  }
}

​
Purpose

This endpoint allows you to query a Ledger operation by the external identifier.

​
Authentication

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

​
Path Parameters

​
externalId
string
required
External identifier defined by the client when creating the transaction.

​
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": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "success": true,
  "size": 1,
  "message": "Ledger consultado",
  "data": {
    "id": "E123456789202512230000000000002",
    "type": "debit",
    "reason": "pix_out:processing",
    "status": "succeeded",
    "grossAmount": 100.5,
    "feeAmount": 0.05,
    "netAmount": 100.55,
    "externalId": "TX-20251223-EXAMPLE-001",
    "endToEndId": "E123456789202512230000000000002",
    "entryId": null,
    "accountId": "123456789012",
    "userId": "usr_abc123def",
    "requestId": "M000000000a202512230000000000002",
    "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": "E123456789202512230000000000002"
  }
}

​
Status Codes

HTTPDescription
200Success
400Malformed externalId
401Invalid credentials
403IP not allowlisted
404Entry not found
429Rate limit exceeded
500Internal error
The externalId is the identifier you defined when creating the transaction (PIX or transfer).