Skip to main content
GET
Retrieve boleto

Authorizations

Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace
string
required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode
boolean
default:false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

id
string
required

Resource identifier.

Response

The boleto.

Brazilian boleto bancário associated to a payment. Stores the bar code, bill ID and a PDF artifact.

payment
integer
required

Payment ID.

bill_id
string
required
Maximum string length: 128
barcode
string
required
qr_code
string
required
id
integer
read-only
pdf
string<uri> | null

Signed URL to the rendered boleto PDF.

created
string<date-time>
read-only