Ways to create an enrollment
An enrollment records a customer's authorization for recurring charges using a supported payment method. EBANX offers two ways to create an enrollment, depending on when you need to collect the first payment. Each one has its own guide:
Single Enrollment
Get the customer's authorization now and collect the first payment later.
Enrollment with First Payment
Create an enrollment and initiate the first payment in one request.
In both flows, the customer authorizes recurring payments during enrollment. Submit subsequent charges using the same merchant_enrollment_code, within the terms of that authorization. Each payment method supports one or both flows. See Payment method support.
Compare the flows
| Single Enrollment | Enrollment with First Payment | |
|---|---|---|
| Requests | /ws/userenrollment to create the enrollment, then /ws/direct for each charge | One /ws/direct request with the payment and the enrollment object |
| First payment | Sent by you after the enrollment is accepted | Initiated in the same request as the enrollment |
| Customer authorization | Authorizes the enrollment | Authorizes the enrollment, and the first payment is processed |
| Use when | The first charge happens later, or the amount is not known at sign-up | The customer pays at sign-up (first subscription cycle, first order) |
| Later charges | /ws/direct with the same merchant_enrollment_code | /ws/direct with the same merchant_enrollment_code |
Payment method support
| Payment method | Country | Single Enrollment | Enrollment with First Payment | Guide |
|---|---|---|---|---|
| Capitec Pay Recurring | South Africa | Yes | Yes (Charge after approval) | Capitec Pay Recurring |
| Card Recurring | India | Yes | Yes | Card Recurring |
| Maya Recurring | Philippines | No | Yes (Charge after approval) | Maya Recurring |
| Mercado Pago Connect | Multi-country | Yes | No | Mercado Pago Connect |
| Nequi Recurring | Colombia | Yes | Yes (Charge after approval) | Nequi Recurring |
| NuPay Recurring | Brazil | Yes | No | NuPay Recurring |
| Online Direct Debit | Thailand | Yes | No | Online Direct Debit |
| OPay Recurring | Nigeria | Yes | Yes (Single provider operation) | OPay Recurring |
| OVO Recurring | Indonesia | Yes | No | OVO Recurring |
| Pix Automático | Brazil | Yes (fixed and variable enrollments) | Yes, with an instant payment (Single provider operation) | Pix Automático |
| Pix on File | Brazil | Yes | No | Pix on File |
| UPI AutoPay | India | Yes (Collect) | Yes, with Intent or QR code (Single provider operation) | UPI AutoPay |
| Yape Recurring | Peru | Yes | Yes (Charge after approval) | Yape Recurring |
The guide of each payment method is the reference for its request fields, limits, and customer experience.
Resources
Use the following resources when testing in your sandbox environment.
API Reference
Click here to access detailed API documentation to integrate efficiently.
Mock Customer Data
Click here to view mock customer data for testing and validating user flows.
Error Codes
Click here to review common error codes to troubleshoot and resolve issues quickly.
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.
