Ebanx Local

This page provides a guide to integrate Ebanx Local with DEUNA.

Supported Operations

Ebanx integration in your payment strategy with DEUNA allows you to perform the following operations:

Authorization
Full Capture
Void
Purchase (auto-captured)
Partial refund (up to one per order)
Full refund
Installment

📘
Online multiple partial captures and refunds can be enabled through configuration. Contact DEUNA to activate these features if required

Active countries and currencies

Brazil, Chile, Colombia, and Mexico.

Requirements

Contact your Ebanx representative and request the following credentials:

Your Ebanx credentials

Make sure your account is properly configured on the Ebanx side.

Integrate Ebanx

Integrate Ebanx in DEUNA.

1. Look for Ebanx Local in DEUNA

Search for Ebanx in your DEUNA Admin.

2. Configure Ebanx in your store

After searching for Ebanx in Connections, you must configure Ebanx in your store.

In Connections, a window like the following will open:

Enter the following credentials:
- In Name enter a name to reference the credential.
- In Currency select the Currency of Merchant Processor available.
- In Private Key enter the Ebanx’s private key.
- In Public Key enter the Ebanx’s public key.
Click Connect.

Once you complete the steps, you will see a success message.

3. Process payments with Ebanx

You will see the Ebanx connection within the Active Connections tab.

From this point on, you can now process transactions with Ebanx through DEUNA.

V2 Purchase

{
    "payer_info": {
        "email": "[email protected]"
    },
    "order_type": "DEUNA_NOW",
    "payment_source": {
        "method_type": "credit_card",
        "card_info": {
            "expiry_month": "01",
            "expiry_year": "2029",
            "card_holder_dni": "",
            "card_holder": "Omar Guzhnay",
            "card_number": "4111115666052208",
            "card_cvv": "123",
            "address1": "Jose Luis Lagrange 123, Piso 12",
            "address2": "Polanco I Sección",
            "zip": "11510",
            "city": "MIGUEL HIDALGO",
            "state": "CIUDAD DE MÉXICO",
            "country": "MX",
            "phone": "+5930962917328",
            "installments": 1
        }
    },
    "order": {
        "order_id": "12c4f9bb-3128-4fb5-b99a-4e38569c69b5",
        "currency": "CRC",
        "statement_descriptor":"test",
        "market_type": "ecommerce",
        "items": [
            {
                "id": "00ab2d23-f44a-4782-aa7c-bb4fadeddfe3",
                "name": "Item #1",
                "description": "Description Item #1",
                "total_amount": {
                    "original_amount": 115000,
                    "amount": 115000,
                    "total_discount": 0,
                    "currency": "CRC",
                    "currency_symbol": "₡"
                },
                "unit_price": {
                    "amount": 100000,
                    "currency": "CRC",
                    "currency_symbol": "₡"
                },
                "tax_amount": {
                    "amount": 15000,
                    "currency": "CRC",
                    "currency_symbol": "₡"
                },
                "quantity": 1,
                "image_url": "https://cdn.prod.website-files.com/66269d6696cb4969aa25e070/662d847fb61e3145e2b2f640_Logo%20DEUNA.svg",
                "taxable": true
            },
            {
                "id": "3cb41aec-1be8-4255-a386-94bb316a8157",
                "name": "Item #2",
                "description": "Description Item #2",
                "total_amount": {
                    "original_amount": 115000,
                    "amount": 115000,
                    "total_discount": 0,
                    "currency": "CRC",
                    "currency_symbol": "₡"
                },
                "unit_price": {
                    "amount": 100000,
                    "currency": "CRC",
                    "currency_symbol": "₡"
                },
                "tax_amount": {
                    "amount": 15000,
                    "currency": "CRC",
                    "currency_symbol": "₡"
                },
                "quantity": 1,
                "image_url": "https://cdn.prod.website-files.com/66269d6696cb4969aa25e070/662d847fb61e3145e2b2f640_Logo%20DEUNA.svg",
                "taxable": true
            }
        ],
        "sub_total": 200000,
        "tax_amount": 30000,
        "total_tax_amount": 30000,
        "total_amount": 230000,
        "store_code": "all",
        "billing_address": {
            "id": "4255",
            "first_name": "Omar",
            "last_name": "Guzhnay",
            "email": "[email protected]",
            "address1": "Jose Luis Lagrange 123, Piso 12",
            "address2": "Polanco I Sección",
            "zipcode": "11510",
            "city": "MIGUEL HIDALGO",
            "state_code": "CDMX",
            "state_name": "CIUDAD DE MÉXICO",
            "country_code": "CR",
            "identity_document": "120597333",
            "identity_document_type": "",
            "phone": "+5930962917328",
            "lat": -22.943934,
            "lng": -43.182984,
            "additional_description": "confirm",
            "address_type": "home"
        }
    }
}

Request with installment plan options

{
    "transaction_id": "b54e3150-5fad-475d-892b-b13dbdbb99d4",
    "amount": 230009,
    "device_id": "f98c0141-dd96-4724-9e9a-c2c637307845",
    "order_token": "c000fbf0-2e86-4f4b-a1bb-223f80bbe477",
    "payer_info": {
        "email": "[email protected]"
    },
    "payment_source": {
        "method_type": "credit_card",
        "card_info": {
            "expiry_month": "01",
            "expiry_year": "2029",
            "card_holder_dni": "",
            "card_holder": "Omar Guzhnay",
            "card_number": "4111115666052208",
            "card_cvv": "123",
            "address1": "Jose Luis Lagrange 123, Piso 12",
            "address2": "Polanco I Sección",
            "zip": "11510",
            "city": "MIGUEL HIDALGO",
            "state": "CIUDAD DE MÉXICO",
            "country": "MX",
            "phone": "+5930962917328",
            "installment": {
                "plan_option_id": "6d8d4c4a-26c7-49a1-b92c-9fd89ea39323"
            }
            
        }
    }
}

Special considerations and limitations

Billing address

Domestic transactions acquired by Ebanx must include the following shopper information in the authorization request:

billing_address.zipcode
billing_address.state_name
billing_address.country_code

This follows the local regulation to withhold tax in the shopper's province. When this data is not supplied, Ebanx withholds taxes based on the merchant location.

Currency Code: Specifies the currency (ISO 4217) code for the relevant country.
Country Code: Specifies the ISO Country Codes
The number of installments is validated against the maximum number of installments agreed with the acquirer.
EBANX don't support patial capture.
A refund can be requested only after a payment reaches the CAPTURED status.
Refunds cannot exceed the original captured amount, but one or more partial refunds of the captured amount can be performed.
Only one partial refund can be sent per order.
A payment can be canceled (Void) only after it reaches the AUTHORIZED status.
Cancellation is no longer possible once the payment reaches the CAPTURED status.
Full cancel (void) can be sent per order.
The installments can be customized to offer a specific number of payments and can include interest-free options or charges defined by the merchant. How it Works:
1. The customer chooses the installments - Through the Get Installment API the customer will be able to obtain the available installment payment options.
  The response will include information such as the fees, the total amount with interest in case it applies, along with the installment value.
2. Payment processing through DEUNA - We process the payment with the respective installments directly with the PSP.