This page's content:

Don’t waste your time (or money) with error codes When an API call fails, EBANX will return a JSON object containing the error details below:

That way, you confirm where the error is and can correct quickly. Observe the following table and verify the “status_code” that appears, besides the error messages (“status_message”) that EBANX uses, with a brief description of it.

Payments

Error code Error message Description
BP-R-1 Parameter is required: currency_code The field was not filled.
BP-R-2 Parameter is required: amount The field was not filled.
BP-R-3 Parameter is required: merchant_payment_code The field was not filled.
BP-R-6 Parameter payment_type_code not informed The field was not filled.
BP-R-7 Payment type is not active The payment type is not enabled on your account. Contact our Integration Team.
BP-R-8 Invalid payment_type_code The parameter sent was not valid.
BP-R-9 Amount must be positive: X The amount is being sent if a minus(-). Check your request.
BP-R-10 Amount must be greater than X The amount is too low.
BP-R-11 Payment type does not support instalments You are trying to apply instalment on a payment type which not support it. For example: boleto.
BP-R-14 Parameter merchant_payment_code can have 20 characters maximum The parameter has more characters than the limit allowed.
BP-R-15 Parameter order_number can have 40 characters maximum The parameter has more characters than the limit allowed.
BP-R-16 Parameter user_value_1 can have 20 characters maximum The parameter has more characters than the limit allowed.
BP-R-16 Parameter user_value_2 can have 20 characters maximum The parameter has more characters than the limit allowed.
BP-R-16 Parameter user_value_3 can have 20 characters maximum The parameter has more characters than the limit allowed.
BP-R-16 Parameter user_value_4 can have 20 characters maximum The parameter has more characters than the limit allowed.
BP-R-16 Parameter user_value_5 can have 20 characters maximum The parameter has more characters than the limit allowed.
BP-R-17 Payment status is not OP (open): X This payment does not have the OP status.
BP-R-18 Parameter is invalid: person_type The parameter sent was not valid.
BP-R-19 Checkout by CNPJ is not enabled Checkout by CNPJ is not enabled on your account. Contact our Integration Team if you want to change it.
BP-R-20 Parameter is in an invalid format: due_date. Correct Format: dd/MM/yyyy The parameter sent was not valid.
BP-R-21 Parameter is invalid: due_date – exceeds more than X days The parameter sent was not valid.
BP-R-22 Parameter is invalid: due_date – less than permitted The parameter sent was not valid.
BP-R-24 Parameter is required: country The field was not filled.
BP-R-25 Country is not enabled The country that you are trying to make a payment is not enabled. Contact our Integration Team.
BP-R-26 Country is not enabled for merchant The country that you are trying to make a payment is not enabled on your account. Contact our Integration Team.
BP-R-27 Payment type is not enabled for merchant The payment type that you are trying to make a payment is not enabled. Contact our Integration Team.
BP-R-32 Amount must be less than X The amount is too high.

Cards

Error code Error message Description
BP-R-12 Instalments are limited to a quantity of X. Value provided: X The number of instalment is not with the right value.
BP-R-13 The amount of each instalments must be greater than or equal to R$ X. Value calculated: R$ X / X = X Instalments have configured limits for minimum instalment value and maximum quantity of instalments.
BP-R-28 The amount of instalments is larger than the maximum allowed for merchant The number of instalments that you are using is bigger than what is allowed. Contact our Integration Team.
BP-R-29 Invalid value for instalments You are not sending a correct parameter, check your request.
BP-R-30 The amount of instalments is not allowed – blocked values are: {payment.api.instalments.blocked} The number of instalments that you are trying to send is not allowed. Contact our Integration Team.

Customer

Error code Error message Description
BP-R-4 Parameter is required: name The field was not filled.
BP-R-5 Parameter is required: email The field was not filled.

General

Error code Error message Description
BP-R-23 Currency is not active in the system: X The currency that you are trying to use is not enabled.
BP-R-31 Invalid notification_url The field notification_url contains an invalid URL.
BP-R-34 You have reached the limit of your processing trial. Make sure you send the documents to unlock this limit or send an email to your business manager. Your account have a limit of how much it could process and you have reached that limit. You must upload your documents (Dashboard) to continue processing payments, or, talk with your business manager
RP-1 Request body is empty The request body is empty. Check your code.
RP-2 Invalid JSON expression: too deep Check your JSON expression.
RP-3 Invalid JSON expression – invalid or malformed Check your JSON expression.
RP-4 Invalid JSON expression – unexpected control character found (likely encoding error) Check your JSON expression.
RP-5 Invalid JSON expression – syntax error Check your JSON expression.
RP-6 Invalid JSON expression – bad UTF-8 characters (likely encoding error) Check your JSON expression.
RP-7 Invalid JSON expression – unknown error Check your JSON expression.
RP-8 Field integration_key is required The field was not filled.
RF-1 Payment already exists with payment_type_code There can be only one payment in the system with the same merchant payment code.