EBANX

Account Management: https://dashboard.ebanx.com

Default Currency: USD

Developer Documentation:
https://business.ebanx.com/en/integrations/ebanx-direct-api
https://developer.ebanx.com/docs/payments/guides/accept-payments/api/credit-cards
https://ebanx.github.io/api-reference/#tag/Direct-Payments

Gateway Endpoints
Production: https://api.ebanxpay.com/ws/
Test: https://sandbox.ebanxpay.com/ws/

Supported Parameters:
^{Type column indicates max length}

Field Name	Type	Direct API Mapping	Notes
gateway	string	N/A	EBANX
testMode	boolean	N/A	True = EBANX Sandbox, False = EBANX Production
integrationKey	string(100)	integration_key	EBANX unique and secret Integration Key
mode	string(4)	mode	Defaults to "full" if left blank on Authorize/Purchase operations.
operation	string(7)	operation	Used in Authorize, Purchase, and Refund. Defaults to "request" if left blank.
tokenExTransactionCode	string	N/A	Used for processing capture, refund, or void operations
merchantCaptureCode	string(200)	merchant_capture_code	Optional identifier for the payment capture.
merchantRefundCode	string(40)	merchant_refund_code	The ID of the refund on the merchant system.
description	string(500)	description	Brief summary of the operation. Used in Refund.
refundId	string(20)	refund_id	The ID of the refund to be canceled
items	[ ]	payment.items	Array containing the items of the order
items.Sku	string(20)	payment.items.sku	SKU of the item
items.Name	string(100)	payment.items.name	Name of the item
items.Description	string(200)	payment.items.description	Description of the item
items.UnitPrice	numeric	payment.items.unit_price	Smallest values of currency specified by CurrencyCode. Converted to format of CurrencyCode. Example for USD: input 1000 for an output of $10.00.
items.Quantity	numeric	payment.items.quantity	Quantity of each item
items.Type	string(50)	payment.items.type	Type of the item
document	string(32)	payment.document	Customer identification document number
merchantPaymentCode	string(128)	payment.merchant_payment_code	The payment hash Merchant Payment Code (unique merchant ID).
userValue1	string(20)	payment.user_value_1	Parameter that can be used by the merchant to associate additional info to the payment.
userValue2	string(20)	payment.user_value_2	Parameter that can be used by the merchant to associate additional info to the payment.
userValue3	string(20)	payment.user_value_3	Parameter that can be used by the merchant to associate additional info to the payment.
userValue4	string(20)	payment.user_value_4	Parameter that can be used by the merchant to associate additional info to the payment.
userValue5	string(20)	payment.user_value_5	Parameter that can be used by the merchant to associate additional info to the payment.
paymentTypeCode	string	payment.payment_type_code	The code of the payment method.
amount	numeric	payment.amount_total	Smallest values of currency specified by CurrencyCode. Converted to format of CurrencyCode. Example for USD: input 1000 for an output of $10.00.
currencyCode	string(3)	payment.currency_code	Use the ISO 4217 three-letter alphabetic code for the currency.
dueDate	string(10)	payment.due_date	The due date of payment slips
installments	numeric	payment.installments	The number of installments of the payment. Defaults to 1
note	string(200)	payment.note	A note about the payment. The value of this parameter will be shown along with payment details.
subAccountName	string(32)	payment.sub_account.name	Name of the sub account
subAccountImageUrl	string(200)	payment.sub_account.image_url	HTTPS URL of the logo of the sub-account
eftCode	string(32)	payment.eft_code	Code for the customer’s bank. Only required for Colombia payments
notificationUrl	string(2000)	payment.notification_url	The URL to send notifications for this payment. If this field is filled, EBANX will notify using this URL instead of the configured one.
redirectUrl	string(2000)	payment.redirect_url	The URL to redirect the customer after the payment in the EBANX Payment Page. If this field is filled, EBANX will redirect the customer using this URL instead of the configured one.
personType	string(8)	payment.person_type	Optional parameter that can be used to identify the type of customer: "business" or "personal"
responsibleName	string(100)	payment.responsible.name	Responsible name. Required if person_type = business.
customerIpAddress	string	payment.customer_ip	Customer’s IP address. It may be used by an anti-fraud tool.
deviceId	string(200)	payment.device_id	Unique ID to identify the customer’s device. Used for anti-fraud checking purposes.
billingAddress.FullName	string	payment.name	If left empty, this field's default value will be populated from billingAddress.FirstName + billingAddress.LastName. Sum of both fields cannot be greater than 50 characters
billingAddress.FirstName	string	payment.name	Combined with BillingAddress.LastName to be "{FirstName} {LastName}". Sum of both fields cannot be greater than 50 characters
billingAddress.LastName	string	payment.name	Combined with BillingAddress.FirstName to be "{FirstName} {LastName}". Sum of both fields cannot be greater than 50 characters
billingAddress.Address1	string(30)	payment.street_number	Customer street number.
billingAddress.Address2	string(100)	payment.address	Customer address (street name)
billingAddress.StreetComplement	string(100)	payment.street_complement	Extra address field for complimentary data.
billingAddress.City	string(80)	payment.city	Customer city.
billingAddress.State	string	payment.state	Customer state/region/province
billingAddress.Country	string	payment.country	Customer country. Input Alpha 3. Converted to Alpha 2.
billingAddress.Zip	string(8)	payment.zipcode	Customer zip code
billingAddress.Email	string(100)	payment.email	Customer email address
billingAddress.Phone	string(15)	payment.phone_number	Customer phone number
creditCard	object	payment.card	Use for either credit or debit card transactions
creditCard.Number	string	payment.card.card_number	Card number or TokenEx Token - Tokenex will replace the Token with the Detokenized number
creditCard.CVV	string	payment.card.card_cvv	Card security code.
creditCard.FirstName	string	payment.card.card_name	Combined with CreditCard.LastName to be "{FirstName} {LastName}". Sum of both fields cannot be greater than 50 characters
creditCard.LastName	string	payment.card.card_name	Combined with CreditCard.FirstName to be "{FirstName} {LastName}". Sum of both fields cannot be greater than 50 characters
creditCard.ExpMonth	numeric	payment.card.card_due_date	MM. Combined with CreditCard.ExpYear to equal MM/YYYY
creditCard.ExpYear	numeric	payment.card.card_due_date	YYYY. Combined withe CreditCard.ExpMonth to equal MM/YYYY
creditCard.EBANXToken	string(128)	payment.card.token	EBANX token used for recurring billing.
threeDSecure.ECI	string	payment.card.threeds_eci	Electronic Commerce Indicator
threeDSecure.CAVV	string	payment.card.threeds_cryptogram	Cardholder Authentication Verification Value
threeDSecure.XID	string	payment.card.threeds_xid	Unique transaction Identification number to identify the 3DS transaction
threeDSecure.ThreeDSecureVersion	string	payment.card.threeds_version	3DS Version
threeDSecure.DSTransId	string	payment.card.threeds_trxid	Directory Server Transaction ID
createEBANXToken	boolean	payment.create_token	Generates a token for recurring billing.

Example Payloads:

{
    "gateway": "EBANX",
    "testMode": true,
    "integrationKey": "<Your EBANX Integration Key>",
    "merchantPaymentCode": "ABC00001",
    "document": "853.513.468-93",
    "creditCard": {
        "firstName": "José",
        "lastName": "Silva",
        "number": "378282246310005",
        "cvv": "123",
        "expMonth": 6,
        "expYear": 2023
    },
    "billingAddress": {
        "firstName": "José",
        "lastName": "Silva",
        "address1": "1040",
        "address2": "Rua teste",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "zip": "61919",
        "country": "BRA",
        "phone": "8522847035",
        "email": "[email protected]"
    },
    "Amount": 1000,
    "CurrencyCode": "BRL"
}

{
    "gateway": "EBANX",
    "testMode": true,
    "integrationKey": "<Your EBANX Integration Key>",
    "merchantCaptureCode": "ABC00001",
    "tokenExTransactionCode": "<TokenExTransactionCode from a previous Authorize call>",
    "amount": 1000
}

{
    "gateway": "EBANX",
    "testMode": true,
    "integrationKey": "<Your EBANX Integration Key>",
    "amount": 1000,
    "description": "water damage",
    "merchantRefundCode": "ABC00001",
    "tokenExTransactionCode": "<TokenExTransactionCode from a previous Authorize/Purchase call>"
}

{
    "gateway": "EBANX",
    "testMode": true,
    "integrationKey": "<Your EBANX Integration Key>",
    "tokenExTransactionCode": "<TokenExTransactionCode from a previous Authorize/Purchase call>"
}

Gateway Response Fields:

Field Name	Type	Direct API Mapping	Notes
approved	boolean	N/A	If EBANX returns an authcode, this field will be true.
approvalCode	string(40)	authcode	Transaction authentication code from the processor.
providerTransactionCode	string	hash	The payment hash (EBANX unique identifier).