Consultar por Entry ID

Consultar por Entry ID (txId)

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": "txIdExemploQRCode123456789",
      "requestId": "01000000-f9ee-4eca-0001-08de3902d6e2",
      "pixKey": "abc12345-6789-0abc-def0-123456789abc",
      "userId": "usr_abc123def",
      "accountId": "123456789012",
      "createdAt": 1765480551000,
      "createdDate": "2025-12-11",
      "updatedAt": 1765480551000,
      "updatedDate": "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": "EMPRESA EXEMPLO LTDA",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456789012"
      },
      "medId": null,
      "medCreatedAt": null,
      "medCreatedDate": null,
      "refundedEndToEndId": null,
      "split": null,
      "af": [],
      "sameDocument": null,
      "obs": null
    },
    {
      "id": "E123456789202512110000000000002",
      "idempotencyKey": "credit:pix_in:qrcode_paid:E123456789202512110000000000002",
      "externalId": null,
      "metadata": {},
      "type": "credit",
      "reason": "pix_in:qrcode_paid",
      "status": "succeeded",
      "grossAmount": 50.0,
      "feeAmount": 0,
      "netAmount": 50.0,
      "endToEndId": "E123456789202512110000000000002",
      "parentEndToEndId": null,
      "entryId": "txIdExemploQRCode123456789",
      "requestId": "01000000-f9ee-4eca-0002-08de3902f8bc",
      "pixKey": "abc12345-6789-0abc-def0-123456789abc",
      "userId": "usr_abc123def",
      "accountId": "123456789012",
      "createdAt": 1765480608000,
      "createdDate": "2025-12-11",
      "updatedAt": 1765480608000,
      "updatedDate": "2025-12-11",
      "payer": {
        "ispb": "87654321",
        "personType": "person",
        "cpfCnpj": "XXX654321XX",
        "name": "JOAO DA SILVA",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "654321"
      },
      "receiver": {
        "ispb": "87654321",
        "personType": "company",
        "cpfCnpj": "XX123456000XXX",
        "name": "EMPRESA EXEMPLO LTDA",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456789012"
      },
      "medId": null,
      "medCreatedAt": null,
      "medCreatedDate": null,
      "refundedEndToEndId": null,
      "split": null,
      "af": [],
      "sameDocument": null,
      "obs": null
    }
  ]
}

GET

https://api.owem.com.br

ledger

entry-id

{entryId}

Consultar por Entry ID (txId)

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": "txIdExemploQRCode123456789",
      "requestId": "01000000-f9ee-4eca-0001-08de3902d6e2",
      "pixKey": "abc12345-6789-0abc-def0-123456789abc",
      "userId": "usr_abc123def",
      "accountId": "123456789012",
      "createdAt": 1765480551000,
      "createdDate": "2025-12-11",
      "updatedAt": 1765480551000,
      "updatedDate": "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": "EMPRESA EXEMPLO LTDA",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456789012"
      },
      "medId": null,
      "medCreatedAt": null,
      "medCreatedDate": null,
      "refundedEndToEndId": null,
      "split": null,
      "af": [],
      "sameDocument": null,
      "obs": null
    },
    {
      "id": "E123456789202512110000000000002",
      "idempotencyKey": "credit:pix_in:qrcode_paid:E123456789202512110000000000002",
      "externalId": null,
      "metadata": {},
      "type": "credit",
      "reason": "pix_in:qrcode_paid",
      "status": "succeeded",
      "grossAmount": 50.0,
      "feeAmount": 0,
      "netAmount": 50.0,
      "endToEndId": "E123456789202512110000000000002",
      "parentEndToEndId": null,
      "entryId": "txIdExemploQRCode123456789",
      "requestId": "01000000-f9ee-4eca-0002-08de3902f8bc",
      "pixKey": "abc12345-6789-0abc-def0-123456789abc",
      "userId": "usr_abc123def",
      "accountId": "123456789012",
      "createdAt": 1765480608000,
      "createdDate": "2025-12-11",
      "updatedAt": 1765480608000,
      "updatedDate": "2025-12-11",
      "payer": {
        "ispb": "87654321",
        "personType": "person",
        "cpfCnpj": "XXX654321XX",
        "name": "JOAO DA SILVA",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "654321"
      },
      "receiver": {
        "ispb": "87654321",
        "personType": "company",
        "cpfCnpj": "XX123456000XXX",
        "name": "EMPRESA EXEMPLO LTDA",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456789012"
      },
      "medId": null,
      "medCreatedAt": null,
      "medCreatedDate": null,
      "refundedEndToEndId": null,
      "split": null,
      "af": [],
      "sameDocument": null,
      "obs": null
    }
  ]
}

Finalidade

Este endpoint permite consultar todos os pagamentos vinculados a um QRCode específico usando o entryId (txId do QRCode).

Diferente dos outros endpoints de Ledger, este retorna um array de entradas, pois um mesmo QRCode pode receber múltiplos pagamentos.

Autenticação

Authorization

string

obrigatório

Basic Auth obrigatório no formato: Basic {Base64(API_KEY:API_SECRET)}

Path Parameters

entryId

string

obrigatório

txId do QRCode gerado no fluxo de PIX IN.

Resposta

requestId

string

UUID para rastreio

success

boolean

Status da operação

size

number

Quantidade de pagamentos encontrados

message

string

Mensagem descritiva (ex: “Ledger consultado”)

data

array

Mostrar data[]

string

Identificador único (endToEndId)

type

string

Tipo: credit ou debit

reason

string

Motivo/evento (ex: pix_in:qrcode_paid)

status

string

Status: processing, succeeded, failed

grossAmount

number

Valor bruto em BRL

feeAmount

number

Valor da tarifa

netAmount

number

Valor líquido

endToEndId

string

Identificador PIX (E2E)

entryId

string

txId do QRCode

pixKey

string

Chave PIX utilizada

externalId

string

Identificador externo (null se não definido)

accountId

string

ID da conta

userId

string

ID do usuário

requestId

string

Request ID original

createdAt

number

Timestamp de criação (ms)

createdDate

string

Data de criação (YYYY-MM-DD)

updatedAt

number

Timestamp de atualização (ms)

updatedDate

string

Data de atualização (YYYY-MM-DD)

idempotencyKey

string

Chave de idempotência

metadata

object

Metadados adicionais

payer

object

Mostrar payer

ispb

string

Código ISPB do banco

personType

string

person ou company

cpfCnpj

string

CPF/CNPJ

name

string

Nome do pagador

agency

string

Agência

accountType

string

Tipo de conta

accountNumber

string

Número da conta

receiver

object

Mostrar receiver

ispb

string

Código ISPB do banco

personType

string

person ou company

cpfCnpj

string

CPF/CNPJ

name

string

Nome do recebedor

agency

string

Agência

accountType

string

Tipo de conta

accountNumber

string

Número da conta

parentEndToEndId

string

E2E pai (null se não aplicável)

refundedEndToEndId

string

E2E do estorno (null se não aplicável)

medId

string

ID do MED (null se não aplicável)

split

object

Informações de split (null se não aplicável)

array

Array de antifraude

sameDocument

boolean

Indica se pagador e recebedor têm mesmo documento

obs

string

Observações adicionais

{
  "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": "txIdExemploQRCode123456789",
      "requestId": "01000000-f9ee-4eca-0001-08de3902d6e2",
      "pixKey": "abc12345-6789-0abc-def0-123456789abc",
      "userId": "usr_abc123def",
      "accountId": "123456789012",
      "createdAt": 1765480551000,
      "createdDate": "2025-12-11",
      "updatedAt": 1765480551000,
      "updatedDate": "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": "EMPRESA EXEMPLO LTDA",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456789012"
      },
      "medId": null,
      "medCreatedAt": null,
      "medCreatedDate": null,
      "refundedEndToEndId": null,
      "split": null,
      "af": [],
      "sameDocument": null,
      "obs": null
    },
    {
      "id": "E123456789202512110000000000002",
      "idempotencyKey": "credit:pix_in:qrcode_paid:E123456789202512110000000000002",
      "externalId": null,
      "metadata": {},
      "type": "credit",
      "reason": "pix_in:qrcode_paid",
      "status": "succeeded",
      "grossAmount": 50.0,
      "feeAmount": 0,
      "netAmount": 50.0,
      "endToEndId": "E123456789202512110000000000002",
      "parentEndToEndId": null,
      "entryId": "txIdExemploQRCode123456789",
      "requestId": "01000000-f9ee-4eca-0002-08de3902f8bc",
      "pixKey": "abc12345-6789-0abc-def0-123456789abc",
      "userId": "usr_abc123def",
      "accountId": "123456789012",
      "createdAt": 1765480608000,
      "createdDate": "2025-12-11",
      "updatedAt": 1765480608000,
      "updatedDate": "2025-12-11",
      "payer": {
        "ispb": "87654321",
        "personType": "person",
        "cpfCnpj": "XXX654321XX",
        "name": "JOAO DA SILVA",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "654321"
      },
      "receiver": {
        "ispb": "87654321",
        "personType": "company",
        "cpfCnpj": "XX123456000XXX",
        "name": "EMPRESA EXEMPLO LTDA",
        "agency": "0001",
        "accountType": "checking",
        "accountNumber": "123456789012"
      },
      "medId": null,
      "medCreatedAt": null,
      "medCreatedDate": null,
      "refundedEndToEndId": null,
      "split": null,
      "af": [],
      "sameDocument": null,
      "obs": null
    }
  ]
}

Códigos de Status

HTTP	Descrição
200	Sucesso
400	`entryId` malformado
401	Credenciais inválidas
403	IP não allowlisted
404	Ledger não encontrado
429	Rate limit excedido
500	Erro interno

Confirmação de pagamento: Verifique se existe pelo menos uma entrada com status = "succeeded" e reason = "pix_in:qrcode_paid".

O entryId é o txId do QRCode. Um mesmo QRCode pode receber múltiplos pagamentos (ex: clientes diferentes pagando o mesmo código).

Consultar por EndToEndId

Gerar QRCode Dinâmico

⌘I

Visão Geral

Autenticação

Conta Bancária

Ledger

PIX IN

PIX OUT

Finalidade

Autenticação

Path Parameters

Resposta

Códigos de Status

Visão Geral

Autenticação

Conta Bancária

Ledger

PIX IN

PIX OUT

​Finalidade

​Autenticação

​Path Parameters

​Resposta

​Códigos de Status

Finalidade

Autenticação

Path Parameters

Resposta

Códigos de Status