Realizar pagamento de boleto

Request

ENDPOINT

/bank_slip/payment

METHOD

POST

Request Body

{
    "digitable_line": "42297034020000453753620034706323183380000005000",
    "resource_account_key": "21af482f-b8ac-48dd-8f9a-ea23429d28be",
    "payment_date": "2020-08-05"
}

Body params

Field	Type	Description	Characters
digitable_line *	string	Boleto digitable line.	10
resource_account_key *	string	Key of the account to be used.	10
payment_date	date	Date for payment execution. If not sent, the date will be today.	10

Information

To view accepted payment covenants, click here.

Response

STATUS

200

Response Body: Payment through a free account

{
    "data": {
        "digitable_line": "09990001029100010009895007444201283400000001000",
        "resource_account_key": "21af482f-b8ac-48dd-8f9a-ea23429d28be"
    },
    "event_datetime": "2020-08-06 19:22:06",
    "key": "e7719f95-a31d-4171-ae83-2d8b3d419dc2",
    "status": "success",
    "webhook_type": "bank_slip_payment"
}

STATUS

200

Response Body: Payment through an escrow account

{
    "data": {
        "digitable_line": "09990001029100010009895007444201283400000001000",
        "resource_account_key": "21af482f-b8ac-48dd-8f9a-ea23429d28be"
    },
    "event_datetime": "2020-08-06 19:22:06",
    "key": "e7719f95-a31d-4171-ae83-2d8b3d419dc2",
    "status": "waiting_approval",
    "webhook_type": "bank_slip_payment"
}

STATUS

400

Response Body

{
    "code": "LEG000069"
    "title": "Bad Request",
    "description": "Invalid request body.",
    "translation": "Corpo da requisição inválido.",
    "extra_fields": {}
}

STATUS

423 - Payment outside operating hours

Response Body

{
	"code": "BLP000024",
	"title": "Locked",
	"http_status": 423,
    "description": "Operation window closed. System available from {OPENING_TIME} to {CLOSING_TIME}",
    "translation": "Opera\u00e7\u00e3o encerrada. Sistema dispon\u00edvel de {OPENING_TIME} a {CLOSING_TIME}",
	"extra_fields": {
		"next_available_datetime": "2023-08-13T18:00:00.000Z"
	}
}

STATUS

400

Response Body

{
  "code": "IPP000015",
  "title": "Bad Request",
  "http_status": 400,
  "description": "Invalid amount",
  "translation": "O valor inserido é inválido",
  "extra_fields": {} 
}

STATUS

422

Response Body

{
  "code": "IPP000013",
  "title": "Incompatible Payment Value",
  "http_status": 422,
  "description": "The input amount does not match tax collection value",
  "translation": "O valor do pagamento é diferente da arrecadação",
  "extra_fields": {} 
}

STATUS

422

Response Body

{
  "code": "IPP000012",
  "title": "Tax Collection Already Paid",
  "http_status": 422,
  "description": "This tax collection is already paid",
  "translation": "A arrecadação já foi paga",
  "extra_fields": {} 
}

STATUS

422

Response Body

{
  "code": "IPP000017",
  "title": "Unprocessable Entity",
  "http_status": 422,
  "description": "The tax collection is overdue",
  "translation": "A arrecadação está vencida",
  "extra_fields": {} 
}

STATUS

422

Response Body

{
  "code": "IPP000023",
  "title": "Unprocessable Entity",
  "http_status": 422,
  "description": "Max retries exceeded, while trying to complete payment.",
  "translation": "Número máximo de tentativas excedido, ao tentar concluir o pagamento.",
  "extra_fields": {}
}

STATUS

422

Response Body

{
  "code": "IPP000024",
  "title": "Unprocessable Entity",
  "http_status": 422,
  "description": "Error while processing payment output. Try again.",
  "translation": "Erro ao processar a saída do pagamento. Tente novamente.",
  "extra_fields": {}
}

STATUS

422

Response Body

{
  "code": "IPP000025",
  "title": "Unprocessable Entity",
  "http_status": 422,
  "description": "Outside of covenant payment hours.",
  "translation": "Fora do horário de pagamento do convênio.",
  "extra_fields": {}
}

Sandbox Environment

Covenant/Tax Boletos

Covenant/tax boletos are issued by government agencies, such as city halls, state or federal governments, to collect taxes, fees, social contributions, fines, and other amounts owed to the government.

In our sandbox environment, we provide mocked digitable lines for simulating successful payments and error scenario testing.

Success Scenarios

Digitable line
828300000007411100972013905080001546763201900028
838000000009235700481007241345219112001474229880
848000000006308600802021201071261517689002201070
858200000015000000643025703477209504800448091020

Error Scenarios

Digitable line	Error code
858900000034050002701002700011434710592720230733	IPP000015
858400000000750002701007700011434710592720230733	IPP000013
858800000040450004322322120716192390688090088931	IPP000012
858900000000350004322326120716192390688090083760	IPP000014

Bank Slip (Boleto bancário)

A bank slip (boleto bancário), also known as boleto or bloqueto, is a document widely used in Brazil to pay for products or services. With a boleto, the issuer or company can receive the amount owed from the payer.

In our sandbox environment, we provide mocked digitable lines for simulating successful payments.

Success Scenarios

Digitable line
32990001039000210987502864982109595090000063958
32990001039000000006836762871105695090000010000
32990001031000699960099000000200195070000025527
32990001039000000000103194237800895060001000000
32990001031000699960095000000208497790000030990