Pular para o conteúdo principal
GET
https://api.owem.com.br
/
v4
/
i
/
ledger
/
external-id
/
{externalId}
Consultar por 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-EXEMPLO-001",
    "endToEndId": "E123456789202512230000000000002",
    "entryId": null,
    "accountId": "123456789012",
    "userId": "usr_abc123def",
    "requestId": "M000000000a202512230000000000002",
    "createdAt": 1766523042000,
    "createdDate": "2025-12-23",
    "updatedAt": 1766533845420,
    "updatedDate": "2025-12-23",
    "metadata": {
      "idempotencyKey": "1766523039000-abc12345"
    },
    "idempotencyKey": "debit:pix_out:processing:E123456789202512230000000000002",
    "parentEndToEndId": null,
    "refundedEndToEndId": null,
    "medId": null,
    "medCreatedAt": null,
    "medCreatedDate": null,
    "errorMessage": null,
    "payer": {
      "ispb": "12345678",
      "personType": "company",
      "cpfCnpj": "XX123456000XXX",
      "name": "EMPRESA EXEMPLO LTDA",
      "agency": "0001",
      "accountType": "checking",
      "accountNumber": "123456789012"
    },
    "receiver": {
      "ispb": "87654321",
      "personType": "person",
      "cpfCnpj": "XXX123456XX",
      "name": "JOAO DA SILVA",
      "agency": "0001",
      "accountType": "CACC",
      "accountNumber": "00000000000012345678"
    },
    "uid": "E123456789202512230000000000002"
  }
}

​
Finalidade

Este endpoint permite consultar uma operação no Ledger pelo identificador externo.

​
Autenticação

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

​
Path Parameters

​
externalId
string
obrigatório
Identificador externo definido pelo cliente no momento da criação da transação.

​
Resposta

​
requestId
string
UUID para rastreio
​
success
boolean
Status da operação
​
size
number
Quantidade de registros
​
message
string
Mensagem descritiva (ex: “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-EXEMPLO-001",
    "endToEndId": "E123456789202512230000000000002",
    "entryId": null,
    "accountId": "123456789012",
    "userId": "usr_abc123def",
    "requestId": "M000000000a202512230000000000002",
    "createdAt": 1766523042000,
    "createdDate": "2025-12-23",
    "updatedAt": 1766533845420,
    "updatedDate": "2025-12-23",
    "metadata": {
      "idempotencyKey": "1766523039000-abc12345"
    },
    "idempotencyKey": "debit:pix_out:processing:E123456789202512230000000000002",
    "parentEndToEndId": null,
    "refundedEndToEndId": null,
    "medId": null,
    "medCreatedAt": null,
    "medCreatedDate": null,
    "errorMessage": null,
    "payer": {
      "ispb": "12345678",
      "personType": "company",
      "cpfCnpj": "XX123456000XXX",
      "name": "EMPRESA EXEMPLO LTDA",
      "agency": "0001",
      "accountType": "checking",
      "accountNumber": "123456789012"
    },
    "receiver": {
      "ispb": "87654321",
      "personType": "person",
      "cpfCnpj": "XXX123456XX",
      "name": "JOAO DA SILVA",
      "agency": "0001",
      "accountType": "CACC",
      "accountNumber": "00000000000012345678"
    },
    "uid": "E123456789202512230000000000002"
  }
}

​
Códigos de Status

HTTPDescrição
200Sucesso
400externalId malformado
401Credenciais inválidas
403IP não allowlisted
404Entrada não encontrada
429Rate limit excedido
500Erro interno
O externalId é o identificador que você definiu ao criar a transação (PIX ou transferência).