When an API call fails, EBANX will return a JSON object containing the error details:

{
  "status": "ERROR",
  "status_code": "BP-SA-1",
  "status_message": "Parameter integration_key not informed"
}

Below you will find all the error codes and error messages EBANX uses, along with a brief description of it.

Error codeError messageDescription
BP-CH-1Payment type group is not active: {group_code}Some payment method is not enable. Contact our Integration Team.
BP-DR-0Payment already exists with merchant_payment_code: X (created on X, status is X)There can be only one payment in the system with the same merchant payment code.
BP-DR-1Mode must be either full or iframeCheck direct API available modes.
BP-DR-2Field payment is requiredThe field was not filled.
BP-DR-3Field payment.currency_code is requiredThe field was not filled.
BP-DR-4Currency is not active in the system: XEBANX currently does not support the currency.
BP-DR-5Field payment.amount_total is requiredThe field was not filled.
BP-DR-6Amount reported is less than the minimum amountThe payment amount is too low.
BP-DR-7Amount must be less than XThe payment amount is too high.
BP-DR-8If passed, amount_itens + amount_shipping must be equal to amount_totalThe amount sent was not right.
BP-DR-9Field payment.merchant_payment_code is requiredThe field was not filled.
BP-DR-10Parameter merchant_payment_code can have 40 characters maximumThe parameter has more characters than the limit allowed.
BP-DR-11Parameter payment.order_number can have 40 characters maximumThe parameter has more characters than the limit allowed.
BP-DR-12Parameter X can have 20 characters maximumThe parameter has more characters than the limit allowed.
BP-DR-13Field payment.name is requiredThe field was not filled.
BP-DR-14Parameter payment.name can have 100 characters maximumThe parameter has more characters than the limit allowed.
BP-DR-15Field payment.email is requiredThe field was not filled.
BP-DR-16Parameter payment.email can have 100 characters maximumThe parameter has more caracters than the limit allowed.
BP-DR-17Field payment.email must be a valid emailThe e-mail sent was not valid.
BP-DR-18Customer is disabled on EBANXCustomer is suspended on EBANX. If unexpected, please contact EBANX Support Team.
BP-DR-19Field payment.birth_date is requiredThe filed was not filled.
BP-DR-20Field payment.birth_date must be a valid birth date (dd/MM/yyyy)The birth date sent was not valid.
BP-DR-21Customer must be at least 16 years oldThe customer has not the age required.
BP-DR-22Field payment.document is requiredThe field was not filled.
BP-DR-23Field payment.document must be a valid {document}Documents per country list:
  • Brazil: CPF
  • Mexico: RUC
BP-DR-24Field payment.zipcode is requiredThis is the CEP (postal address code).
BP-DR-25Field payment.address is requiredThe field was not filled.
BP-DR-26Field payment.street_number is requiredThe field was not filled.
BP-DR-27Field payment.city is requiredThe field was not filled.
BP-DR-28Field payment.state is requiredThe field was not filled.
BP-DR-29Field payment.state must be a valid state codeFor a list of Brazilian state codes, refer to: http://en.wikipedia.org/wiki/States_of_Brazil
BP-DR-30Field payment.country must be ‘br’The parameter “country” must be ‘br'(Brazil).
BP-DR-31Field payment.phone_number is requiredThe field was not filled.
BP-DR-32Parameter payment.phone_number must be a valid phone numberThe parameter sent was not valid.
BP-DR-33Invalid value for instalments: X (single value)The parameter sent was not valid.
BP-DR-34Invalid value for instalments: X (range)The parameter sent was not valid.
BP-DR-35Invalid payment_type_code: XThe payment method is not enable. Contact our Integration Team.
BP-DR-36Payment type is not activeThe payment method is not enable. Contact our Integration Team.
BP-DR-38Payment type not allowed in Direct API (full mode): XNot all payment types are allowed in full mode, please refer to documentation.
BP-DR-39CPF, name and birth date do not match: XEBANX checks if the CPF belongs to the person making the payment, matching the name and the date of birth.
BP-DR-40Customer reached payment limit: XCustomer reached the payment limit for the period.
BP-DR-41Field payment.person_type must contain a valid person_typeThe parameter sent was not valid.
BP-DR-42Field payment.responsible is requiredThe field was not filled.
BP-DR-43Field payment.responsible.name is requiredThe field was not filled.
BP-DR-44Field payment.responsible.document is requiredThe field was not filled.
BP-DR-45Field payment.responsible.birth_date is requiredThe field was not filled.
BP-DR-46Company responsible’s CPF, name and birth date do not match: (.*)Some parameters are not matched.
BP-DR-47Parameter payment.directdebit.bank_account can have 10 characters maximumThe parameter has more characters than the limit allowed.
BP-DR-48Field payment.creditcard is required for this payment typeThe field was not filled.
BP-DR-49Field payment.creditcard.card_number is requiredThe field was not filled.
BP-DR-50Payment type not allowed in Direct API (full mode): {payment_type_code}The payment method is not allowed. Contact our Integration Team.
BP-DR-51Field payment.creditcard.card_name is requiredThe field was not filled.
BP-DR-52Parameter payment.creditcard.card_name can have 50 characters maximumThe parameter has more characters than the limit allowed.
BP-DR-54Field payment.creditcard.card_cvv is requiredThe field was not filled.
BP-DR-55Parameter payment.creditcard.card_cvv can have 4 characters maximumThe parameter has more characters than the limit allowed.
BP-DR-56Field payment.creditcard.card_due_date is requiredThe field was not filled
BP-DR-57Parameter is in an invalid format: due_date. Correct Format: dd/MM/yyyyThe parameter was not sent on the right format.
BP-DR-58Parameter is invalid: due_date – exceeds more than {days} daysThe parameter ‘due_date’ exceeds the numbers of days that is in the configuration.
BP-DR-59Parameter is invalid: due_date – less than permittedThe parameter ‘due_date’ is too short.
BP-DR-61It was not possible to create the token for this credit cardIt was not possible to complete the operation. You can learn more about it HERE.
BP-DR-62Recurring payments are not enabled for this merchantRecurring payment is not allowed on your account. Contact our Integration Team.
BP-DR-63Token not found for this acquirerToken not found for this acquirer. You can check your request to see if everything is right.
BP-DR-64Token not foundToken not found. Checked if the token is being sent right.
BP-DR-65The provided token is already in useThe token that you are trying to create already exist.
BP-DR-66Token not valid. The token length must be between 32 and 128 charactersThe parameter has more characters than the limit allowed.
BP-DR-67Field payment.creditcard.card_due_date is invalidThe parameter sent was not valid.
BP-DR-68Field payment.directdebit.bank_account is requiredThe field was not filled.
BP-DR-69Parameter payment.directdebit.bank_agency can have 10 characters maximumThe parameter has more characters than the limit allowed.
BP-DR-70Field payment.directdebit.bank_agency is requiredThe field was not filled.
BP-DR-71Parameter payment.directdebit.bank_code can have 5 characters maximumThe parameter has more characters than the limit allowed.
BP-DR-72Field payment.directdebit.bank_code is requiredThe field was not filled.
BP-DR-73Field payment.directdebit is required for this payment typeThe field was not filled.
BP-DR-75Card number is invalidThe parameter sent was not valid.
BP-DR-77Country is not enabledThe country is not available on your account. Contact our Integration Team.
BP-DR-78Country not enabled for merchantThe country is not available on your account. Contact our Integration Team.
BP-DR-79The amount of instalments is larger than the maximum allowed for merchantThe number of instalments is not allowed. Contact our Integration Team.
BP-DR-80It was not possible to generate CIP. Please try again.Some error happened on the transaction.
BP-DR-81Currency code {currency_code} not allowed for payment type code: {payment_type_code}.The supplied currency cannot be used for the chosen payment method.
BP-DR-82Parameter payment.note can have 200 characters maximum.The note parameter must have 200 characters or less.
BP-DR-83Foreign credit card cannot be processed.The credit card was issued in a country other than the country of the acquirer.
BP-DR-84Duplicate payment for the same customer and amount within {minutes} minutes.Lock for preventing customer to be billed twice for the same transaction.
BP-DR-85Field payment.sub_account is required.The field was not filled.
BP-DR-86Parameter is invalid: payment.sub_account.The parameter sent was not valid.
BP-DR-87Field payment.sub_account.name is required.The field was not filled.
BP-DR-88Field payment.sub_account.image_url is required.The field was not filled.
BP-DR-89The amount of instalments is not allowed – blocked values are: {payment.api.instalments.blocked}The number of instalments is not allowed. Contact our Integration Team.
BP-DR-90This customer is in our blacklist: {reason}.The customer is disabled on our system.
BP-DR-91Field payment.institution_code is required.The field was not filled.
BP-DR-92Field payment.institution_code is not a valid bank code.The parameter sent was not valid.
BP-DR-93Error creating this payment within PSE ACH. Error code: ?.Something went wrong with the payment operation.
BP-DR-94The token’s credit card has expiredThe token that you are trying to use is expired.
BP-DR-95Parameter payment.card.card_name must be a valid name: number isn’t allowedThe customer may have mistaken the fields and put the number of the card instead of the name.
BP-DR-96Token expiredThe token has expired.
BP-DR-97Instalment payments are not allowed for prepaid cards.Instalment payments are not allowed for prepaid cards.
BP-DR-98Costumer country do not matchThe country of the payment does not match the country of the customer.
BP-DR-99Field payment.sub_account.image_url must be httpsThe image URL that you are trying to send must be with https.
BP-DR-100Instalment payments are not allowed for debit cardsInstalment payments are not allowed for debit cards.
BP-DR-101Card is not eligible for ecommerceThe card provided by the customer cannot be used for online transactions
BP-DR-102Too many attemptsThe customer tried too many times the same transaction in a short period of time.
BP-DR-103Customer disabledCustomer temporarily inactivated (excessive number of credit cards).
BP-DPAR-1Request_body is emptyThe request body is not being set by your system, please check if everything is right.
BP-DPAR-2Invalid JSON expressionSomething is wrong with the JSON that you are trying to send. Check it looking for blank space on typos, that may be the problem.
BP-DPAR-3Field integration_key is requiredThe field was not filled.
BP-DPAR-4Invalid integration keyThe integration key it is not being accepted on the request. Check if there is any typos on the string.
BP-DPAR-5Merchant account is not activeThe merchant account is not enabled, please contact EBANX Support Team.
BP-DPAR-6This merchant account is restricted to testing (use your production account or request one)The merchant account is not allowed in the production environment.
BP-DPAR-7This merchant account cannot be used for testing (use your test account or request one)The merchant account is not allowed in the test environment.
BP-R-1Parameter is required: currency_codeThe field was not filled.
BP-R-2Parameter is required: amountThe field was not filled.
BP-R-3Parameter is required: merchant_payment_codeThe field was not filled.
BP-R-4Parameter is required: nameThe field was not filled.
BP-R-5Parameter is required: emailThe field was not filled.
BP-R-6Parameter payment_type_code not informedThe field was not filled.
BP-R-7Payment type is not activeThe payment type is not enable on you account. Contact our Integration Team.
BP-R-8Invalid payment_type_codeThe parameter sent was not valid.
BP-R-9Amount must be positive: XThe amount is being send if a minus(-). Check your request.
BP-R-10Amount must be greater than XThe amount is too low.
BP-R-11Payment type does not support instalmentsYou are trying to apply instalment on a payment type which not support it. For example: boleto.
BP-R-12Instalments are limited to a quantity of X. Value provided: XThe number of instalment is not with the right value.
BP-R-13The amount of each instalments must be greater than or equal to R$ X. Value calculated: R$ X / X = XInstalments have configured limits for minimum instalment value and maximum quantity of instalments.
BP-R-14Parameter merchant_payment_code can have 20 characters maximumThe parameter has more characters than the limit allowed.
BP-R-15Parameter order_number can have 40 characters maximumThe parameter has more characters than the limit allowed.
BP-R-16Parameter user_value_1 can have 20 characters maximumThe parameter has more characters than the limit allowed.
BP-R-16Parameter user_value_2 can have 20 characters maximumThe parameter has more characters than the limit allowed.
BP-R-16Parameter user_value_3 can have 20 characters maximumThe parameter has more characters than the limit allowed.
BP-R-16Parameter user_value_4 can have 20 characters maximumThe parameter has more characters than the limit allowed.
BP-R-16Parameter user_value_5 can have 20 characters maximumThe parameter has more characters than the limit allowed.
BP-R-17Payment status is not OP (open): XThis payment does not have the OP status.
BP-R-18Parameter is invalid: person_typeThe parameter sent was not valid.
BP-R-19Checkout by CNPJ is not enabledCheckout by CNPJ is not enable on your account. Contact our Integration Team if you want to change it.
BP-R-20Parameter is in an invalid format: due_date. Correct Format: dd/MM/yyyyThe parameter sent was not valid.
BP-R-21Parameter is invalid: due_date – exceeds more than X daysThe parameter sent was not valid.
BP-R-22Parameter is invalid: due_date – less than permittedThe parameter sent was not valid.
BP-R-23Currency is not active in the system: XThe currency that you are trying to use is not enabled.
BP-R-24Parameter is required: countryThe field was not filled.
BP-R-25Country is not enabledThe country that you are trying to make a payment is not enable. Contact our Integration Team.
BP-R-26Country is not enabled for merchantThe country that you are trying to make a payment is not enable on your account. Contact our Integration Team.
BP-R-27Payment type is not enabled for merchantThe payment type that you are trying to make a payment is not enable. Contact our Integration Team.
BP-R-28The amount of instalments is larger than the maximum allowed for merchantThe number of instalments that you are using is bigger than what is allowed. Contact our Integration Team.
BP-R-29Invalid value for instalmentsYou are not sending a correct parameter, check your request.
BP-R-30The 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.
BP-EX-1Currency code not informedThe currency was not filled.
BP-EX-2Currency is not active in the systemThe currency is not enabled.
BP-REF-1Parameter hash not informedThe field was not filled.
BP-REF-2Payment not found for merchant, hash: XThe payment was not found. Contact our Integration Team.
BP-REF-3Parameter operation not informed (must be request or cancel)The field was not filled.
BP-REF-4Parameter amount not informedThe field was not filled.
BP-REF-5Refund amount must be positiveYou are trying to send a negative refund.
BP-REF-6Refund amount is greater than payment amount: X and XThe refund and the payment amount does not match.
BP-REF-7Payment status is not CO, cannot be refunded: XThe payment status is not CO (Confirmed) so it cannot be refunded.
BP-REF-8Payment has chargebacks, cannot be refunded: XThe payments has chargebacks so it cannot be refunded.
BP-REF-9Pending refund amount for payment would be greater than payment amount: XThe amount of the refund and the payment does not match.
BP-REF-10Parameter description not informedThe field was not filled.
BP-REF-11Parameters not informed: refund_id or merchant_refund_codeCheck the refund ID returned when it was created. The refund ID can also be obtained in the query operation for the payment. The merchant_refund_code is optionally generated by the merchant and also be used to identify a refund.
BP-REF-12Refund not found with id = X and merchant_refund_code = YSee above
BP-REF-13Refund is already cancelledRefund is already cancelled
BP-REF-14Refund is already confirmedRefund is already confirmed
BP-REF-15Invalid operation: XYou are trying an invalid operation.
BP-REF-16Parameter merchant_refund_code can have 20 characters maximumThe parameter has more characters than the limit allowed.
BP-REF-17A refund already exists with this merchant_refund_code: XThere is already a refund with this merchant code.
BP-REF-18Insufficient balance to create new refund. please contact finance@ebanx.comInsufficient balance.
BP-REF-19Credit card payment’s open date is older than 85 days ago.The payment is too old.
DA-0Unknown errorUnknown error. Contact the Integration Team.
DA-1Empty operation parameterThe field was not filled.
DA-2Unrecognized operation: {operation}Invalid operation.
BP-CAN-1Parameter hash not informedThe field was not filled.
BP-CAN-2Payment not found for merchantThe payment was not found for this merchant. Please check your parameter.
BP-CAN-3Payment is already cancelledPayment is already cancelled.
BP-CAN-4Payment cannot be cancelledPayment cannot be cancelled.
BP-US-1Parameter hash not informedThe field was not filled.
BP-US-2Payment not found for merchant, hash: XThe payment was not found for this merchant. Please check your parameter.
BP-US-3Parameter status not informedThe field was not filled.
BP-US-4Status must be either CO or CAThe status must be either CO or CA
BP-US-5Operation NOT allowed in production modeThe updateStatus operation can only be used in the test environment. In production mode, the status changes are performed exclusively by the EBANX system.
BP-SA-1Parameter integration_key not informedThe field was not filled.
BP-SA-2Invalid integration keyThe integration key it is not being accepted on the request. Check if there is any typos on the string.
BP-SA-3Merchant account is not activeThe merchant account is not enabled, please contact EBANX Support Team.
BP-SA-4This merchant account is restrited to testing (use your production account or request one)Contact the Integration Team.
BP-SA-5This merchant account cannot be used for testing (use your test account or request one)Contact the Integration Team.
BP-Q-1Parameters hash or merchant_payment_code not informedThe field was not filled.
BP-Q-2Payment not found for merchantThe payment was not found for this merchant. Please check your parameter.
BP-CAP-1Parameters hash or merchant_payment_code not informedThe field was not filled.
BP-CAP-2Payment not found for merchantThe payment was not found for this merchant. Please check your parameter.
BP-CAP-3Payment cannot be captured, status is: CAThe payment cannot be captured.
BP-CAP-4Payment has already been captured, status is: COThe payment has already been captured.
BP-CAP-5Payment cannot be captured, status is: OPThe payment cannot be captured.
BP-CAP-6Payment cannot be captured, payment_type_code is:The payment cannot be captured.
BP-CAP-7Payment cannot be captured, auto_capture is: trueThe payment cannot be captured.
BP-CAP-8Payment cannot be captured, capture_available is: falseThe payment cannot be captured.
BP-CAP-9Payment cannot be captured, pre_approved is: falseThe payment cannot be captured.
BP-CAP-10Invalid amountThe amount that you are trying to use is invalid.
BP-CAP-11Partial capture not availablePartial capture not available.
BP-CAP-12Payment cannot be captured, amount must be equal or less than {currency_code} {max_amount}The payment amount exceeds the limit.
BP-REF-CAN-1Payment can not be cancelled and can not generate a refund. Payment status is CAPayment can not be cancelled and can not generate a refund.
BP-DMO-1Payment not found for merchant: merchant_payment_code={merchant_payment_code}The payment was not found for this merchant. Please check your parameter.
BP-DMO-2Only payments with status OP can be modified (your payment status is {status})Only payments with status OP can be modified.
BP-DOC-01Invalid document: {document}Invalid document.
BP-DOC-02Invalid currency code: ADS, expected any of USD, BRL, EUR, MXN, PEN.The currency sent on the request was not valid.
BP-ZIP-1Zipcode code not informedThe field was not filled.
BP-ZIP-2Zipcode is not validThe parameter sent was not valid.
BP-ZIP-3The address could not be retrievedThe address could not be retrieved.
RP-1Request body is emptyThe request body is empty. Check your code.
RP-2Invalid JSON expression: too deepCheck your JSON expression.
RP-3Invalid JSON expression – invalid or malformedCheck your JSON expression.
RP-4Invalid JSON expression – unexpected control character found (likely encoding error)Check your JSON expression.
RP-5Invalid JSON expression – syntax errorCheck your JSON expression.
RP-6Invalid JSON expression – bad UTF-8 characters (likely encoding error)Check your JSON expression.
RP-7Invalid JSON expression – unknown errorCheck your JSON expression.
RP-8Field integration_key is requiredThe field was not filled.
RF-1Payment already exists with payment_type_codeThere can be only one payment in the system with the same merchant payment code.