Efecty

Efecty is a popular cash-based payment method in Colombia, enabling customers to pay for online purchases at physical Efecty locations nationwide. Integrating Efecty with EBANX allows you to cater to a broader customer base, especially those who prefer or rely on cash transactions. This integration enables you to offer a convenient cash payment method for Colombian customers, expanding reach and increasing conversion rates.

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

• Customer chooses Efecty - At checkout, your customer selects Efecty as the payment option.
• Voucher generation - EBANX generates a voucher containing payment details, which the customer uses to make the payment at an Efecty location. The voucher is created by making a server-side call to the ws/direct endpoint, providing the necessary fields to generate the voucher URL.
• Voucher display - Once the voucher is generated, you redirect the customer to a page displaying the voucher, which includes the payment instructions, barcode, and other necessary details.
• Customer makes payment - The customer prints or saves the voucher and visits any Efecty location to complete the payment in cash. The payment is confirmed once Efecty processes the transaction, typically within 1-2 business days.
• Payment confirmation - EBANX receives payment confirmation from Efecty and triggers a status update via webhook to your notification URL.
• Order fulfillment - Once the payment status is confirmed as successful, you can proceed to fulfill your customer's 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

   Efecty operates as a voucher-based payment method, requiring customers to be redirected to a page displaying the voucher details. 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 Colombia and Efecty 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": "josecolombia@example.com",
           "country": "co",
           "payment_type_code": "efecty",  // Set to 'efecty'.
           "merchant_payment_code": "0x0W28D03-T88",
           "currency_code": "COP",
           "amount_total": "10000"
       }
     }'

4. Sample response

   A successful request returns a response like the example below, with the third-party website link provided in payment.efecty_url, and the voucher number in payment.voucher_id.

   {
     "payment": {
       "hash": "5f36ebe4957afdfa5fb0fc193b540a512dc13f8615eba22c",
       "country": "co",
       "merchant_payment_code": "0x0W28D03-T88",
       "order_number": null,
       "status": "PE",
       "status_date": null,
       "open_date": "2020-08-14 19:54:11",
       "confirm_date": null,
       "transfer_date": null,
       "amount_br": "10000.00",
       "amount_ext": "10000.00",
       "amount_iof": "0.00",
       "amount_ext_requested": "10000.00",
       "currency_rate": "1.0000",
       "currency_ext": "COP",
       "due_date": "2021-12-27",
       "instalments": "1",
       "payment_type_code": "efecty",
       "voucher_url": "https://sandbox.ebanxpay.com/print/voucher/execute?hash=5f36ebe4957afdfa5fb0fc193b540a512dc13f8615eba22c",
       "pre_approved": false,
       "capture_available": null
     },
     "status": "SUCCESS"
   }
   
   
   At this stage, the payment will appear as pending (PE) in your

   EBANX Dashboardchevron_right

5. Redirect customer to the returned URL

   Redirect the customer to the URL provided in the efecty_url parameter. This URL will display an interface similar to the one shown below:

   
   
   
   Direct Voucher Delivery

   Alternatively, you can provide the voucher number directly to your customers for their convenience.

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

   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.