11. Document history

2022-12-20

v530

Added the possibility of cancelling a boleto (item 8).

2022-05-24

v520

Changed the length of parameter order to 64 characters.

2022-03-28

v510

Added the possibility of re-submitting the same order number with different product_name and amount_brl (item 4.1).

2019-10-01

v500

Added parameter store_code to customize the boleto for multi-store merchants (item 4.1).

2018-12-03

v495

Parameter customer_bank now expects the bank's number, and not the name. Changed the endpoint for extending the boleto.

2018-10-18

v494

There is no more a specific format for product_name, but it remains mandatory.

2018-10-17

v493

Included information that the content-type needs to be x-www-form-urlencoded.

2018-10-03

v492

Included information about the allowed ports in the IPN's URL (item 4.2).

2018-07-12

v491

Changed the PagBrasil Dashboard tab name Update Information to Account.

2018-07-12

v491

Changed the PagBrasil Dashboard tab name Update Information to Account.

2018-06-11

v490

Added sample codes.

2018-03-01

v481

Changed this document structure.

2018-02-26

v480

Changed the response when adding an order (item 4.1.c).

2017-10-06

v470

Changed the endpoint URLs.

2017-07-03

v460

Limited the possibility of changing the expiration date of an already issued boleto to the API function extendboleto (item 4.1, parameter bol_expiration). Response for the extendboleto function (item 8) will be a different one, as changing the expiration date will now change the boleto's URL.

2017-06-13

v454

Included the information that it is the merchant that needs to ask the end customer for their bank details (item 7.1.a).

2017-04-25

v453

Renamed "PagBrasil Merchant Interface" to "PagBrasil Dashboard".

2016-10-21

v452

Included the information that param_url is encoded in the XML IPN (item 5.2.c). Changed the IPN expected response to "Received successfully [timestamp]" (item 5.2.b).

2016-10-18

v451

Changed the length of parameter secret to 128 characters.

2016-07-22

v450

Changed the PagBrasil Merchant Interface and API's URLs to a sandbox subdomain.

2015-11-22

v440

Added the possibility to re-submit an order for any payment method if it was not already paid (item 4.1.c).

2015-10-31

v430

Added parameter signature to the IPNs (item 5.2 and 7.2). Implemented a system that automatically resends failed IPNs (item 5.2.b) during a period of 24 hours. Updated information about the Boleto Flash^®.

2015-09-28

v420

Changed the PagBrasil Merchant Interface and API's URLs.

2015-09-10

v410

Added the possibility of extending the expiration date of an already issued boleto via API function extendboleto (item 8).

2015-08-22

v400

Added authentication element signature to the getorder response (item 6.2.a).

2015-08-11

v360

Updated the time in which a boleto refund is processed (item 7.2). Included a recommendation to include the boleto link into the order confirmation e-mail (item 4.2).

2015-06-16

v350

Added value "F" for parameter payment_method to identify a Boleto Flash^®.

2015-02-23

v341

Added the possibility of extending the expiration date of an already issued boleto via PagBrasil Merchant Interface.

2014-08-06

v340

Added pbtoken as a required parameter to be sent with the parameter secret to authenticate API requests.

2014-06-17

v331

Added regular expression to specify the characters allowed in the parameter order (item 4.1.c).

2014-05-28

v330

Changed how to confirm if the response is a boleto's URL and not an error (item 4.2, changed from "http://" to "http" to also allow boleto's URLs beginning with https). Added note that "All fields are required except when noted otherwise".

2014-02-23

v320

Added notification via API when a refund is rejected (item 7.2.b).

2014-01-04

v312

Added document history (item 9).

2013-12-08

v311

Added an example of CPF and CNPJ (tax ID) for testing purposes.

2013-11-02

v310

Added the possibility of adding dynamic parameters when submitting an order (item 4.1 and 5.2).

2013-10-11

v290

Added notification via API when a refund is processed (item 7.2).

2013-05-31

v270

Added the possibility of defining the number of days until a Boleto Bancário expires (parameter bol_expiration) or defining an overall expiration date at the PagBrasil Merchant Interface (item 4.1).

2012-09-26

v260

Changed: submission of a duplicated order returns the payment link previously generated (4.1.c).