Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Bank slip

Validate bank slip

Validate bank slip with provider partner.<br> You need to call this endpoint before calling Pay bank slip. If this endpoint returns an external_authorization field value, you must pass it in the Pay bank slip call.<br> For this endpoint, either bar_code or digitable_line must be passed.

post/v1/bankslips/validate

Headers

Authorizationstring 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 <b>Unauthorized</b> message. Enter this field under AUTHENTICATION.

Request body

type1 | 2 required

Banslip type. (1 = compensation form, 2 = dealership)<br> Compensation form refers to the method for processing the bank slip. Dealership (cedente) refers to the entity or individual that issues the bank slip.

bar_codestring

Bar code encoding bank slip information such as the bank code, currency code, check digit, due date, amount, and beneficiary information.

digitable_linestring

Digitable line. On a Brazilian bank slip, the digitable line contains numerical payment information encoding details like the payment amount, due date, beneficiary information, and other transaction-specific data.

Example request

{
  "type": 1,
  "bar_code": "22323423423423423",
  "digitable_line": "20890001091000001090980008176705191030000002000"
}

Response

Response Body

amountnumber

Amount to pay.

assignorstring

The name of the receiver bank.

bar_codestring

Bar code.

beneficiary_document_numberstring

A government document number, such as a CPF (Brazil) - Cadastro de Pessoas Fisicas (Indiviual Taxpayer Registry) number, CNPJ (Brazil) - Cadastro Nacional de Pessoa Juridica (National Registry of Legal Entities) number - unique ID for legal entities, such as companies and organizations.

beneficiary_namestring

Beneficiary name.

digitable_linestring

Digitable line. On a Brazilian bank slip, the digitable line contains numerical payment information encoding details like the payment amount, due date, beneficiary information, and other transaction-specific data.

discount_valuenumber

Discount value.

due_datestring datetime

Due datetime. ISO 8601 format - yyyy-MM-ddTHH:mm:ss.SSSSSSSSSZ.

external_authorizationstring

Some providers return this to a Validate bank slip call. If returned, you must pass it in a Pay bank slip](ref:post-integrated-payments-api-v1-bankslips-pay) endpoint call. If returned, this value must be passed on to a bank slip payment request.

fine_valuenumber

Fine value.

interest_valuenumber

Interest value.

limit_datestring date

Limit datetime to pay. ISO 8601 format - yyyy-MM-ddTHH:mm:ss.SSSSSSSSSZ.

max_valuenumber

Maximum value.

min_valuenumber

Minimum value.

original_valuenumber

Original value.

payer_document_numberstring

A government document number, such as a CPF (Brazil) - Cadastro de Pessoas Fisicas (Indiviual Taxpayer Registry) number, CNPJ (Brazil) - Cadastro Nacional de Pessoa Juridica (National Registry of Legal Entities) number - unique ID for legal entities, such as companies and organizations.

payer_namestring

Payer's name.

settle_datestring date

Settlement date. ISO 8601 format - yyyy-MM-ddTHH:mm:ss.SSSSSSSSSZ.

typeinteger

bank slip type. (1 = compensation form, 2 = dealership).<br> Compensation form refers to the method for processing the bank slip. Dealership (cedente) refers to the entity or individual that issues the bank slip.

Example response

{
  "amount": 10,
  "assignor": "BANCO ITAU S.A.",
  "bar_code": "22323423423423423",
  "beneficiary_document_number": "123456789",
  "beneficiary_name": "Beneficiary name",
  "digitable_line": "34192374039002121400385000334004688970000050227",
  "due_date": "2022-08-15T00:00:00.000Z",
  "external_authorization": "123",
  "limit_date": "2022-08-15T00:00:00.000Z",
  "max_value": 10,
  "min_value": 10,
  "original_value": 10,
  "payer_document_number": "923456789",
  "payer_name": "Payer's name",
  "settle_date": "2022-08-15T00:00:00.000Z",
  "type": 1
}