Note: You should be fully PCI compliant if you want to use the Server-to-Server api (as it requires that you collect the card data). If you are not fully PCI compliant, you can use COPYandPAY to collect the payment data securely.
You can perform different types of initial payments using our server-to-server REST API.
Quick links
Card Payment (CC)
Preauthorization (PA) + Capture (CP)
A PA is created by sending a POST request over HTTPS to the /v1/payments resource. The request should include all required information such as your authentication credentials, the type of transaction, the amount and the payment information such as card details. A capture may be sent against a successful PA to request the funds being sent for clearing. See backoffice operations for more details.
A DB is created by sending a POST request over HTTPS to the /v1/payments resource. The request should include all required information such as your authentication credentials, the type of transaction, the amount and the payment information such as card details. A DB request effectively combines a PA and capture (CP) request, automatically requesting that the funds are cleared if the authorization was successful.
Please note that for a HTTP POST request all the parameters are expected to go into the message body and not into the URL.
Boleto (PP) - (Brazil only)
Boleto Bancário is a PrePayment (PP) method (invoice/slip/voucher), which is widely used in Brazil to pay offline and online. Boleto represents 20% of payments in e-Commerce.
Boletos are payment slips, issued by sending a PA to the PPRO system. A Boleto is displayed at end customer’s browser where the Boleto can be printed out and paid in any bank in Brazil.
Clearing could take up to D+3.
PPRO matches bank return and generates a payment confirmation transaction type (RC) in the system. The merchant receives a report including Receipts (RC) for paid Boletos through a pre-defined SFTP server or webhook.
Advantage: Boleto payments are not subject to chargebacks. Once the payment has been made it is final and may only be refunded via bank transfer.
Boletos have due dates, up to which a payment is possible. Please discuss the optimal due dates (expiry dates) with your Account Manager, as it depends on the industry. Reminder emails sent to the customer up to 3 days before due date improve conversion significantly.
Preauthorization (PA) - Issue the Boleto
1. Send an Initial Payment
The first step is to send a Server-to-Server initial payment request with the paymentBrand and shopperResultUrl. The shopperResultUrl must be url-encoded.
Brazilian banks do not support special characters for Boletos. i.e: !, @, #, $, %, ¨, &, , (, ), _ , +, = , ´ , “ , ‘ , ] ,[ , ^,? ,: , >, <, TM, ®, º, °, /, |, \, {, }, ª, ¢, ¬, £, etc, then you must ensure that the customer does not enter special character in these fields.
Expiry date. Payment of the Boleto is possible up to this date. At least 3 days from issuing date is recommended, so that the customer has enough time to conclude the payment.
2. Redirect the shopper
The boleto can be displayed both on desktop and mobile devices. Typically the user will expect to receive an email containing the order information and the link to display the boleto.
Important: Not every boleto will in fact be paid by your customer. Depending on the industry, up to 50% of the issued boletos will not receive a payment. Note that these will remain on the platform, even if already overdue.
Payment confirmations can be received by:
Business Intelligence Platform (BIP), (search)
Boleto Refund (RF)
Most boletos are paid with cash at any of the acceptance places in Brazil (post offices, gas stations etc). Since the boleto does not have a native method to refund a transaction, PPRO enables the merchant to refund these transactions via bank transfer. For that it is required for the merchant to collect and provide the customers bank account data, either: programmatically via API or manually via Business Intelligence Platform (BIP).
Boleto RF via API
A refund is performed against a previous payment (RC), referencing its payment.id by sending a POST request over HTTPS to the /v1/payments/{id} endpoint.
Boleto RF via Business Intelligence Platform (BIP)
Required data from the customer:
Name
Brazilian CPF (see compliance (Customer ID number by country))
Bank name
Bank agency number
Bank account data
Oxxo (PP) - (Mexico only)
Oxxo is a PrePayment (PP) method (invoice/slip/voucher), which is widely used in Mexico to pay offline (Oxxo store).
Oxxo are payment slips, issued by sending a PA request to PPRO’s system. The slip is displayed on the end customer’s browser where it can be either printed out or scanned off a mobile device.
The Oxxo slip has two important elements: barcode & reference number (numerical representation of the barcode). The customer is able to pay by either of them. It is a question of which design fits your checkout better. In addition, PPRO provides a hosted page containing both elements.
Clearing usually happens the next day, but can be delayed (in case of weekends and public holidays in Mexico).
Oxxo due dates are configurable. Please discuss the optimal due dates (expiry dates) with your Account Manager. Reminder emails sent to the customer up to 3 days before due date improve conversion significantly.
Preauthorization (PA) - Issue the payment slip
1. Send an Initial Payment
The first step is to send a Server-to-Server initial payment request with the paymentBrand .
ConnectorDetails.EXTERNAL_SYSTEM_LINK: PPRO hosted complete page containing all elements (barcode, reference number)
ConnectorDetails.EXTERNAL_SYSTEM_BARCODE_IMAGE: barcode url of PPRO hosted png.
ConnectorDetails.EXTERNAL_SYSTEM_BARCODE_NUMBER: reference number (can be used equally for paying the oxxo slip). The first option is a complete solution, options 2&3 offer the merchant full flexibility to build his own oxxo page by using the elements to this end.
2. Redirect the shopper
The Oxxo slip can be displayed both on desktop and mobile devices. Typically the user will expect to receive an email containing the order information and the link to display the Oxxo slip.
Redirect the shopper to the EXTERNAL_SYSTEM_LINK.
Sample of Oxxo slip:
Receipt (RC) - Payment confirmation
Payment confirmations can be received by:
Business Intelligence Platform (BIP), (search)
Oxxo Refund (RF)
Most slips are paid with cash at any of the acceptance places in Mexico (Oxxo stores). Since the slip does not have a native method to refund a transaction, PPRO enables the merchant to refund these transactions via bank transfer. For that it is required for the merchant to collect and provide the customers bank account data, via Business Intelligence Platform (manual):
Oxxo RF via BIP
PayPal (VA) - (Brazil)
PayPal is one of the most popular alternative payment methods. In an asynchronous workflow a redirect takes place to allow the account holder to complete/verify the payment. After this the account holder is redirected back to the shopperResultUrl and the status of the payment can be queried.
Debit (DB)
In an asynchronous workflow a redirect takes place to allow the account holder to complete/verify the payment. After this the account holder is redirected back to the shopperResultUrl and the status of the payment can be queried.
1. Send an Initial Payment
The first step is to send a Server-to-Server initial payment request with the paymentBrand and shopperResultUrl. The shopperResultUrl must be url-encoded.
The next step is to redirect the account holder. To do this you must parse the redirect.url from the Initial Payment response along with any parameters. If parameters are present they should be POST in the redirect, otherwise a straight forward redirect to the redirect.urlis sufficient.
Once the payment has been processed, the customer is redirected to your shopperResultUrl along with a GET parameter resourcePath.
Then, to get the status of the payment, you make a GET request to the baseUrl + resourcePath, including your authentication parameters.
Example of a resourcePath:
PIX is the first instant payment system available to Brazilian consumers, developed by the Central Bank of Brazil.
PIX is a PrePayment (PP) method, which allows transfers and payments between different financial institutions in up to 10 seconds, 24 hours a day and every day of the year, including weekends and holidays (funds are transferred in real-time from the customer’s account to the payee).
PIX is issued by sending a PA to the PPRO system. PPRO can offer two different PIX solutions:
A complete solution: PPRO generates and hosts a complete page containing all elements (dynamic QR code image, EMV code - including the Copy EMV code button and merchant logo);
QR Code (dynamic) URL/Image: gives to merchant full flexibility to build its own PIX checkout page based on a QR code image.
PPRO receives the bank confirmation and generates a payment confirmation transaction type (RC) in the system. The merchant receives via webhook a notification about the payment confirmation. (The merchant should provide its webhook URL).
Advantage: Besides the instant confirmation, PIX payments are not subject to chargebacks. Once the payment has been made it is final and can be refunded only by the merchant.
PIX has due dates, up to which a payment is possible. Please discuss the optimal due dates (expiry dates) with your Account Manager, as it depends on the industry. Reminder emails sent to the customer up to 3 days before the due date improve conversion significantly.
List of mandatory fields:
--data-urlencode 'authentication.entityId=8ac9a4cb7859e48801785f9debcd53af' \
--data-urlencode 'amount=0.01' \
--data-urlencode 'currency=BRL' \
--data-urlencode 'paymentBrand=PIX' \
--data-urlencode 'paymentType=PA' \
--data-urlencode 'billing.country=BR'
--data-urlencode customParameters[referencedTxUuid]=(Parente UUID)' {ONLY FOR RF}
Note:
Brazilian banks do not support special characters. i.e: !, @, #, $, %, ¨, &, , (, ), _ , +, = , ´ , “ , ‘ , ] ,[ , ^,? ,: , >, <, TM, ®, º, °, /, |, \, {, }, ª, ¢, ¬, £, etc, then you must ensure that the customer does not enter a special character in these fields.
2. Redirect the shopper
The PIX QR Code can be displayed both on desktop and mobile devices. Typically the user will expect to receive an email containing the order information and the link to display the PIX QR Code.
PIX has its native Refund solution that can be triggered via API.
PIX RF via API
A refund is performed against a previous payment (RC), referencing its e2e id by sending a POST request over HTTPS to the /v1/payments/{id} endpoint.
REMARK: To perform the Refund correctly, it is very important the information customParameters[referencedTxUuid] should be filled with the preauthorization’s (PA) UUID.
As well as the RF, PIX has its native Reversal solution that can be triggered via API, to be used to invalidate a QR Code that has not been paid yet. In this case, the PA uuid should be used to reference the QR Code to be reversed.
Rapipago is an Argentinian offline payment method used for online purchases. Shoppers buy their goods and services online and pay offline at one of the 6,000+ Rapipago payment locations.
The customer is presented with a payment slip including a barcode, which can be paid in cash at the payment locations by scanning the slip at the terminal.
Different from other cash based PMs, Rapipago offers realtime payment confirmations.
After successful payment, the customer is handed a printed receipt for the operation.
PPRO receives the payment confirmation and generates a payment confirmation transaction type (RC) in the system. The merchant receives via webhook a notification about the payment confirmation. (The merchant should provide its webhook URL).
Advantage: Besides the instant confirmation, Rapipago payments are not subject to chargebacks. Once the payment has been made it is final and can be refunded only by the merchant (Rapipago does not have any native Refund functionality. Therefore a refund can only be performed via a bank transfer.).
Rapipago has due dates, up to which a payment is possible. Please discuss the optimal due dates (expiry dates) with your Account Manager, as it depends on the industry. Reminder emails sent to the customer up to 3 days before the due date improve conversion significantly.
Preauthorization (PA) - Issue the Rapipago voucher
2. Redirect the shopper
The Rapipago voucher can be displayed both on desktop and mobile devices. Typically the user will expect to receive an email containing the order information and the link to display the Rapipago voucher. The voucher has to be printed, but there is an ongoing development in order to scan the payment slip directly from the mobile screen.
PagoFácil is a payment service in Argentina that allows its users to send money, top up their cell phone and payments. PagoFácil can be used for online purchases and for offline payment at 4,000 locations.
The customer is presented with a payment slip including a barcode, which can be paid in cash at the payment locations by scanning the slip at the terminal.
Different from other cash based PMs, PagoFácil offers realtime payment confirmations.
After successful payment, the customer is handed a printed receipt for the operation.
PPRO receives the payment confirmation and generates a payment confirmation transaction type (RC) in the system. The merchant receives via webhook a notification about the payment confirmation. (The merchant should provide its webhook URL).
Advantage: Besides the instant confirmation, PagoFácil payments are not subject to chargebacks. Once the payment has been made it is final and can be refunded only by the merchant (PagoFácil does not have any native Refund functionality. Therefore a refund can only be performed via a bank transfer.).
PagoFácil has due dates, up to which a payment is possible. Please discuss the optimal due dates (expiry dates) with your Account Manager, as it depends on the industry. Reminder emails sent to the customer up to 3 days before the due date improve conversion significantly.
Preauthorization (PA) - Issue the PagoFácil voucher
2. Redirect the shopper
The PagoFácil voucher can be displayed both on desktop and mobile devices. Typically the user will expect to receive an email containing the order information and the link to display the PagoFácil voucher. The voucher has to be printed, but there is an ongoing development in order to scan the payment slip directly from the mobile screen.
