Enrollments
The Enrollments page in the Merchant Area lists the enrollments your customers created to authorize recurring payments. Use it to find an enrollment, check its status and subscription, see the payments charged under it, and export the list to CSV.
This page describes how to access the Enrollments page, filter and export the list, and read the details of an enrollment. The Enrollments pages are view-only: you cannot change or cancel enrollments in the Merchant Area. To cancel an enrollment, use the Cancel an enrollment API.
Accessing Enrollments
In the Merchant Area, select Transactions > Enrollments in the left sidebar. You can also open the page from the Enrollments shortcut on the home page.
The Enrollments page is available only when it is enabled for your account, and only to users whose permission template includes read access to Enrollments. If you do not see the page, contact your EBANX representative or the administrator of your Merchant Area account.
Enrollments list
The list opens on the enrollments of the last 30 days, sorted by start date with the most recent first. Each row shows the following columns:
| Column | Description |
|---|---|
| Country | Country where the enrollment was created. |
| Enrollment code | Unique code of the enrollment. Select it to open the enrollment details. |
| Subscription | Name of the subscription the enrollment belongs to. |
| Method | Payment method of the enrollment. |
| Max amount | Maximum amount that can be charged under the enrollment. |
| Status | Current status of the enrollment. See Enrollment statuses. |
| Customer name | Name of the customer who created the enrollment. |
| Start date | Date the enrollment starts. |
| End date | Date the enrollment ends. |
Select the header of the Enrollment code, Subscription, Max amount, Status, or Start date column to sort the list by that column. Select it again to reverse the order.
Use the controls below the list to move between pages and to choose how many rows to display per page: 10, 25, or 50. The total number of enrollments found is displayed next to the pagination.
Filtering enrollments
Use the filter bar above the list to narrow down the enrollments displayed.
| Filter | Description |
|---|---|
| Search | Search by Enrollment code, Subscription, or Customer name. Select the field, type the term, and select Search. |
| Date range | Period of the enrollments to display. The default period is the last 30 days. The period can cover up to 31 days. |
| Status | One or more enrollment statuses. |
| Method | One or more payment methods. The options list only the methods that appear in your enrollments. |
Exporting enrollments
Select Export > to CSV to download the enrollments that match the current filters. The CSV file has the same columns as the list.
| Number of enrollments | How you receive the file |
|---|---|
| Up to 10,000 | The file is downloaded immediately. |
| From 10,001 to 100,000 | The file is generated in the background and sent to your email. |
| More than 100,000 | The export is not generated. Narrow the date range or the filters and try again. |
The export uses the same period limit as the list: the date range can cover up to 31 days.
Enrollment statuses
| Status | Description |
|---|---|
| Pending | The enrollment was created and is waiting for the customer authorization. |
| Accepted | The customer authorized the enrollment. Payments can be charged under it. |
| Paused | The enrollment is paused. |
| Not accepted | The enrollment was not authorized. This is a final status. |
| Revoked | The enrollment was revoked. This is a final status. |
| Cancelled | The enrollment was canceled by the merchant, the customer, or EBANX. This is a final status. |
| Expired | The enrollment reached its expiration. This is a final status. |
| Not found | The enrollment was not found at the provider. This is a final status. |
To receive enrollment status changes in your system, see Enrollment Notification.
Enrollment details
Select an enrollment code in the list to open its details. The page shows the following sections.
Header
The header shows the enrollment code, with a button to copy it, and the Status, Method, Customer name, and Country of the enrollment.
If the enrollment is not in a final status, select Get current status to request the latest status from the provider. When the status changes, the page updates the status and the status history.
Reason banner
When the provider reports a reason for the current status, a banner explains what happened, suggests the next step, and shows who requested the change: the merchant, the customer, or EBANX. The banner is red for final statuses and yellow for the other statuses. For the reason codes returned by the API, see Enrollment Cancel Reasons.
| Reason | What happened | Suggested next step |
|---|---|---|
| Enrollment rejected by the customer | The customer declined the enrollment authorization in the bank app. | Ask the customer to start a new enrollment and approve it in the bank app. |
| Authorization failed | The external service authorization failed. | Ask the customer to try again or to use a different payment method. |
| Bank validation issue | Something went wrong while the bank validated the customer data. | Ask the customer to check the data with the bank and start a new enrollment. |
| Instant payment not confirmed | The bank did not confirm the instant payment used to validate the enrollment. | Ask the customer to start a new enrollment and complete the validation payment. |
| Customer account closed | The customer bank account is closed or blocked. | Ask the customer to enroll with another account. |
| Merchant company closed | The enrollment was revoked because the merchant company was closed. | Contact EBANX support if this is unexpected. |
| Payer deceased | The bank reported the payer as deceased. | No further charges can be made for this enrollment. |
| Enrollment confirmation failed | The customer bank could not confirm the enrollment. | Ask the customer to start a new enrollment. |
| Canceled for fraud prevention | The customer bank canceled the enrollment due to fraud prevention. | Ask the customer to contact the bank before enrolling again. |
| Duplicated enrollment | The enrollment was already confirmed in another journey. | Use the enrollment that was confirmed for this customer. |
| Canceled by the merchant | The merchant requested the enrollment cancellation. | Ask the customer to enroll again to keep charging this subscription. |
| Canceled by the customer | The customer requested the enrollment cancellation. | Ask the customer to enroll again to keep charging this subscription. |
| Canceled by EBANX | EBANX canceled the enrollment. | Contact EBANX support for details. |
Subscription
Shows the subscription the enrollment belongs to: Name, Frequency, Currency, Min amount, Max amount, Start date, End date, and Next due date.
Status history
Lists the status changes of the enrollment, with the date of each change and, when available, the reason code. The 10 most recent changes are displayed; select Show all to see the complete history.
Linked payments
Lists the payments charged under the enrollment, with Payment hash, Order number, Amount, Currency, Status, Created at, and Charge cycle. Select a payment hash to open the payment details.
The 5 most recent payments are displayed. When there are more, select See all to open the Payments page filtered by the enrollment code.
Technical details
Select Technical details to expand additional information returned by the provider, such as the payer bank, the provider, the mandate ID, and the retry strategy. The fields displayed depend on the payment method.
Enrollment on the payment details
When a payment was charged under an enrollment, its payment details page in the Merchant Area shows an Enrollment card with the Enrollment code, Status, Subscription, Method, and Customer of the enrollment. Select the enrollment code to open the enrollment details, and select Back to payment to return to the payment. When you open a payment from the enrollment details, select Back to enrollment to return to the enrollment.
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.
