Boleto
Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil.
To complete a transaction, customers receive a voucher stating the amount to pay for services or goods. Customers then pay the boleto before its expiration date in one of several different methods, including at authorized agencies or banks, ATMs, or online bank portals.
Payment type | Cash-based payment method |
Market | Brazil |
Customer currencies | BRL |
Processing currencies | BRL |
Refunds | Yes |
Step 1. Make a transaction request
From your server, make a POST /payment_preauthorize request.
POST https://sandbox.powercash21.com/pay/backoffice/payment_preauthorize
Include in request:
merchantid
: The merchant identification number.orderid
: The field orderid is optional and exclusively for the merchant's convenience.amount
: The amount field contains the transaction’s total amount. This is the amount that will be transmitted to the authorizing system.currency
: The currency field contains the alphanumeric currency code for the transaction, according to ISO 4217, e.g. USD.payment_method
: The payment method id - 130.signature
: The signature field contains a 40-figure hexadecimal value. This signature value is a checksum designed to protect the merchant account from unauthorized access.country
: Customer country in ISO Alpha-3 format. Supported countries: BRA.email
: The customer's email address.custom2
: The name of payment method - boleto.nationalid
: Consumer’s national id, has to satisfy the following regular expression: 11 digits if CPF or 14 digits if CNPJnationaltype
: User's identification type CPF or CNPJzip
: User's zip code
You can see a full list of parameters in Pre-Authorization.
Request example
/pay/backoffice/payment_preauthorize&merchantid=gateway_test&amount=23¤cy=BRL&orderid=Payabl-Test
&language=en&gender=&lastname=Mann&street=Office+11A,+Swepco+Court,+Griva+Digeni+80&zip=60322&
city=Frankfurt&country=DEU&customerid=&salutation=&title=&firstname=Muster&company=&birthday=&house=&
postbox=&state=&[email protected]&phone=&fax=&mobile=&customerip=&custom1=&custom2=boleto&custom3=&
url_return=http://dev-sim-ng.inatec.local/~simdad/InatecResponse/redirect_response.php&url_success=
http://dev-sim-ng.inatec.local/~simdad/InatecResponse/success.php&url_failed=http://dev-sim-ng.inatec.
local/~simdad/InatecResponse/failed.php¬ification_url=https://api.powercash.de/simulation/billing_response.php&payment_method=130&nationaltype=CPF&nationalid=50284414727&subject=test+subject&content=test+content&signature=13c3646cf6a4215475afd26621df69b74742453f
Step 2. Handle the redirect
To complete the payment, you need to redirect the customer to the correct URL in the response.
Response
transactionid=105352753&transid=105352753&status=2000&errormessage=pending&errmsg=pending&amount=23&
price=23¤cy=BRL&orderid=Payabl-Test&redirect_url=https://checkout-test.pagsmile.com/checkout?
prepay_id=eXhiV1ZrRHFhckpHWkNSeHJ4b0EzOVVzUXg5ZHNidWVpUjAxV2hsTTNGMD0=-16Fa3ec9&user_id=787410
Notification example
errormessage=&security=aaaa0f0374251e52d3691eafd7f2bb36b76aa6bf05e36e922dd3a30dcf89340f&type=capture&
orderid=Payabl-Test&errorcode=0×tamp=1693227606&payment_state=credited&transactionid=105352753&
payment_method=130
url_return
andnotification_url
should be provided by you to payabl. technical team.
Notification example with additional account parameters.
"bank_number=70440&account_number=LTXXXXXXXXXXXXXX4024&payment_state=credited&bank_name=SEB&
errormessage=&type=capture&transactionid=116033311&account_holder=muster+mann&
bank_country=LITHUANIA×tamp=1605788760&
security=19667fb6d9d2f3c8457e29d949f72319a9986b88b0be47050d9fc49f746d279b&orderid=6eebd443fb407e3f35f0&errorcode=0" "https://www.notification_url"
Refunds
The payment method supports partial or full refunds. In case merchant wants to refund initial transaction to a customer, he needs to initiate a refund request. Merchant needs to provide customer's email for refund to work.
Customer will receive email with link which will redirect him to form where customer needs to provide payment details. After form submitted, refund will be initiated and process
Request example
backoffice/payment_refund&merchantid=andrei&transactionid=215458995&amount=1¤cy=BRL&language=en&
external_id=en&signature=8b5d75824db2a85be4d9f98f68bfe900a527b8ee
Response example
transactionid=215458995&transid=215458995&status=0&errormessage=&errmsg=&amount=1.00&price=1.00&
currency=BRL&orderid=Payabl-Test
Updated 11 months ago