Worldpay
Worldpay is a global payment service provider that offers gateway integrations for routing transactions to local payment processors. By integrating EBANX with Worldpay, merchants can process credit and debit card payments in Latin American markets through Worldpay's processing platform without building a direct EBANX integration.
This guide covers how to configure EBANX as a payment processor within Worldpay, the supported payment methods and countries, and the transaction flow.
Features
- Credit and debit card processing - Process Visa, Mastercard, Elo, Hipercard, Amex, and Diners with installment support across Latin American markets.
- 3D Secure support - Protect card transactions with 3DS authentication via EBANX.
- Installments - Support installment payments (up to 12 installments) for card transactions in supported countries.
- Refunds and cancellations - Manage full and partial refunds through Worldpay's standard transaction management.
Requirements
Before starting the integration, ensure you have the following:
- Worldpay account - An active Worldpay merchant account. If you do not have one, contact Worldpay.
- EBANX account - An active EBANX merchant account. Contact EBANX Sales to set up your account.
- EBANX credentials - Your EBANX Integration Key, provided by the EBANX integrations team during onboarding.
How it works
1 The customer initiates a purchase on the merchant's website or application.
2 The merchant sends a payment request to Worldpay's API with the desired payment method and EBANX-specific parameters.
3 Worldpay routes the transaction to EBANX for local processing in the target country.
4 EBANX processes the payment using local acquirers and payment networks.
5 EBANX returns the processing result to Worldpay.
6 Worldpay delivers the payment response to the merchant.
7 Worldpay sends a webhook notification to the merchant with the final payment status.
Supported payment methods
| Payment method | Countries | Currencies | Type |
|---|---|---|---|
| Visa | Brazil, Argentina | BRL, ARS | Credit / Debit card |
| Mastercard | Brazil, Argentina | BRL, ARS | Credit / Debit card |
| Elo | Brazil | BRL | Credit / Debit card |
| Hipercard | Brazil | BRL | Credit card |
| American Express | Brazil, Argentina | BRL, ARS | Credit card |
| Diners Club | Brazil, Argentina | BRL, ARS | Credit card |
The supported payment methods listed above reflect the current EBANX integration with Worldpay. Contact your EBANX account manager for the latest availability and to enable additional methods.
Key details
| Feature | Description |
|---|---|
| Integration type | Gateway — Worldpay routes transactions to EBANX for local processing |
| Supported operations | Charge, Capture (full and partial), Cancel, Refund (full and partial), Query |
| Pre-authorization | Supported — authorize first, then capture or void |
| Auto-capture | Supported |
| Installments | Up to 12 installments for card transactions |
| 3D Secure | Supported (redirect and external 3DS) |
| Card on File | Supported |
| Network tokens | Supported |
| Soft descriptor | Supported |
| Card verification (zero-dollar) | Supported |
Configuring EBANX with Worldpay
Follow the steps below to set up EBANX as a payment processor within Worldpay.
- Obtain EBANX credentials
Contact the EBANX integrations team to receive your credentials. You will need these to configure EBANX as a payment processor within Worldpay.
InfoEBANX provides separate credentials for sandbox and production environments. Use sandbox credentials for testing before going live.
- Configure EBANX in Worldpay
Work with your Worldpay account manager to add EBANX as a payment processor. Provide your EBANX credentials to Worldpay so they can configure the routing rules for Latin American transactions.
The configuration maps Worldpay's payment requests to EBANX's local processing capabilities. Once configured, Worldpay will route eligible transactions to EBANX based on the payment method, country, and currency.
- Submit a card payment
To process a card payment through Worldpay routed to EBANX, send a standard Worldpay payment request with the customer's card details and EBANX-specific parameters.
Required parameters
Parameter Requirement Description merchantCodeRequired Your Worldpay merchant code orderCodeRequired Unique order reference for the transaction amountRequired Transaction amount in minor units (cents) currencyCodeRequired ISO 4217 currency code ( BRL,ARS)cardNumberRequired Customer's card number expiryDateRequired Card expiration date (month/year) cardHolderNameRequired Name as printed on the card cvcRequired Card verification code EBANX-specific parameters
Parameter Requirement Description documentRequired (Brazil) Customer's tax document (CPF or CNPJ) instalmentsOptional Number of installments (1-12). Defaults to 1NoteFor Brazil, the customer document (CPF for individuals, CNPJ for companies) is mandatory. For Argentina, installment plans may vary based on the card issuer.
- Handle the response
Worldpay returns the transaction result synchronously. The response includes the payment status and authorization details.
Key response fields
Field Description lastEventTransaction status: AUTHORISED,CAPTURED,REFUSED,CANCELLED,SENT_FOR_REFUNDpaymentMethodCard scheme used (e.g., VISA_CREDIT-SSL,MASTERCARD_CREDIT-SSL)AuthorisationIdAuthorization code from the issuer amountConfirmed transaction amount - Capture the payment
If using pre-authorization (two-step payment), capture the authorized transaction through Worldpay's order modification API. Partial captures are supported.
CautionIf a pre-authorized payment is not captured or voided within the authorization window, it will expire automatically. Contact your EBANX account manager for authorization expiry details.
- Configure webhooks
Set up webhook notifications in Worldpay to receive asynchronous payment status updates. Worldpay sends notifications for events such as capture confirmation, refund completion, and chargeback alerts.
Refer to Worldpay's event webhooks documentation for webhook configuration details.
Testing
Use Worldpay's sandbox environment to test EBANX-routed transactions before going live.
| Environment | Description |
|---|---|
| Sandbox | Use Worldpay's test credentials and EBANX sandbox credentials to simulate transactions |
| Production | Use production credentials after successful sandbox testing and Worldpay approval |
Refer to Worldpay's testing documentation for sandbox test card numbers and expected responses.
Going live
Once you have completed sandbox testing:
- Request production credentials from both EBANX and Worldpay.
- Update the Worldpay configuration to use production EBANX credentials.
- Run a set of end-to-end tests in the production environment with small transaction amounts.
- Confirm successful transaction processing with your EBANX account manager.
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.