Skip to main content
POST
Create boleto

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

Trio-Version
enum<string>
required

Version of the v2 contract the client is written against. Each breaking change publishes a new version.

Available options:
2026-10-19.v2
Trio-Target-Org-Id
string<uuid>

ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.

Body

application/json

Boleto payload

Body params to create a boleto

amount
integer
required

Amount of the boleto in cents

Required range: x >= 1
bank_account_id
string<uuid>
required

Unique identifier

counterparty
object
required
due_detail
V2 BoletoDueDetailParams · object
required

Due detail of a boleto. Each rule takes amount (cents) for an amount calculation type and value (basis points, 100 = 1%) for a percentage one.

Example:
expiration_date
string<date>
required

Last day on which the boleto can be paid

invoice_type
enum<string> | null
required

Boleto invoice type

Available options:
commercial_duplicate,
indicated_commercial_duplicate,
service_duplicate,
indicated_service_duplicate,
rural_duplicate,
bill_of_exchange,
commercial_credit_note,
export_credit_note,
industrial_credit_note,
rural_credit_note,
promissory_note,
rural_promissory_note,
triplicate_commercial,
triplicate_service,
insurance_note,
receipt,
invoice,
debit_note,
insurance_policy,
school_fee,
consortium_installment,
invoice_note,
debt_document,
rural_product_certificate,
warrant,
state_active_debt,
municipal_active_debt,
federal_active_debt,
condominium_fee,
credit_card,
others
wallet_type
enum<string>
required

Boleto wallet type

Available options:
direct_electronic_partial_emission_booklet,
book_entry_electronic_booklet,
direct_electronic_with_emission_booklet,
direct_electronic_no_emission_block_client,
direct_electronic_no_emission_block_us,
book_entry_electronic_bloquete,
direct_electronic_no_emission_block_client2,
direct_electronic_partial_emission_bloquete,
direct_electronic_with_emission_bloquete,
direct_electronic_no_emission_us_emission,
direct_electronic_our_number_emission_banks_bloquete,
direct_electronic_our_number_emission_banks_booklet
description
string | null
Maximum string length: 25
external_id
string | null

External ID

Maximum string length: 40
merchant
object | null

Merchant to register as the split org merchant. When sent, it is saved.

notes
string[] | null
Maximum array length: 3
options
object | null

Optional boleto settings

splits
object[] | null

Cashin split configurations

Response

Created

Response for boleto

data
V2 Boleto_Response_Params · object

A boleto

Example: