This guide describes potential errors during enrollment creation, payment scheduling, and payment retry.
Enrollment creation errors
As detailed in the Variable Enrollments and Fixed Enrollments sections, you can create a new enrollment by calling the ws/userenrollment API, or the ws/direct API if the enrollment is accompanied by an instant payment.
If your enrollment creation is unsuccessful, you may encounter the following errors:
| Code | Error Message | Description |
|---|---|---|
| BP-UE-03 | Field %field_name% is required for pix-automatico | The field mentioned in %field_name% is required and cannot be left null during enrollment creation. |
| BP-UE-06 | Field enrollment.country must be a valid country abbreviation | This field is mandatory and cannot be null during enrollment creation. It must contain a valid country abbreviation. |
| BP-UE-07 | Field payment_type_code is required | The field must be filled with "pix-automatico". |
| BP-UE-08 | Field payment_type_code must be valid | The field must be filled with "pix-automatico". |
| BP-UE-09 | The given payment_type_code is not enabled for this country | The field payment_type_code must be "pix-automatico" and country must be "BR". |
| BP-UE-10 | Payment type not enabled in full mode for merchant | Pix Automático payment type must be enabled in your EBANX Dashboard. |
| BP-UE-16 | This enrollment code already exists, please generate another enrollment code for the customer | merchant_enrollment_code must be unique. You cannot reuse the same enrollment code. |
| BP-UE-23 | Field enrollment.subscription.frequency is required | This field is required and cannot be left null during enrollment creation. Available frequencies: weekly, monthly, quarterly, semi-annual, annual. |
| BP-UE-24 | Field enrollment.subscription.start_date must be a future date | The start_date must be a future date, as it marks when the first payment in the subscription will be charged. It cannot be in the past. |
Payment schedule errors
After your customer authorized the enrollmrnt creation, scheduling a recurring payment is pretty simple and you can do it through our EBANX Direct API.
To make sure you will have a successful payment, avoid the errors below:
| Code | Error Message | Description |
|---|---|---|
| BP-DR-57 | Parameter is in an invalid format: due_date. Correct Format: dd/MM/yyyy | The expected billing date must follow the format DD/MM/YYYY. |
| BP-DR-58 | Invalid due_date for pix-automatico: max interval 10 days | The expected billing date must be between 2 and 10 days after the current date (DD/MM/YYYY). |
| BP-DR-59 | Invalid due_date for pix-automatico: min interval 2 days | The expected billing date must be between 2 and 10 days after the current date (DD/MM/YYYY). |
| BP-DR-60 | Max one payment per cycle | Only one payment can be scheduled per cycle. The cycle starts on the start_date and repeats based on the frequency defined during enrollment. |
| BP-DR-182 | Enrollment is not accepted, Cannot transact | This error occurs if the enrollment status is not accepted. Payments can only be created for active enrollments. |
Payment retry errors
Payment retries for Pix Automatico have strict rules that at this point you have already known: It is possible to request up to three retries within a seven-day window, with a maximum of one retry per day.
If one of this rules is violated, you may see the errors below:
| Code | Error Message | Description |
|---|---|---|
| BP-R-3 | Payment is not pending | Payments that are already confirmed (CO) or were cancelled (CA) can not be retried, only pending (PE) payments are allowed to be retried. |
| BP-R-4 | Payment is not eligible for retry | In the enrollment creation, the retry policy was configured to disallow retries, or the 7-day retry window has passed, making retries no longer possible |
| BP-R-5 | Payment was retried today | There is a maximum of one retry per day |
| BP-R-6 | Payment has no available retries | The maximum of three retries was reached |
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.