Pay bank slip

In Brazil, bank slips, known as Boleto Bancarios or simply Boletos in Portuguese, are a popular payment method for various services, bills, and purchases. When a payment needs to be made, the recipient (such as a business or service provider) generates a Boleto with the necessary payment details, such as the recipent's information, the payment amount, due date, barcode, and other relevant information. Pismo works with BTG Pactual, Celcoin, and Itaú to implement Boleto payments. In the future, Pismo may work with additional financial companies. This endpoint generates the following events:

  • Authorization created - This event contains bank slip information (beneficiary name and document number, digitable line, amount, payment date, interest/fine and discount (if any) in the metadata field.
  • Financial bank slip status changed - Before clearing, a bank slip's status is PAID. After clearing, Pismo changes its status to SETTLED.
  • Integrated payments financial reconciliation- This event is generated after the transaction has been cleared and accounts debited or credited. If x-skip-reconciliation is true or the provider is JD Consultores, this event is not generated.
    See Bank slips for more information.
    Important: You need to call Validate bank slip before calling this endpoint and pass the external_authorization field value if it is returned from that call here.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request Body

integer
required

Pismo Platform Account ID.

number
required

Amount to pay.

bankslip
object

Bank slip information

string

ISO 4217 currency code. Can be either numeric or alphabetic.

string

External authorization. Some providers return this value to the /v1/bankslips/validate endpoint. If returned, this value must be passed on to a bank slip payment request. Some providers return this to a Validate bank slip call. If returned, you must pass it in a Pay bank slip endpoint call.

Headers
string
required

Account token. Getting an account token requires you call the Server login endpoint with an account ID. Tokens can expire quickly, which can result in an Unauthorized message. Enter this field under AUTHENTICATION.

string
required

Unique identifier (UUID) to ensure the operation remains idempotent, allowing for operation repitition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json