Create Bolepix

Create Bolepix

POST {{Environment_URL}}/vendors/v1/charges

Creation of a bolepix: a billing instrument that works as a traditional bank slip, following all its rules for expiration, interest, late fees, and so on, but that also includes an automatically generated Pix QR Code as an optional payment method Bank slip with an automatically generated Pix QR Code as an optional payment method

Body Params

The difference between Bolepix and Charge lies in the following fields:

  • paymentMethod

  • paymentMethodDetails

  • payerId

  • contacts

The API call structure is the same, but these additional fields are required for Bolepix.

Body

Key
Description
Required
Data Type
Example

quotationId

Quotation ID obtained from Generate Quotation Bolepix

true

String

"4b05d676067757b7058ed615a1dd12e09e02bb22"

nature

Operation type

true

String

"SERVICES_AND_OTHERS" "CASH_REMITTANCE" "GAMES_AND_BETS" "CRYPTO_ACTIVES" "UNKNOWN"

payerId

Payer document, CPF or CNPJ.

true

String

"41707054088"

paymentMethod

Must be 'BOLEPIX' to create a bolepix transaction instead of a standard charge.

true

String

"BOLEPIX"

paymentMethodDetails.payer.name

Payer name.

true

String

"Gerardo Silva"

paymentMethodDetails.payer.city

Payer city.

true

String

"São Paulo"

paymentMethodDetails.payer.state

Payer state.

true

String

"SP"

paymentMethodDetails.payer.zipCode

Payer zipCode.

true

String

"04571-010"

billingConfig.dueDate

Deadline for paying the original amount. Payments after this date may include interest and late fees

true

String

"2025-08-20"

billingConfig.expirationDate

Payment must be completed by this date. After that, it expires. The expiration date must be within 59 days after the due date

true

String

"2025-08-30"

billingConfig.fineDate

Late fee applied after the due date. You can define a fixed amount, a percentage of the original value. The fee must not exceed 2% of the original Bolepix amount

false

String

"2025-08-26"

billingConfig.fineValue

The fineValue must not exceed 2% of the original Bolepix amount. Amount must be provided in minor units Example: $1.00 USD = 100

false

Integer

100

billingConfig.interestDate

Interest charged daily after the due date. It can be defined as a percentage or as a fixed daily amount. The interest must not exceed 1% of the original Bolepix amount

false

String

"2025-08-23"

billingConfig.interestPercent

The interest percent must not exceed 1% of the original Bolepix amount. (Example: 0.5 = 0.5%)

false

Number

0.5

contacts.emails

List of email addresses to notify the customer that the Bolepix is ready for payment. A notification will be sent to all provided email addresses

true

Array (array of strings)

["[email protected]", "[email protected]"]

contacts.phones

List of phone numbers to notify the customer via SMS that the Bolepix is ready for payment. An SMS will be sent to each phone number provided.

true

Array (array of strings)

["+5511982435422"]

The PIX payment data is present in the Response QRCode Image: transaction.qrCodeUrl Copy and Paste: transaction.dynamicPixCode

Headers

Name
Value

Authorization

Bearer <token>

Request body

Response

PreviousGenerate Quotation BolepixNextGet Bolepix by ID