Error Codes
Below is a list of possible error codes, along with additional information about how to resolve them. The error codes are HTTP response status codes that indicate an error because of the information provided (for example, a parameter was omitted).
account_activation_failed_missing_payout_address
The account activation call failed because a deactivated address of category=user_payout is not available.
account_activation_failed_missing_person
For account.business_details.type $business_type, person with following relationship(s) $person_relationship must be present before the account can be activated.
account_activation_failed_incorrect_number_of_persons
The account activation call failed because more than 1 person was passed for entity of type individual or sole_proprietor.
account_activation_failed_incorrect_relationship_for_person
The account activation call failed because an incorrect relationship was assigned to the person. For entity of type individual or sole_proprietor, only relationship.owner can be set to true.
account_email_invalid
The email address is invalid (e.g. not properly formatted). Check that the email address is properly formatted and only includes allowed characters: https://en.wikipedia.org/wiki/Email_address#Local-part
account_id_invalid
You have provided an invalid account identifier for @parameter_name. Please provide a valid account identifier to proceed with the request.
account_not_unique_nickname
You have already used this nickname for a different partner. Please retry the request with a unique nickname.
account_parameter_not_editable
You are trying to update a parameter that is not allowed to be edited. Please refer our API documentation page and retry the request with only the allowed updatable parameters.
account_partner_activate_disallowed
You are trying to activate an account of type=partner that is in verifying status. You can perform this action only on accounts in deactivated status.
account_partner_deactivate_disallowed
You are trying to deactivate an account of type=partner that is in verifying status. You can perform this action only on accounts in activated status.
account_platform_activate_disallowed
You are trying to activate an account of type=platform. This is not allowed on the API. This type of account must be activated through the Xflow Dashboard.
account_platform_create_disallowed
You are trying to create an account of type=platform. You can only create accounts of type=user and type=partner.
account_setting_parameter_not_editable
You are trying to update a parameter that is not allowed to be edited. Please refer our API documentation page and retry the request with only the allowed updatable parameters.
account_status_invalid
You have provided an account with $status status. Please retry the request with an account in one of these statuses: $allowed_statuses. If your account is in hold status, you can perform only read actions. Other API calls are not possible. If your partner's account is in hold status, you can perform only read actions on objects associated with the partner. Write actions are not possible. Please reach out to support@xflowpay.com for help.
account_type_invalid
You have provided an invalid account type for @parameter_name. Please retry the request with a valid account of type $type1, $type2.
account_update_access_unauthorized
You do not have access to update this account. This account was created and is managed by Xflow for specific purposes (e.g. representing a partner for paying out platform fees).
account_user_activate_disallowed
You are trying to activate an account of type=user. This is not allowed. You can activate only account of type=partner.
account_user_create_disallowed
You are trying to create an account of type=user. You can only create account of type=partner.
action_invalid
The action you are trying to perform is invalid.
action_not_enabled
The action you are trying to perform is currently not enabled. We will enable it in the future.
action_unauthorized
The action you are trying to perform is not authorized.
address_cannot_be_deactivated
You cannot deactivate addresses associated with an account if account.address is in processing or activated state.
address_category_mismatch
You have provided an address with category $category1 whereas the expected category was $category2. Please provide an address with the expected category.
address_domestic_credit_invalid
You are trying to create an address with $domestic_credit, which is an invalid routing code (routing codes vary by country. In India, a routing code is also known as IFSC or Indian Financial System Code). Please enter a valid routing code to create the address.
address_global_wire_invalid
You are trying to create or update an address with an invalid BIC or Business Identifier Code. Please enter a valid BIC to proceed.
address_global_wire_not_supported
You are trying to create or update an address with a BIC or Business Identifier Code that is not currently supported by Xflow. Please retry the request with a supported BIC.
address_parameter_not_editable
You are trying to update an address of type $type. You can only update the parameter metadata on an address.
address_type_not_allowed
You can only create and update an address of type bank_account.
balance_insufficient
You cannot transfer an amount greater than what is present in the from account identifier balance. Please retry the request with a smaller @parameter_name.
cancelled_request
You have already cancelled this $object_name. You cannot cancel this again.
country_code_invalid
You are trying to create or update an $object_name with $country which is not a valid country code. Please retry the request with a valid country code. You can find the country codes here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
country_code_not_supported
You are trying to create or update an $object_name with $country which is not supported. Please retry the request with a supported country code.
currency_amount_mismatch
You are making a request with amount=$amount. However, the currency you are using is a $number_of_decimal_places_supported decimal currency. Please retry your request with the correct number of decimals.
currency_not_supported
You are trying to use a currency that is not supported by Xflow at the moment or provided an incorrect currency code. Xflow currently supports the following currencies: $supported_currencies.
date_invalid_format
You have provided a date in an invalid format. The expected date format is YYYY-MM-DD. Please provide the date in the correct format and retry the request.
deposit_account_address_mismatch
The deposit.from.account_id or deposit.to.account_id does not match the account to which the deposit.to.address_id belongs.
deposit_account_id_mismatch
You are trying to create a deposit with different deposit.from.account_id and deposit.to.account_id. Please retry the request with the same deposit.from.account_id and deposit.to.account_id.
deposit_parameter_not_editable
You are trying to update a parameter that is not allowed to be updated. You can update only metadata for a deposit object.
duplicate_currencies_not_supported
Xflow does not support duplicate currencies when actioning on an object.
duplicate_values_found
You have provided duplicate values for $parameter_name. Please retry with unique values.
event_type_invalid
You are using an invalid event. Please choose from a list of valid event types and retry this request. A full list of the latest event types is available here: https://docs.xflowpay.com/latest/api#types-of-events
fee_plan_parameter_not_editable
You are trying to update a parameter that is not allowed to be edited. Please refer our API documentation page and retry the request with only the allowed updatable parameters.
file_name_invalid
You are using invalid characters for your file name. The allowed characters are [A-Z, a-z, 0-9, "/", "\", "-", ":", "?", "(", ")", ".", ",", "_", "'", "+", " "]. Please retry the request with appropriate characters for file name.
file_name_length_invalid
The allowed length for file name is $x characters. Please retry the request with an appropriate length.
file_parameter_not_editable
You are trying to update a parameter that is not allowed to be updated. You can only update metadata and purpose for a file object.
file_purpose_mismatch
You have provided a file with $purpose1 whereas the expected purpose was $purpose2. Please provide a file with the expected purpose.
file_request_body_invalid
You are trying to upload a file with an invalid multipart request body. For example, file has no content, file name is not set or empty, payload is empty, or the closing boundary for the multipart request is missing. Please check your request and retry.
file_type_unsupported
You are trying to create a file which has an unsupported format. You can create files with the following formats - jpeg, pdf and png. Please retry with a valid file format.
header_parameter_invalid
You are trying to create a request but the $header header value is set incorrectly. Please retry the request with the correct header value.
header_parameter_missing
You are trying to create a request but the $header header is missing. Please retry the request with the correct header value.
http_parameter_invalid
The HTTP URL provided or the HTTP method used is invalid.
invalid_amount
You are trying to create a $object_name with an invalid amount. Please use an amount > 0 and retry.
invoice_date_invalid
You cannot provide a due date which is older than the invoice creation date. Please provide a valid date and retry your request.
invoice_due_date_invalid
You cannot provide a due date which is older than the invoice creation date. Please provide a valid date and retry your request.
metadata_count_exceeded
You can add only 10 key-value pairs as metadata.
metadata_key_max_length_invalid
The maximum length for metadata key is 40 characters. Please retry the request with an appropriate length.
metadata_key_min_length_invalid
The minimum length for metadata key is 1 character(s). Please retry the request with an appropriate length.
metadata_value_max_length_invalid
The maximum length for metadata value is 500 characters. Please retry the request with an appropriate length.
metadata_value_min_length_invalid
The minimum length for metadata value is 1 character(s). Please retry the request with an appropriate length.
multiple_xflow_receive_same_category_not_allowed
Xflow supports a single address of category=xflow_receive per currency per account. Please check to see if there already exists an address with this constraint or retry the request keeping this by changing the currency or account identifier.
minimum_required_values_not_present
You have not provided the minimum required value(s) for @parameter_name. Please refer to $documentation_link for more details.
object_not_found
You are trying to access an object that does not exist. Please try again with the correct object identifier.
parameter_address_invalid
You have provided an invalid address id for @parameter_name. Please provide valid ids to proceed with the request.
parameter_character_invalid
You are passing a value that is not as per the expected format of @parameter_name. The value is expected in the following regular expression format: $format. Please retry the request with correct value for @parameter_name.
parameter_empty
You did not provide a value for @parameter_name. Please try again with an appropriate value.
parameter_file_invalid
You have provided an invalid file id for @parameter_name. Please provide valid ids to proceed with the request.
parameter_max_length_invalid
The allowed length for @parameter_name is $x. Please retry the request with an appropriate length.
parameter_min_length_invalid
The minimum length for @parameter_name is $x. Please retry the request with an appropriate length.
parameter_range_invalid
You have provided an invalid value for @parameter_name. Please provide a valid value to proceed with the request.
parameter_receivable_invalid
You have provided an invalid receivable_id for @parameter_name. Please provide a valid id to proceed with the request.
parameter_unexpected
You have provided a parameter which is not expected. Please refer our API documentation page and retry the request with only the required parameters.
parameter_value_invalid
We got an invalid value for @parameter_name. Please retry the request with one of the following values: $valid_values.
payment_link_account_receivable_mismatch
You are trying to create a PaymentLink using an account_id which does not match with the account_id of the receivable_id provided. Please retry the action using a receivable_id created against the account for which you are creating the PaymentLink.
payment_link_activate_disallowed
You are trying to activate a PaymentLink in expired status. Please create a new PaymentLink.
payment_link_deactivate_invalid
You are trying to deactivate a PaymentLink that has expired. This is not a valid action.
payment_link_expire_invalid
You are trying to expire a PaymentLink that is not linked to a receivable. You can only expire a PaymentLink that is linked to a receivable.
payment_link_extend_disallowed
You are trying to extend a PaymentLink that is not in activated status. Please retry extend action on a PaymentLink in activated status or create a new PaymentLink.
payment_link_extend_invalid
You are trying to extend a PaymentLink that is not linked to a receivable. You can only extend a PaymentLink that is linked to a receivable.
payment_link_non_us_account_non_usd_currency
You are trying to create a PaymentLink for a partner who is not based in US or for a non USD receivable. PaymentLink is currently available only for account of type=partner with country=US and for a receivable with currency=USD.
payment_link_parameter_not_editable
You are trying to update a parameter that is not allowed to be updated. You can update only metadata for a PaymentLink object.
payment_link_receivable_count_exceed
The maximum number of receivables you can set against a PaymentLink is 1. Please retry creating the PaymentLink with 1 receivable.
payment_link_receivable_status_invalid
You are trying to create a PaymentLink using a receivable that is in $status status. Please retry the request using a receivable that is in one of these statuses: $allowed_statuses.
payout_parameter_not_editable
You are trying to update a parameter that is not allowed to be updated. You can update only metadata for a payout object.
person_delete_not_allowed
You can only delete a person if its status is unverified.
person_parameter_not_editable
You are trying to update a parameter that is not allowed to be edited. Please refer our API documentation page and retry the request with only the allowed updatable parameters.
person_relationship_not_set
You must set at least one of the relationship parameters as true.
person_update_not_allowed
You can only update a person if its status is unverified.
purpose_code_not_supported
The purpose code you have provided is not supported by Xflow or an incorrect purpose code. Please check the list of supported purpose codes: https://docs.xflowpay.com/purpose-codes/
receivable_additional_info_required
We need some more information to process this receivable. Please reach out to support@xflowpay.com or check your mail for more details.
receivable_amount_invoice_amount_mismatch
The amount on the invoice does not match with amount you have provided. Please retry the request with the correct amount.
receivable_amount_maximum_reconcilable_incorrect
The amount_maximum_reconcilable should be less than invoice.amount and greater than amount_settled_payouts + amount_locked. You also cannot change the amount_maximum_reconcilable to an amount less than reconciled amount. Please provide an appropriate amount and retry updating the receivable.
receivable_cancel_disallowed
You cannot cancel a receivable if it has funding associated or has been paid out to your bank account or if there is amount_locked associated.
receivable_confirm_action_disallowed
You can confirm a receivable that is in draft or input_required status only. Please retry the request on a receivable in one of the statuses mentioned.
receivable_creation_date_invoice_creation_date_mismatch
The invoice date on the invoice does not match with invoice date you have provided. Please retry the request with the correct invoice date.
receivable_currency_invoice_currency_mismatch
The receivable.currency does not match with receivable.invoice.currency. Please retry the request with same receivable.currency and receivable.invoice.currency.
receivable_due_date_invoice_due_date_mismatch
The due date on the invoice does not match with due date you have provided. Please retry the request with the correct due date.
receivable_hold
The receivable you are trying to action on is in hold status. Read actions are allowed and other API calls are not possible on this receivable. Please reach out to support@xflowpay.com to change status of the receivable from hold to activated.
receivable_invoice_document_incorrect
The document you have uploaded is not a valid invoice. Please retry the request with the correct document.
receivable_invoice_reference_number_exists
You are trying to create a receivable with an invoice reference number that already exists. Please update the existing receivable or try creating a receivable with a different invoice reference number.
receivable_invoice_transaction_type_incorrect
The type of transaction on the invoice does not match with the transaction type you have selected. Please retry the request with the correct document.
receivable_parameter_not_editable
You are trying to update a parameter that is not allowed to be edited. Please refer our API documentation page and retry the request with only the allowed updatable parameters.
receivable_partner_country_invoice_partner_country_mismatch
The country of the partner on the invoice does not match with the country of the partner you have provided. Please retry the request after updating the country of the partner.
receivable_partner_invoice_partner_mismatch
The partner information on the invoice does not match with partner information you have provided. Please retry the request with the correct partner information.
receivable_reconcile_action_disallowed
You cannot reconcile a receivable unless it is in activated status. Please retry once the receivable is in activated status.
receivable_reconcile_amount_exceed
You cannot reconcile a receivable for an amount greater than receivable.amount_reconcilable or an amount greater than what the partner has deposited or what is present in the source account identifier balance. Please retry the request with a smaller amount or update the receivable.amount_maximum_reconcilable.
receivable_reference_number_invoice_reference_number_mismatch
The invoice id on the invoice does not match with invoice_id you have provided. Please retry the request with the correct invoice id.
receivable_unable_to_process
We are unable to process this receivable currently.
receivable_update_access_unauthorized
You do not have access to update this receivable. This receivable was created and is managed by Xflow for specific purposes (e.g. receiving funds for platform fees).
request_body_invalid
You have provided an invalid request body (e.g. - json syntax). Please check your request and retry.
request_query_parameter_invalid
You have provided an invalid request query parameter (e.g. - unexpected parameters or incorrect data type). Please check your request and retry.
resource_locked
This object cannot be accessed right now because another API request or Xflow process is currently accessing it. If you see this error intermittently, retry the request. If you see this error frequently and are making multiple concurrent requests to a single object, make your requests serially or at a lower rate.
secret_key_invalid
The API key you've used in your request is invalid. Obtain your current secret API key from the Dashboard and update your integration to use them.
secret_key_missing
You have not provided an API key. Obtain your current secret API key from the Dashboard and update your integration.
testmode_action_only
The action you are trying to perform is valid only in testmode. Please retry the action using your test key and inputs.
timestamp_invalid
You have provided an invalid input for timestamp. The timestamp needs to be an integer between -30610224000 and 253402300799. Please retry your request with an appropriate input.
transfer_failed
The requested transfer has failed. Please try again after some time.
transfer_parameter_not_editable
You are trying to update a parameter that is not allowed to be updated. You can update only description and metadata for a transfer object.
transfer_type_invalid
You have provided an invalid transfer type for @parameter_name. Please retry the request with a valid transfer of type $type1, $type2.
url_invalid
The URL provided is invalid.
webhook_endpoint_limit_exceeded
You have reached the maximum allowed limit of 16 webhook endpoints. Please reuse existing endpoints by using the update API.
webhook_endpoint_parameter_not_editable
You are trying to update a parameter that is not allowed to be edited. Please refer our API documentation page and retry the request with only the allowed updatable parameters.
website_invalid
You have provided an invalid website value. Please provide a valid url or pass website_not_available.