SafetyPay

SafetyPay is an alternative payment method supported by EBANX, designed to offer secure, real-time transactions across Latin America. It allows customers to make online purchases using bank transfers or cash payments without the need for credit or debit cards. By selecting SafetyPay, customers are redirected to their bank’s platform or a nearby payment location to complete the transaction, making it ideal for users who prefer secure and accessible payment options. This method is particularly popular in countries where traditional banking access is limited, providing merchants with a powerful tool to reach a broader audience through EBANX’s integrated platform.

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

• Select SafetyPay at checkout - Your customer chooses SafetyPay as their payment method during checkout.
• Generate payment code - EBANX creates a unique payment code or link associated with the transaction.
• Redirect customer - Your customer is redirected to their bank’s online banking platform or given details for an offline payment location.
• Complete payment - Your customer completes the payment via bank transfer or cash payment at an affiliated location.
• Confirm transaction - Once the payment is made, SafetyPay notifies EBANX, updating the transaction status so that you can fulfill the order.

Instructions

Follow the steps below.

1. 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.

   SandboxProduction

   https://sandbox.ebanx.com/ws/direct

2. Define your parameters

   With SafetyPay, customers are redirected to a secure third-party website to complete the payment quickly and safely. To obtain this redirection link, call the ws/direct endpoint with the required parameters.

   
   

   Defining API parameters

   You must provide required parameters for payment requests. These parameters ensure successful completion of transactions.
   
   

   Essential parameters

   • payment.payment_type_code - Specifies the payment method to be used for the transaction.
   • payment.currency_code - Three-letter code of the payment currency.
   • payment.amount_total - Total amount to be charged.

   
   

   Additional parameters

   • EBANX Integration Key - Used to authenticate and authorize API requests.
   • Customer Information
     • Includes details such as the customer name, email, address and document number (Depends on the requirements of the payment method or local regulations).
     • While not mandatory for all countries or payment methods, providing this information can enhance security and increase the likelihood of successful processing.
   • Additional Context - Extra data for specific methods or countries.

   
   

   To learn more about API parameters, please refer to the

   API Reference Guide chevron_right

   At the API Reference Guide, select Ecuador and Safety Pay from the dropdown menues.

3. 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": "josesilvaEcuador@example.com",
           "country": "ec",
           "payment_type_code": "safetypay-cash",
           "merchant_payment_code": "0x0W28D03-T14",
           "currency_code": "USD",
           "amount_total": "100"
       }
     }'

4. Sample response

   A successful request returns a response like the example below, with the third-party website link provided in the payment.redirect_url parameter.

   {
     "payment": {
       "hash": "5efccd9f520dfe822be625ededee0473db66a5b29c9bae03",
       "country": "ec",
       "merchant_payment_code": "0x0W28D03-T14",
       "order_number": null,
       "status": "PE",
       "status_date": null,
       "open_date": "2020-07-01 17:53:34",
       "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": "USD",
       "due_date": "2020-07-04",
       "instalments": "1",
       "payment_type_code": "safetypay-cash",
       "redirect_url": "https://sandbox.ebanx.com/ws/redirect/execute?hash=5efccd9f520dfe822be625ededee0473db66a5b29c9bae03",
       "pre_approved": false,
       "capture_available": null
     },
     "status": "SUCCESS",
     "redirect_url": "https://sandbox.ebanx.com/ws/redirect/execute?hash=5efccd9f520dfe822be625ededee0473db66a5b29c9bae03"
   }
   
   
   At this stage, the payment will appear as pending (PE) in your

   EBANX Dashboardchevron_right

5. Redirect customer to the returned URL

   Redirect your customer to the URL returned in the parameter redirect_url. After the redirection, your customer will be in a third-party website, with all the necessary purchase details to finalize their payment securely and easily.

   Testing SafetyPay in a sandbox environment

   In our Sandbox environment, we provide a SafetyPay simulation interface to test bank transfer payments. This mock interface allows you to simulate different payment outcomes:

   • Simulate Authorized = YES: Confirms the payment as successful.
   • Simulate Authorized = NO: Denies the payment.
   • Leave Pending: Leaves the payment in a pending state.

   This simulation mimics the real production flow, where users are redirected to their Internet Banking to complete transactions, enabling you to thoroughly test authorized and unauthorized payments.

   

6. 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.

   • Learn more about Payment Notificationschevron_right

   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).

   • Learn more about Retrieving Payment Statuschevron_right

7. Congratulations!

   You have succesfully integrated SafetyPay.

   For more information, refer to the

   Direct 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.

Click to explorechevron_right

API Reference

Click here to access detailed API documentation to integrate efficiently.

Click to explorechevron_right

Mock Customer Data

Click here to view mock customer data for testing and validating user flows.

Click to explorechevron_right

Error Codes

Click here to review common error codes to troubleshoot and resolve issues quickly.

Click to explorechevron_right

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.