Balance1

Boleto7

Boleto Holmes5

Boleto Payment7

Brcode Payment7

Card Method1

Corporate Balance1

Corporate Holder7

Corporate Invoice2

Corporate Purchase5

Corporate Transaction2

Corporate Withdrawal3

Darf Payment7

Deposit6

Dynamic Brcode3

Event4

Event Attempt2

Institutions1

Invoice10

Invoice Pull Request6

Invoice Pull Subscription6

Merchant Card4

Merchant Category1

Merchant Country1

Merchant Installment4

Merchant Purchase6

Merchant Session6

Payment Preview1

Payment Request2

Pix Key2

Public Key1

Split4

Split Profile5

Split Receiver5

Tax Payment7

Transaction2

Transfer7

Utility Payment7

Verified Account6

Verified Transfer1

Webhook4

Workspace4

Boleto

Get a Boleto PDF

Get a downloadable boleto PDF file. This route is public and does not require the usual authentication headers. However, if you request an invalid boleto ID too many times, your IP will be blocked for this specific route.

get/v2/boleto/{id}/pdf

Request

Base URL
https://api.starkbank.com
URL
https://api.starkbank.com/v2/boleto/{id}/pdf
Auth
API key in header Digital-Signature

Path parameters

idstring required

Id of the boleto entity

Query parameters

hiddenFieldsstring[]

List of fields to be hidden in Boleto pdf. Example: ["customerAddress"].

layoutstring

PDF layout. Available options are "default" (full page) and "booklet" ("carnê").

Response

Successful operation

object required

Changes

No recorded changes to this operation across all 1 revision of this API.