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",
  "barcode": "23793381286000782713695000063305975520000015075",
  "digitableLine": "23793381286000782713695000063305975520000015075",
  "ourNumber": "string",
  "status": "OPEN",
  "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"
  }
}

Live boleto. chargeId is the settlement bank’s id returned by the issue call. Requires boleto_charge.

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

chargeIdstringOptional

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

identifierstringOptional

Your idempotency key.

barcodestringOptional

Barcode.

digitableLinestringOptional

Linha digitável.

ourNumberstringOptional

Our number at the settlement bank.

statusenumOptional

Canonical status.

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

Errors

403

Forbidden Error

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors