EBANX
This page provides an overview of the payments methods provided by the EBANX adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating EBANX within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.
Payment Methods
| Payment Method | Transaction Flows | Transaction Types |
|---|---|---|
| Baloto | Full-Page Redirect | Debit & Refund |
| BancoDoBrasil | Full-Page Redirect | Debit & Refund |
| BankTransfer | Full-Page Redirect | Debit, Refund & Payout |
| Banrisul | Full-Page Redirect | Debit & Refund |
| Boleto | Full-Page Redirect | Debit & Refund |
| Bradesco | Full-Page Redirect | Debit & Refund |
| EbanxAccount | Full-Page Redirect | Debit & Refund |
| Eft | Full-Page Redirect | Debit & Refund |
| Itau | Full-Page Redirect | Debit & Refund |
| Multicaja | Full-Page Redirect | Debit & Refund |
| Oxxo | Full-Page Redirect | Debit & Refund |
| PagoEfectivo | Full-Page Redirect | Debit & Refund |
| PagosNet | Full-Page Redirect | Debit & Refund |
| SafetyPay | Full-Page Redirect | Debit & Refund |
| SafetyPayCash | Full-Page Redirect | Debit & Refund |
| SafetyPayOnline | Full-Page Redirect | Debit & Refund |
| Sencillito | Full-Page Redirect | Debit & Refund |
| Servipag | Full-Page Redirect | Debit & Refund |
| Spei | Full-Page Redirect | Debit & Refund |
| Webpay | Full-Page Redirect | Debit & Refund |
| Pix | Full-Page Redirect | Debit |
| PixAutomatico | Full-Page Redirect | Register, Debit (Initial Charge + Enrollment), Recurring Debit, Deregister |
| UPI | Full-Page Redirect | Debit |
| UPIAutopay | Full-Page Redirect | Debit (Enrollment), Recurring Debit, Deregister |
Refund is available for any completed debit on Pix, PixAutomatico, UPI & UPIAutopay — it targets the original EBANX payment hash directly and is not payment-method-specific.
Configuration
The EBANX (non-PCI) adapter is configured with a single credential field, labeled Integration Key. No password, API secret, or certificate is required.
Two additional configuration options are mandatory:
| Option | Values | Purpose |
|---|---|---|
| Default UPI Flow | UPI QR Code (upi-qrcode), UPI Intent (upi-intent) | Used for UPI Debit when the transaction doesn't specify extraData.psp:payment.payment_type_code |
| Default UPI Autopay Flow | UPI Autopay QR Code (upi-qrcode-autopay), UPI Autopay Intent (upi-intent-autopay) | Used for UPI Autopay flows when the transaction doesn't specify extraData.psp:payment.payment_type_code |
Additional Parameters
Debit: APM & BankTransfer
| Field | Required |
|---|---|
| customer.firstName | true |
| customer.lastName | true |
| customer.email | true |
| customer.billingPhone | false |
| customer.billingAddress1 | false |
| customer.billingCity | false |
| customer.billingPostcode | false |
| customer.billingState | false |
| customer.billingCountry | true |
Refund: APM & BankTransfer
| Field | Required |
|---|---|
| description | true |
Payout: BankTransfer
| Field | Required |
|---|---|
| customer.firstName | true |
| customer.lastName | true |
| customer.email | true |
| customer.birthDate | true |
| customer.iban | true |
| customer.bic | true for Brazil (=bank branch) |
| customer.billingCountry | true |
| customer.nationalId | true |
| customer.extraData.documentType | true |
| customer.extraData.bankDetails | true |
| customer.extraData.bankName | true |
| customer.extraData.termsAcceptedAt (format: YYYY-MM-DD HH:MM:SS) | Depending on EBANX business account |
Debit: Pix
The adapter does not validate these fields itself — it simply omits whatever is missing from the request. Refer to EBANX's own requirements for which of these are mandatory to process a payment.
| Field | Description |
|---|---|
| customer.firstName, customer.lastName | Combined into the payer's full name |
| customer.email | Payer email |
| customer.nationalId | Payer document/tax ID |
| customer.billingCountry | Payer country; used only if extraData.psp:subscription.country is not set |
| extraData.psp:subscription.country | Overrides customer.billingCountry for country resolution when set |
Register (Enrollment): PixAutomatico
| Field | Required |
|---|---|
| transactionId | true |
| customer.firstName | true |
| customer.lastName | true |
| customer.email | true |
| customer.nationalId | true |
| customer.billingCountry | false, unless extraData.psp:subscription.country is set |
| extraData.psp:subscription.country | false — overrides customer.billingCountry when set |
| extraData.psp:subscription.subscription_name | true (also accepts extraData.subscription.subscription_name) |
| extraData.psp:subscription.frequency | true (also accepts extraData.subscription.frequency) |
| extraData.psp:subscription.retry | true (also accepts extraData.subscription.retry) |
| extraData.psp:subscription.start_date | true (also accepts extraData.subscription.start_date) |
| extraData.psp:subscription.fixed_amount | one of fixed_amount or max_amount_floor is required |
| extraData.psp:subscription.max_amount_floor | one of fixed_amount or max_amount_floor is required |
| extraData.psp:subscription.expiration_date | false |
| extraData.psp:subscription.expiration_time_in_seconds | false — defaults to 3600 seconds |
Debit (Initial Charge + Enrollment): PixAutomatico
Triggered by sending the debit as "with register". Combines an initial charge with a Pix Automatico enrollment in a single request; accepts the same customer and subscription fields as Register (Enrollment): PixAutomatico above.
Recurring Debit: PixAutomatico
Charges an existing Pix Automatico enrollment.
| Field | Required |
|---|---|
| referencedTransaction | true — must reference the original enrollment transaction, whose transactionId is used as the merchant enrollment code |
| extraData.psp:payment.due_date | false |
Debit: UPI
Only extraData.psp:payment.payment_type_code is validated by the adapter (it must
resolve, directly or via the config fallback, to a supported value — otherwise the
transaction is rejected before calling EBANX). The customer fields below are not
validated by the adapter itself; refer to EBANX's own requirements for your target flow.
| Field | Required |
|---|---|
| extraData.psp:payment.payment_type_code | true, effectively — one of upi-qrcode / upi-intent; falls back to the "Default UPI Flow" configuration option if omitted, but the resolved value must be one of these two or the transaction is rejected |
| customer.firstName, customer.lastName | not adapter-validated — combined into the payer's full name |
| customer.email | not adapter-validated |
| customer.billingPhone | not adapter-validated |
| customer.billingAddress1 | not adapter-validated |
| customer.billingCity | not adapter-validated |
| customer.billingState | not adapter-validated |
| customer.billingPostcode | not adapter-validated |
| customer.billingCountry | not adapter-validated |
Debit (Enrollment): UPIAutopay
Triggered by sending the debit as "with register". Like plain UPI Debit, only
extraData.psp:payment.payment_type_code is validated by the adapter; the
customer/subscription fields below are not.
| Field | Required |
|---|---|
| extraData.psp:payment.payment_type_code | true, effectively — one of upi-qrcode-autopay / upi-intent-autopay; falls back to the "Default UPI Autopay Flow" configuration option if omitted, but the resolved value must be one of these two or the transaction is rejected |
| customer.firstName, customer.lastName | not adapter-validated — combined into the payer's full name |
| customer.email | not adapter-validated |
| customer.billingPhone | not adapter-validated |
| customer.billingAddress1 | not adapter-validated |
| customer.billingAddress2 | not adapter-validated — mapped to street_number |
| customer.billingCity | not adapter-validated |
| customer.billingState | not adapter-validated |
| customer.billingPostcode | not adapter-validated |
| customer.billingCountry | not adapter-validated |
| extraData.psp:subscription.subscription_name | not adapter-validated (also accepts extraData.subscription.subscription_name) |
| extraData.psp:subscription.expiration_date | not adapter-validated |
| extraData.psp:subscription.recurrence_value | not adapter-validated |
| extraData.psp:subscription.recurrence_rule | not adapter-validated |
| extraData.psp:subscription.min_amount | not adapter-validated |
| extraData.psp:subscription.max_amount | not adapter-validated |
Recurring Debit: UPIAutopay
Charges an existing UPI Autopay enrollment.
| Field | Required |
|---|---|
| referencedTransaction | true — must reference the original enrollment transaction, whose transactionId is used as the merchant enrollment code |
| extraData.psp:payment.payment_type_code | false — taken from the referenced enrollment transaction if not set on the recurring debit itself, otherwise falls back to the "Default UPI Autopay Flow" configuration option |
| extraData.psp:subscription.country | false — taken from the referenced enrollment transaction if not set, otherwise falls back to customer.billingCountry |
Deregister: PixAutomatico & UPIAutopay
Cancels an existing Pix Automatico or UPI Autopay enrollment.
| Field | Required |
|---|---|
| referencedTransaction | true — must reference the original enrollment transaction, whose transactionId is used as the enrollment ID to cancel |
Refund: Pix, PixAutomatico, UPI & UPIAutopay
Refunds an existing debit by its original EBANX payment hash. Available for any of these payment methods.
| Field | Required |
|---|---|
| description | true |
Options Request
You can find more information about the options request here: Options Request
Retrieving a list of available banks
EBANX supports 2 endpoints for retrieving a list of available banks for all supported countries. The results may be used for providing the correct parameters for the payout request.
They're available with the options request identifier getAvailableBanks and
getBankDetails.