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-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-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-26	Bank account should be 13 digits long	Argentina
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	Invalid payee data
HP-CM-30	You already have a payout with this external_reference
HP-CM-31	The payout amount exceeds the monthly limit for this Payee document
HP-CM-32	The payout amount exceeds your total balance [Balance: {$balance_normalized}]
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-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-42	Parameter bank_info should not be null
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	HivePayoutType not defined with code '{$type}
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-GN-01	Internal server error
HP-GN-03	Unexpected error occurred
HP-LL-01	Invalid country and currency for local payout
HP-LL-03	Invalid Amount. Local Amount Total exceeded the maximum accepted amount
HP-TC-01	Target not enabled for this country
HP-TC-02	Target requested not found
HP-XB-01	Invalid currency code for this country
HP-XB-02	Invalid Amounts - Data:
HP-XB-03	Invalid Amount. Local Amount Total exceeded the maximum accepted amount
HP-XB-04	Fee not found for this Payout, please contact your BizDev
HP-XB-05	Empty payee birth_date parameter
HP-XB-06	Parameter birth_date is invalid
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-10	Parameter address should not be null
HP-XB-11	Parameter city should not be null
HP-XB-12	Parameter zipcode should not be null
HP-XB-13	Parameter state should not be null
HP-XB-14	Parameter terms_accepted_at should not be null
HP-XB-15	Parameter terms_accepted_at is invalid
HP-XB-16	Invalid Shareholders
HP-XB-17	Empty shareholder birth_date
HP-XB-18	Invalid shareholder birth_date
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

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 ou this form and our comercial 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.