Payout Error Codes

About this page

This page contains the codes of errors that may occur when you create a payout.

How it works

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

{

"type":"invalid_request_error",

"message":"Empty amount",

"status_code":"HP-CM-09",

"code":"HP-CM-09"

}

Observe the following table and verify the codes and error messages that EBANX uses.

Code	Message	Country
HP-AR-01	The field custom_exchange_rate cannot be sent on the request.	Argentina
HP-BI-01	Could not decrypt API request field: Unable to decrypt ciphertext
HP-BR-01	Merchant is not allowed to use PIX	Brazil
HP-BR-02	Empty PIX key	Brazil
HP-BR-03	Invalid PIX key	Brazil
HP-BR-05	Empty Mercadopago account
HP-BR-06	The Mercadopago account must be an email
HP-BR-07	Pix key normalizer not defined for type {target_account_type}	Brazil
HP-BR-08	Invalid bank_ispb number	Brazil
HP-CF-01	Tax-id blocked
HP-CM-01	Empty external reference
HP-CM-02	The external reference must be between 6 and 40 characters long
HP-CM-03	You already have a payout with this external_reference
HP-CM-04	Empty country
HP-CM-05	Country not found
HP-CM-06	This country is not enabled
HP-CM-07	This country is not enabled for your account
HP-CM-08	Empty currency code
HP-CM-09	Empty amount
HP-CM-10	Invalid amount
HP-CM-11	Amount must be greater than zero
HP-CM-12	Invalid use_payee_hub value
HP-CM-13	Empty bank name
HP-CM-14	Invalid bank name
HP-CM-15	Empty account type
HP-CM-16	Invalid account type
HP-CM-18	Empty bank account
HP-CM-19	Empty bank branch
HP-CM-20	Empty bank details
HP-CM-21	Invalid bank detail [Operation code]
HP-CM-23	Invalid bank account
HP-CM-24	Payout is not available for savings account of bank '{$bank_name}'
HP-CM-25	Bank account [CCI] should be 20 digits long	Peru
HP-CM-26	Bank account should be 11 digits long	Mexico
HP-CM-27	Bank details [clabe] should be 18 digits long	Mexico
HP-CM-27	Bank details [cbu] should be 22 digits long	Argentina
HP-CM-28	Unauthorized payee due to compliance issues
HP-CM-29	Payee invalid or not found
HP-CM-30	The payout amount exceeds your total balance [Balance: {balance}]
HP-CM-31	The payout amount exceeds the monthly limit for this Payee document
HP-CM-32	It was not possible to change the balance. Balance available: {balace_available}
HP-CM-33	Merchant is not enabled
HP-CM-34	Empty payee name
HP-CM-35	The payee name must be between 3 and 100 characters long
HP-CM-36	Empty payee email
HP-CM-37	Invalid payee email
HP-CM-38	The payee email must be between 5 and 100 characters long
HP-CM-39	The Payee is under age
HP-CM-40	Invalid Payee document. You cannot update document
HP-CM-41	Invalid document type. You cannot update document type
HP-CM-43	Invalid bank document
HP-CM-44	Empty UID and External Reference
HP-CM-45	Payout not found
HP-CM-46	Payout not found for this account
HP-CM-47	Empty date range
HP-CM-48	Invalid date_from
HP-CM-49	Invalid date_to
HP-CM-50	Date_to must be greater or equal to date_from
HP-CM-51	Date range must be between 31 days
HP-CM-52	Invalid page
HP-CM-53	Invalid status
HP-CM-54	Invalid per_page
HP-CM-55	Payout status different than OP
HP-CM-56	Payout cannot be cancelled after {$cancellation_time} minutes since the request
HP-CM-57	Empty ID, Customer ID
HP-CM-58	Payee not found
HP-CM-59	Empty UID, Transfer Code, Settlement Code and External Reference
HP-CM-60	Transfer not found
HP-CM-61	Transfer not found for this account
HP-CM-62	Transfer status different than OP
HP-CM-63	Transfer cannot be cancelled after {$cancellation_time} minutes since the request
HP-CM-64	Invalid Transfer source
HP-CM-65	Customer parent must not be a child
HP-CM-66	Child customer too deep to find root: {$max_child_level} or more levels found"
HP-CM-68	Payment method invalid or not found
HP-CM-69	Payee document blocked	Brazil
HP-CM-70	Empty Bank Name on source bank info
HP-CM-71	Invalid Payee document. You cannot update document
HP-CM-72	Invalid document type. You cannot update document type
HP-CM-73	Empty source bank info
HP-CM-74	Empty Holder Name on source bank info
HP-CM-75	Empty Bank Account on source bank info
HP-CM-76	Empty country on source bank info
HP-CM-78	Invalid payee_uuid
HP-CM-79	Invalid external reference
HP-CM-81	Empty payee_uuid
HP-CM-82	Transaction type is required for the informed country.
HP-CM-83	Invalid transaction type.
HP-CM-84	Invalid payee.birthdate
HP-CM-85	bank details cannot be longer than 30 characters
HP-DF-01	Empty request
HP-DF-02	Invalid Expression
HP-DF-03	Empty integration_key value
HP-DF-04	Parameter integration_key is invalid
HP-DF-05	Account is not enabled
HP-DF-06	Invalid request type
HP-DF-07	Invalid json expression: Syntax error ({'json':'example}): Syntax error
HP-DF-08	Invalid integration key
HP-GN-01	Internal server error
HP-GN-03	Unexpected error occurred
HP-LL-01	Invalid country and currency for local payout
HP-LL-02	Invalid currency code for local payout
HP-TC-01	Target not enabled for this country
HP-TC-02	Target requested not found
HP-TC-03	Send only one payment method, choose between payee.bank_info or target_account
HP-TC-04	target_account is required for (<TARGET_NAME>) target
HP-XB-01	Invalid currency code for this country
HP-XB-02	Zero or negative amounts: (debit_fee, debit_amount, ...)
HP-XB-03	This payout exceeds the limit amount per transaction
HP-XB-04	Fee not found for this Payout, please contact your BizDev
HP-XB-07	The payee document information doesn\'t match with the payee name or birth_date	Brazil
HP-XB-08	The payee document is not valid with Brazil Federal Revenue	Brazil
HP-XB-16	Invalid Shareholders
HP-XB-19	The shareholder is under age
HP-XB-20	Parameter company contact name should not be null
HP-XB-21	Parameter company contact document should not be null
HP-XB-22	Invalid shareholder document
HP-XB-23	Shareholder document doesn\'t match with its name or birthday	Brazil
HP-XB-24	The shareholder document is not valid with Brazil Federal Revenue	Brazil
HP-XB-25	Invalid shareholder email
HP-XB-26	Currency not found for this country
HP-XB-27	Invalid shareholder document type
HP-XB-28	Shareholder document cannot be equals to payee document
HP-XB-29	Shareholder documents cannot be duplicated
HP-XB-30	Parameter company contact document type should not be null
BP-HI-0001	You already have a transfer with this external_reference
BP-HI-0002	Amount must be greater or equal to {$minimum} USD
BP-HI-0003	The transfer request limit per day was reached
BP-HI-0004	The transfer request limit was reached
BP-HI-0005	Invalid transfer source
BP-HI-0006	Insufficient payment balance, {$percentage} USD available
BP-HI-0007	Insufficient payment balance, {percentage} {currency_code} available
HP-DV-01	Document and country unknown
HP-DV-02	Empty document
HP-VT-01	Invalid json expression
HP-VT-02	Empty json payload
HP-VT-03	Empty integration_key value
HP-VT-04	Invalid integration_key value
HP-VT-05	Account is not enabled
HP-VT-06	Target requested not found
HP-VT-07	Target account is empty
HP-VT-08	Invalid country and currency for local payout
HP-VT-09	Target not enabled for this country
HP-VT-10	Target requested not available for query
HP-VT-11	Configurations for Mercado Pago are missing for merchant
HP-VT-12	Configurations for Mercado Pago are incomplete
HP-IN-01	Creation of payouts to individuals denied
HP-ON-01	The order number must be between 6 and 32 characters long
HP-ON-02	Invalid order number
HP-MP-36	Invalid target/payment_method

Getting help

We hope this article was enlightening, but in case we’ve failed to take out your doubts you have the following options to keep on seeking for answers:

• If you’re not our partner yet and would like to know more about our prices and conditions please fill our this form and our commercial team will get in touch with you.
• In case you’re already our partner please get in touch with our support team at integration@ebanx.com.