Single Enrollment

Use Single Enrollment to obtain the customer's authorization before collecting the first payment. This flow is suitable when billing starts later or the initial amount is not yet known. To initiate the first payment in the same request, see Enrollment with First Payment. For a comparison, see Ways to create an enrollment.

Requirements

• API authentication - All API requests must be authenticated using JWS (JSON Web Signature). The legacy integration_key is being deprecated — if you still use it, follow the Migration Guide to transition to JWS. If you don't have credentials yet, complete the Merchant Signup Form.
• Familiarity with EBANX Direct - See the Direct API reference for details.
• Notification URL - Configure your Notification URL in the Merchant Area to receive payment and enrollment notifications. See Notifications.
• Recurring payment method enabled - The payment method must be enabled for your account. Contact your EBANX Integration Specialist.

How it works

1. Create the enrollment - Call /ws/userenrollment with a new merchant_enrollment_code and the enrollment fields of the payment method.
2. The customer authorizes recurring payments - Depending on the payment method, the customer authorizes the enrollment in the provider's app or on a redirect page returned in the response. The enrollment starts as pending.
3. Receive enrollment status updates - EBANX sends an enrollment notification when the enrollment status changes.
4. Submit the first and subsequent payments - After the enrollment is accepted, send /ws/direct requests that reference the same merchant_enrollment_code. Each charge uses the existing authorization.

Payment method support

Payment method	Country	Guide
Capitec Pay Recurring	South Africa	Capitec Pay Recurring
Card Recurring	India	Card Recurring
Mercado Pago Connect	Multi-country	Mercado Pago Connect
Nequi Recurring	Colombia	Nequi Recurring
NuPay Recurring	Brazil	NuPay Recurring
Online Direct Debit	Thailand	Online Direct Debit
OPay Recurring	Nigeria	OPay Recurring
OVO Recurring	Indonesia	OVO Recurring
Pix Automático (fixed and variable enrollments)	Brazil	Pix Automático
Pix on File	Brazil	Pix on File
UPI AutoPay (Collect)	India	UPI AutoPay
Yape Recurring	Peru	Yape Recurring

The guide of each payment method is the reference for its request fields, limits, and customer experience.

Compare requests by payment method

Select two payment methods to see their enrollment requests and responses side by side. The lines that differ are highlighted.

Select an API Payload

Select a reference payment type

A code example for this payment method will be available soon.

Select a payment type to compare

A code example for this payment method will be available soon.

Notifications

Use the payment notification to update the order and the enrollment notification to update the subscription. You can also query both statuses with /ws/userenrollments/query and /ws/query. Do not charge later payments until the enrollment is accepted.

For more information, refer to the

Payment Notificationschevron_right

For more information, refer to the

Enrollment Notificationschevron_right

Resources

Use the following resources when testing in your sandbox environment.

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.