Skip to main content
GET
Download a boleto charge's PDF
The body is the PDF file itself, base64-encoded, as plain text — not JSON. Decode it to get the PDF, or prefix it with data:application/pdf;base64, to open or download it in a browser. The bank produces the PDF once it has registered the boleto: ask for it when the charge is CREATED. A charge still PROCESSING after its creation failed has no reference at the bank, so there is no PDF to download — and a boleto the bank no longer has is refused with the bank’s reason. Asking again won’t change either. A refusal under the bank’s business rules comes back with the bank’s status and its reason as code — in lower case, unless this API knows it by name; the reason not_found is always a 500 NOT_FOUND — and an answer this API doesn’t recognize is a 500 BANKING_PROVIDER_INTEGRATION_ERROR. Use default as walletId for the organization’s main wallet. Any member of the organization can download it.

Headers

x-environment
enum<string>

Environment of the charge: LIVE (production) or TEST (sandbox). When you omit it, TEST is used; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization.

Format: UUID

accountId
string
required

ID of the organization's account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$
walletId
string
required

ID of the wallet that issued the charge (24 hexadecimal characters), or default for the organization's main wallet.

Pattern: ^([0-9a-fA-F]{24}|default)$
boletoId
string
required

ID of the boleto charge — its _id (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Response

The boleto's PDF file, base64-encoded.

The boleto's PDF file, base64-encoded.