PagoEfectivo is a widely-used payment method in Peru, supported by EBANX, that allows customers to complete online purchases without needing a credit or debit card. This voucher-based solution generates a unique Payment Code (CIP) that customers can use to pay in cash at various affiliated locations (such as banks, supermarkets, and convenience stores) or through bank transfer via online banking. Ideal for customers who prefer cash payments or lack traditional banking access, PagoEfectivo offers a secure and accessible payment method that meets local preferences and expands e-commerce options in Peru.
Requirements
- API credentials - Ensure you have your EBANX integration key. If not, complete the Merchant Signup Form.
- Familiarity with EBANX Direct - This setup follows the same general structure as other payment methods, with a few unique parameters.
How it works
- Generate a CIP code - When your customer selects PagoEfectivo at checkout, EBANX generates a unique Payment Code (CIP). This code, valid for a specific period, is sent to your customer via email or SMS and includes all necessary payment details.
- Complete payment - Your customer completes the payment by visiting a partner location (such as local banks, supermarkets, or convenience stores) or through their online banking. They provide the CIP code to finalize the transaction, paying in cash or via bank transfer.
- Payment confirmation - After the payment is made, confirmation may take a short time depending on the venue. EBANX then updates the transaction status, allowing your to proceed with order fulfillment once the payment is confirmed.
Instructions
Follow the steps below.
Select your environment
Select the appropriate environment for your integration. Use the sandbox environment for testing, or the production environment for live transactions. Use the URL for your HTTP requests based on your selection.
https://sandbox.ebanx.com/ws/directDefine your parameters
Since PagoEfectivo operates as a voucher-based payment method, you’ll need to redirect your customer to a page displaying the voucher. To obtain this link, call the ws/direct endpoint with the following required fields:
Basic parameters:
Parameter Description operationSet to requestintegration_keyYour EBANX integration key payment_type_codeSet to pagoefectivocountrySet to pefor Peru.Customer data:
Parameter Description nameCustomer name emailCustomer email Charge parameters:
Parameter Description merchant_payment_codeUnique merchant payment code currency_codeSupported values: PENandUSDamount_totalTotal amount to be charged Sample request
Use the following example to initiate a request.
curl -X POST \
--location 'https://sandbox.ebanx.com/ws/direct' \
--header 'Content-Type: application/json' \
--data '{
"integration_key": "your_ebanx_integration_key",
"operation": "request",
"payment": {
"name": "José Silva",
"email": "joseperu@example.com",
"country": "pe",
"payment_type_code": "pagoefectivo",
"merchant_payment_code": "0x0W28D03-T09",
"currency_code": "PEN",
"amount_total": "100"
}
}'Sample response
A successful request returns a response similar to the example below, with the voucher link available in the payment.cip_url parameter.
{
"payment": {
"hash": "5efcc06e8946d56338424cae6bd6ed8e866d5e76c9bfef49",
"country": "pe",
"merchant_payment_code": "0x0W28D03-T09",
"order_number": null,
"status": "PE",
"status_date": null,
"open_date": "2020-07-01 16:57:17",
"confirm_date": null,
"transfer_date": null,
"amount_br": "100.00",
"amount_ext": "100.00",
"amount_iof": "0.00",
"amount_ext_requested": "100.00",
"currency_rate": "1.0000",
"currency_ext": "PEN",
"due_date": "2020-06-30",
"instalments": "1",
"payment_type_code": "pagoefectivo",
"cip_url": "https://sandbox.ebanxpay.com/cip/main/execute?hash=5efcc06e8946d56338424cae6bd6ed8e866d5e76c9bfef49",
"cip_code": "0",
"pre_approved": false,
"capture_available": null
},
"status": "SUCCESS"
}At this stage, the payment will appear as pending (PE) in yourEBANX Dashboardchevron_rightRedirect customer to the returned URL
Redirect your customer to the URL provided in the
cip_urlparameter. They will see an interface similar to the one below:
Monitor payment for status changes
Notifications
EBANX will send a notification whenever a payment status changes.
Make sure your system is set up to receive notifications from EBANX for any changes in payment status.
Status
After receiving a notification that status has changed, retrieve the payment status.
When a payment is confirmed, the status will change from pending (PE) to confirmed (CO). If the customer does not complete the payment, the status will eventually change to cancelled (CA).
Congratulations!
You have succesfully integrated PagoEfectivo.
For more information, refer to theDirect API reference guidechevron_right
Resources
Use the following resources when testing in your sandbox environment.
Sample Cards
Click here to view mock card data to validate your payment integration.
API Reference
Click here to access detailed API documentation to integrate efficiently.
Mock Customer Data
Click here to view mock customer data for testing and validating user flows.
Error Codes
Click here to review common error codes to troubleshoot and resolve issues quickly.
Still need help?
We hope this article was helpful. If you still have questions, you can explore the following options:
- Merchant support: Contact our support team at sales.engineering@ebanx.com for assistance.
- Not a partner yet? Please complete the Merchant Signup Form, and our commercial team will reach out to you.