Skip to main content
GET
https://api.owem.com.br
/
v4
/
i
/
ledger
/
entry-id
/
{entryId}
Query by Entry ID
curl --request GET \
  --url https://api.owem.com.br/v4/i/ledger/entry-id/{entryId} \
  --header 'Authorization: <authorization>'
{
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "success": true,
  "size": 2,
  "message": "Ledger consultado",
  "data": [
    {
      "id": "E123456789202512110000000000001",
      "idempotencyKey": "credit:pix_in:qrcode_paid:E123456789202512110000000000001",
      "externalId": null,
      "metadata": {},
      "type": "credit",
      "reason": "pix_in:qrcode_paid",
      "status": "succeeded",
      "grossAmount": 100.0,
      "feeAmount": 0,
      "netAmount": 100.0,
      "endToEndId": "E123456789202512110000000000001",
      "parentEndToEndId": null,
      "entryId": "txIdExampleQRCode123456789",
      "requestId": "01000000-f9ee-4eca-0001-08de3902d6e2",
      "pixKey": "abc12345-6789-0abc-def0-123456789abc",
      "userId": "usr_abc123def",
      "accountId": "123456789012",
      "createdAt": 1765480551000,
      "createdDate": "2025-12-11",
      "payer": {
        "ispb": "12345678",
        "personType": "person",
        "cpfCnpj": "XXX123456XX",
        "name": "MARIA SANTOS",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456"
      },
      "receiver": {
        "ispb": "87654321",
        "personType": "company",
        "cpfCnpj": "XX123456000XXX",
        "name": "EXAMPLE COMPANY LTD",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456789012"
      }
    },
    {
      "id": "E123456789202512110000000000002",
      "idempotencyKey": "credit:pix_in:qrcode_paid:E123456789202512110000000000002",
      "type": "credit",
      "reason": "pix_in:qrcode_paid",
      "status": "succeeded",
      "grossAmount": 50.0,
      "feeAmount": 0,
      "netAmount": 50.0,
      "endToEndId": "E123456789202512110000000000002",
      "entryId": "txIdExampleQRCode123456789",
      "pixKey": "abc12345-6789-0abc-def0-123456789abc",
      "userId": "usr_abc123def",
      "accountId": "123456789012",
      "createdAt": 1765480608000,
      "createdDate": "2025-12-11",
      "payer": {
        "ispb": "87654321",
        "personType": "person",
        "cpfCnpj": "XXX654321XX",
        "name": "JOHN DOE",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "654321"
      },
      "receiver": {
        "ispb": "87654321",
        "personType": "company",
        "cpfCnpj": "XX123456000XXX",
        "name": "EXAMPLE COMPANY LTD",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456789012"
      }
    }
  ]
}

​
Purpose

This endpoint allows you to query all payments linked to a specific QRCode using the entryId (QRCode txId).
Unlike other Ledger endpoints, this returns an array of entries, as the same QRCode can receive multiple payments.

​
Authentication

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

​
Path Parameters

​
entryId
string
required
QRCode txId generated in the PIX IN flow.

​
Response

​
requestId
string
UUID for tracking
​
success
boolean
Operation status
​
size
number
Number of payments found
​
message
string
Descriptive message (e.g., “Ledger consultado”)
​
data
array
{
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "success": true,
  "size": 2,
  "message": "Ledger consultado",
  "data": [
    {
      "id": "E123456789202512110000000000001",
      "idempotencyKey": "credit:pix_in:qrcode_paid:E123456789202512110000000000001",
      "externalId": null,
      "metadata": {},
      "type": "credit",
      "reason": "pix_in:qrcode_paid",
      "status": "succeeded",
      "grossAmount": 100.0,
      "feeAmount": 0,
      "netAmount": 100.0,
      "endToEndId": "E123456789202512110000000000001",
      "parentEndToEndId": null,
      "entryId": "txIdExampleQRCode123456789",
      "requestId": "01000000-f9ee-4eca-0001-08de3902d6e2",
      "pixKey": "abc12345-6789-0abc-def0-123456789abc",
      "userId": "usr_abc123def",
      "accountId": "123456789012",
      "createdAt": 1765480551000,
      "createdDate": "2025-12-11",
      "payer": {
        "ispb": "12345678",
        "personType": "person",
        "cpfCnpj": "XXX123456XX",
        "name": "MARIA SANTOS",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456"
      },
      "receiver": {
        "ispb": "87654321",
        "personType": "company",
        "cpfCnpj": "XX123456000XXX",
        "name": "EXAMPLE COMPANY LTD",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456789012"
      }
    },
    {
      "id": "E123456789202512110000000000002",
      "idempotencyKey": "credit:pix_in:qrcode_paid:E123456789202512110000000000002",
      "type": "credit",
      "reason": "pix_in:qrcode_paid",
      "status": "succeeded",
      "grossAmount": 50.0,
      "feeAmount": 0,
      "netAmount": 50.0,
      "endToEndId": "E123456789202512110000000000002",
      "entryId": "txIdExampleQRCode123456789",
      "pixKey": "abc12345-6789-0abc-def0-123456789abc",
      "userId": "usr_abc123def",
      "accountId": "123456789012",
      "createdAt": 1765480608000,
      "createdDate": "2025-12-11",
      "payer": {
        "ispb": "87654321",
        "personType": "person",
        "cpfCnpj": "XXX654321XX",
        "name": "JOHN DOE",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "654321"
      },
      "receiver": {
        "ispb": "87654321",
        "personType": "company",
        "cpfCnpj": "XX123456000XXX",
        "name": "EXAMPLE COMPANY LTD",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456789012"
      }
    }
  ]
}

​
Status Codes

HTTPDescription
200Success
400Malformed entryId
401Invalid credentials
403IP not allowlisted
404Ledger not found
429Rate limit exceeded
500Internal error
Payment confirmation: Check if there is at least one entry with status = "succeeded" and reason = "pix_in:qrcode_paid".
The entryId is the QRCode txId. The same QRCode can receive multiple payments (e.g., different customers paying the same code).