Get an issued boleto

GET

https://tenant.api.corpx.com/v1/accounts/:accountId/boleto/charge/:chargeId

GET

/v1/accounts/:accountId/boleto/charge/:chargeId

curl https://tenant.api.corpx.com/v1/accounts/accountId/boleto/charge/chargeId \
     -H "X-Tenant-Id: X-Tenant-Id" \
     -H "Authorization: Bearer <token>"

{
  "chargeId": "8c1f6a2e-4d3b-4b9a-9f0e-1a2b3c4d5e6f",
  "identifier": "order-12345",
  "status": "OPEN",
  "updatedAt": "2026-09-24T14:08:12Z",
  "barcode": "23793381286000782713695000063305975520000015075",
  "digitableLine": "23793381286000782713695000063305975520000015075",
  "ourNumber": "string",
  "registrationCondition": "REGISTERED",
  "dueDate": "2026-02-20",
  "amount": {
    "nominal": 150.75,
    "updatedAmount": 150.75,
    "currency": "BRL"
  },
  "statusReason": "Pagamento pedido #12345",
  "paymentLimitDate": "2026-02-20",
  "payment": {
    "amount": 150.75,
    "settledAt": "2026-02-20T08:33:39Z"
  },
  "payer": {
    "name": "MARIA DA SILVA",
    "taxNumber": "12345678000190",
    "personType": "person"
  }
}

Always reads the current boleto from the settlement bank, upserts the local mirror, and returns that live result with updatedAt set to the successful synchronization instant. chargeId is the settlement-bank id returned by the issue call. Requires boleto_charge.

A provider failure is returned as an error. This route never falls back to a stale mirror row.

Always reads the current boleto from the settlement bank, upserts the local mirror, and returns that live result with `updatedAt` set to the successful synchronization instant. `chargeId` is the settlement-bank id returned by the issue call. Requires `boleto_charge`. A provider failure is returned as an error. This route never falls back to a stale mirror row.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired

Account identifier.

chargeIdstringRequired

Settlement-bank id returned by the issue call (chargeId).

Response

Boleto

chargeIdstring

Settlement-bank id of this boleto. Use it on the item route and in webhooks.

identifierstring

Your idempotency key.

statusenum

Canonical status.

updatedAtdatetime

Last successful synchronization with the settlement bank, in UTC.

barcodestringOptional

Barcode.

digitableLinestringOptional

Linha digitável.

ourNumberstringOptional

Our number at the settlement bank.

registrationConditionenumOptional

Registration at the central base. PENDING right after issuance.

Allowed values:

dueDatedateOptional

Due date.

amountobjectOptional

statusReasonstringOptional

Present when the settlement bank sent a reason.

paymentLimitDatedateOptional

Last day payment is accepted.

paymentobjectOptional

Present after settlement.

payerobjectOptional

requestobjectOptional

Original normalized issuance request, available on item detail for audit and the backoffice dialog.

Errors

403

Forbidden Error

404

Not Found Error

502

Bad Gateway Error

Authentication

Path parameters

Headers

Response

Errors