Payout Errors
The following error codes and messages appear in REST responses when an error prevents completion of the request.
Note
See also Card Network Errors.
Error Code | Description |
|---|---|
ERROR_BENEFICIARY_DETAILS_IN_REQUEST_AND_SAVED_BENEFICIARY_DETAILS_MISMATCH | The request attempted an operation that requires a beneficiary ID, but the details in the request do not match the details in the saved beneficiary object. The request was rejected. Corrective action: Use the values that were saved in the beneficiary object or create a new beneficiary. |
ERROR_CANCEL_PAYOUT | The request tried to cancel a payout, but the payout type was not cancelable or the payout was in 'confirmed' or 'completed' status. The request was rejected. Corrective action: None. Determine why an attempt was made to cancel a payout that was not cancelable. |
ERROR_CONFIRM_PAYOUT | The request tried to confirm a payout with foreign exchange, but the payout was already completed or did not involve foreign exchange. The request was rejected. Corrective action: None. Determine why an attempt was made to confirm the foreign exchange rate in a payout that does not involve foreign exchange. |
ERROR_CREATE_BENEFICIARY | The request tried to create a beneficiary for a payout, but the country was not recognized. The request was rejected. Corrective action: In the 'country' field, use the correct 2-letter ISO 3166-1 ALPHA-2 code. |
ERROR_CREATE_BENEFICIARY_COUNTRY_NOT_VALID | The request tried to create a beneficiary for a payout, but the country was not recognized. The request was rejected. Corrective action: Use the correct 2-letter ISO 3166-1 ALPHA-2 code, in uppercase letters, for the 'country' field. |
ERROR_CREATE_BENEFICIARY_CURRENCY_NOT_VALID | The request tried to create a beneficiary for a payout, but the currency was missing or not recognized. The request was rejected. Corrective action: Use the correct 3-letter ISO 4217 code for the currency, in uppercase letters, for the 'currency' field. |
ERROR_CREATE_PAYOUT | The request tried to create a payout, but a required field was missing or a field had an incorrect value. The request was rejected. Corrective action: Run 'Get Payout Required Fields' and check all values. |
ERROR_CREATE_PAYOUT_ABA_CONTAINS_NON_NUMERIC_CHARACTERS | The request tried to create a payment with a card that requires 3DS authentication, but the authentication failed. The request was rejected. Corrective action: Try the request again. If the error persists, assess the security risk. |
ERROR_CREATE_PAYOUT_ABA_LENGTH_NOT_VALID | The request tried to create a payout, but the ABA code for the beneficiary is not valid. The request was rejected. Corrective action: Set 'aba' to a string of 9 numerals. |
ERROR_CREATE_PAYOUT_AMOUNT_UNKNOWN | The request tried to create a payout with FX, but the amount of the transaction could not be determined. The request was rejected. Corrective action: Specify 'sender_amount' or 'payout_amount', but not both. |
ERROR_CREATE_PAYOUT_BENEFICIARY_COUNTRY_AND_BANK_COUNTRY_MISMATCH | The request tried to create a payout, but the beneficiary’s country did not match the country of the bank. The request was rejected. Corrective action: Set 'beneficiary_country' to the country specified in the bank account details. |
ERROR_CREATE_PAYOUT_COUNTRY_NOT_SUPPORTED | The request tried to create a payout, but the country of the sender or beneficiary is not supported for the payout method selected. The request was rejected. Corrective action: Use a payout method that supports both the sender country and the beneficiary country. |
ERROR_CREATE_PAYOUT_CURRENCY_NOT_SUPPORTED | The request tried to create a payout, but the sender currency or the payout currency is not supported for the payout method selected. The request was rejected. Corrective action: Use a payout method that supports both the sender currency and the payout currency. |
ERROR_CREATE_PAYOUT_PURPOSE_CODE_NOT_VALID | The request tried to create a payout, but the purpose code for the sender is not valid. The request was rejected. Corrective action: Set 'purpose_code' to a valid value. |
ERROR_CREATE_PAYOUT_TO_CARD_BANK_NOT_SUPPORTED | The request tried to create a payout to a card, but the card issuer has not enabled the bank to offer the service of receiving funds. The request was rejected. Corrective action: Contact Rapyd Client Support. |
ERROR_CREATE_PAYOUT_TO_CARD_CONTACT_ISSUER | The request tried to create a payout to a card, but there was a problem with the card. The request was rejected. Corrective action: Advise the cardholder to contact the issuer. |
ERROR_CREATE_PAYOUT_TO_CARD_EXPIRED_CARD | The request tried to create a payout to a card, but the card expired. The request was rejected. Corrective action: Advise the cardholder to contact the issuer. |
ERROR_CREATE_PAYOUT_TO_CARD_NUMBER_NOT_VALID | The request tried to create a payout to a card, but the card number was not valid. The request was rejected. Corrective action: Advise the cardholder to contact the issuer. |
ERROR_CREATE_PAYOUT_TO_CARD_SERVICE_NOT_SUPPORTED | The request tried to create a payout to a card, but the card issuer has not enabled the card to receive funds. The request was rejected. Corrective action: Advise the cardholder to contact the issuer. |
ERROR_CREATE_SENDER_COUNTRY_NOT_VALID | The request tried to create a sender for a payout, but the country was missing or not recognized. The request was rejected. Corrective action: For the country, use the correct 2-letter ISO 3166-1 ALPHA-2 code, in uppercase letters. |
ERROR_CREATE_SENDER_CURRENCY_NOT_VALID | The request tried to create a sender for a payout, but the currency was missing or not recognized. The request was rejected. Corrective action: For the currency, use the correct 3-letter ISO 4217 code, in uppercase letters. |
ERROR_DELETE_PAYOUT_BENEFICIARY | The request tried to delete a beneficiary, but the beneficiary was not found. The request was rejected. Corrective action: Use the ID of a valid beneficiary. |
ERROR_EXPIRATION_SENT_FOR_NON_CASH_PAYOUT | The request tried to create a payout for a category other than 'cash', but an expiration time was set. The request was rejected. Corrective action: Create the payout without setting the 'expiration' field. |
ERROR_GET_BENEFICIARY | The request attempted an operation that requires a payout beneficiary, but the beneficiary was not found. The request was rejected. Corrective action: Use the ID of a valid beneficiary. |
ERROR_GET_PAYER | The request attempted an operation that requires a payout sender, but the sender was not found. The request was rejected. Corrective action: Use the ID of a valid sender. |
ERROR_GET_PAYOUT | The request tried to retrieve a payout, but the payout was not found. The request was rejected. Corrective action: Use the ID of a valid payout. |
ERROR_INVALID_PAYOUT_BENEFICIARY_ENTITY_TYPE | The request tried to create a beneficiary for a payout, but the entity type was not recognized. The request was rejected. Corrective action: Set the beneficiary entity type to 'company' or 'individual'. |
ERROR_INVALID_PAYOUT_SENDER_ENTITY_TYPE | The request tried to create a sender for a payout, but the entity type was not recognized. The request was rejected. Corrective action: Set the sender entity type to 'company' or 'individual'. |
ERROR_LOCATION_PROVIDED_FOR_PAYOUT_THAT_IS_NOT_LOCATION_SPECIFIC | The request tried to create a payout, but the request included a location and the payout method type is not location-specific. The request was rejected. Corrective action: Delete 'location' from the request or use a payout method type that is location-specific. |
ERROR_MISSING_OR_INVALID_PAYOUT_AMOUNT | The request attempted an operation that requires the amount of the payout, but the amount was not recognized. The request was rejected. Corrective action: Set 'amount' to the amount of the payout. |
ERROR_MISSING_PAYOUT_AMOUNT | The request attempted an operation that requires the payout amount, but the payout amount was not set. The request was rejected. Corrective action: Use a positive decimal number for 'payout_amount'. |
ERROR_MISSING_PAYOUT_BENEFICIARY_COUNTRY | The request attempted an operation that requires the country of the beneficiary, but the country was not found. The request was rejected. Corrective action: In the 'country' field, use the correct 2-letter ISO 3166-1 ALPHA-2 code. |
ERROR_MISSING_PAYOUT_BENEFICIARY_ENTITY_TYPE | The request attempted an operation that requires the entity type of the beneficiary, but the entity type was not found. The request was rejected. Corrective action: Set the beneficiary entity type to 'individual' or 'company'. |
ERROR_MISSING_PAYOUT_CURRENCY | The request tried to create a payout, but the payout currency was missing. The request was rejected. Corrective action: In the 'payout_currency' field, use the correct 3-letter ISO 4217 code. |
ERROR_MISSING_PAYOUT_LOCATION | The request tried to create a payout to a specific location, but 'location_id' was not set. The request was rejected. Corrective action: Provide a valid string for 'location_id'. |
ERROR_MISSING_PAYOUT_METHOD_TYPE | The request tried to create a payout, but 'payout_method_type' was not set. The request was rejected. Corrective action: Provide a valid string for 'payout_method_type'. |
ERROR_MISSING_PAYOUT_SENDER_COUNTRY | The request attempted an operation that requires the country of the sender, but the country was missing. The request was rejected. Corrective action: In the 'sender_country' field, use the correct 2-letter ISO 3166-1 ALPHA-2 code. |
ERROR_MISSING_PAYOUT_SENDER_CURRENCY | The request attempted an operation that requires the currency of the sender, but the currency was missing. The request was rejected. Corrective action: In the 'sender_currency' field, use the correct 3-letter ISO 4217 code. |
ERROR_MISSING_PAYOUT_SENDER_ENTITY_TYPE | The request attempted an operation that requires the entity type of the sender, but the entity type was not found. The request was rejected. Corrective action: Set the sender entity type to 'individual' or 'company'. |
ERROR_MISSING_PAYOUT_UPDATE_FIELDS | The request tried to update a payout, but both the description and the metadata were missing. The request was rejected. Corrective action: Provide either the description or metadata, or both. |
ERROR_PAYER_DETAILS_IN_REQUEST_AND_SAVED_PAYER_DETAILS_MISMATCH | The request tried to create a payout, but the details in the payer did not match the details in the request. The request was rejected. Corrective action: Use the same currency and country for the payout and the sender. If the payer was previously saved, use 'Retrieve Sender' to get the values. |
ERROR_PAYOUT_AMOUNT_EXCEEDED_ORIGINAL_AMOUNT | The request tried to complete a payout in the sandbox, but the total amount of the payout has already been paid out. The request was rejected. Corrective action: Create another payout. |
ERROR_PAYOUT_AMOUNT_LESS_THAN_MINIMUM | The request attempted an operation that requires an amount, but the amount was less than the minimum required for the type of payout method. The request was rejected. Corrective action: Use an amount that is more than the minimum. To determine the minimum, run 'Get Payout Required Fields'. |
ERROR_PAYOUT_AMOUNT_MORE_THAN_MAXIMUM | The request attempted an operation that requires an amount, but the amount was more than the maximum required for the type of payout method. The request was rejected. Corrective action: Use an amount that is less than the maximum. To determine the maximum, run 'Get Payout Required Fields'. |
ERROR_PAYOUT_AMOUNT_NOT_WITHIN_RANGE_OF_PAYOUT_METHOD_TYPE | The amount provided was not within the range of the payout method type. The request was rejected. Corrective action: Ensure that the amount provided is within the range of the payout method type. |
ERROR_PAYOUT_BENEFICIARY_ACCOUNT_UNAVAILABLE | The payout failed because the beneficiary's account is not able to accept the funds. Corrective action: Ask the beneficiary to provide a different account. |
ERROR_PAYOUT_BENEFICIARY_BANK_REJECT | The payout failed because the beneficiary bank rejected the transaction. Corrective action: Ask the beneficiary to contact the beneficiary bank. |
ERROR_PAYOUT_BENEFICIARY_FIELDS_NOT_FOUND | The request tried to create a payout, but some of the items specified in the request were not found. The request was rejected. Corrective action: Check your input data. The beneficiary fields with incorrect data appear at the end of the error code. |
ERROR_PAYOUT_BENEFICIARY_NOT_REACHABLE_BY_METHOD | The payout failed because the beneficiary's account is not reachable by the payout method requested. Corrective action: Use a different payout method or ask the beneficiary for a different account. |
ERROR_PAYOUT_BENEFICIARY_FIELDS_NOT_VALID | The request tried to create a payout, but some of the items specified in the request did not have valid values. The request was rejected. Corrective action: Check your input data. The beneficiary fields with incorrect data appear at the end of the error code. |
ERROR_PAYOUT_BENEFICIARY_IDENTIFICATION_AND_ACCOUNT_MISMATCH | The request tried to create a payout, but the beneficiary identification does not match that of the beneficiary account owner stated in the request. Please verify that the beneficiary account and identification are correct. |
ERROR_PAYOUT_BENEFICIARY_IDENTIFICATION_AND_NAME_MISMATCH | The request tried to create a payout, but the beneficiary name does not match that of the beneficiary identification stated in the request. Please verify that the beneficiary name and identification are correct. |
ERROR_PAYOUT_BENEFICIARY_NAME_AND_ACCOUNT_MISMATCH | The request tried to create a payout, but the beneficiary name does not match that of the beneficiary account owner stated in the request. Please verify that the beneficiary account and name are correct. |
ERROR_PAYOUT_COUNTRY_NOT_VALID | The request tried to create a payout, but a country code is not valid. The request was rejected. Corrective action: Use the correct ISO 3166-1 ALPHA-2 codes for 'beneficiary_country', 'sender_country', and the 'country' field of both the Beneficiary object and the Sender object. |
ERROR_PAYOUT_CURRENCY_NOT_SUPPORTED | The request attempted an operation that requires the payout currency, but the payout method does not support the currency selected for the country of the beneficiary. The request was rejected. Corrective action: Run 'List Payout Method Types'. |
ERROR_PAYOUT_CURRENCY_NOT_VALID | The request tried to create a payout, but a currency code is not valid. The request was rejected. Corrective action: Use the correct ISO 4217 codes for 'sender_currency' and 'payout_currency'. |
ERROR_PAYOUT_NAME_NOT_VALID | The request tried to create a payout, but the name of the beneficiary or sender was not valid. The request was rejected. Corrective action: Verify that 'name' is correct in the explicit sender and beneficiary objects in the request, or that 'first_name', 'last_name' and 'company_name' are correct in the beneficiary and sender objects that are referenced by ID. |
ERROR_PAYOUT_NOT_CANCELABLE | The request tried to cancel a payout, but the payout method type does not support cancellation. The request was rejected. Corrective action: To collect money from the beneficiary, use 'Create Payment'. |
ERROR_UPDATE_BENEFICIARY_WITH_NO_NEW_FIELDS | The request attempted to update a beneficiary field, but its value has already been defined. The request was rejected. Corrective action: Update only values of beneficiary fields that were not previously defined. |
ERROR_UNSUPPORTED_PAYOUT_CURRENCY_OR_COUNTRY | The request attempted a payout operation, but there was a problem with the country or currency, or a mismatch in entity types. The request was rejected. Corrective action: Run 'List Payout Method Types'. Use only supported countries, and use only currencies that are supported for each country. If you are using saved entities for payer or beneficiary, make sure the entity type in the request matches the entity type in the saved entity. |
ERROR_UPDATE_PAYOUT | The request tried to update a payout, but the payout was not found. The request was rejected. Corrective action: For the 'payout' path parameter, use the ID of a valid payout, a string starting with 'payout_'. |
ERROR_VALIDATE_PAYOUT_BENEFICIARY | The request tried to validate a beneficiary, but there was an error in the input fields. The request was rejected. Corrective action: Run 'Get Payout Required Fields'. |
ERROR_UPDATE_NON_ACTIVE_PAYOUT | The request tried to update a payout, but the status of the payout was not 'created'. The request was rejected. Corrective action: Determine why an attempt was made to update a payout that was completed or canceled, or has a status of 'error'. |
ERROR_VOID_PAYOUT_INVOICE | The request tried to set the status of an invoice to 'void', but the invoice type is 'payout'. The request was rejected. Corrective action: None. Determine why an effort was made to void a payout invoice. |
INVALID_BENEFICIARY_PAYOUT_ENTITY_TYPE | The request attempted an operation that requires the entity type of the beneficiary, but the value was not found or not recognized. The request was rejected. Corrective action: Set the 'beneficiary_entity_type' field to one of the following values: 'individual', 'company'. |
INVALID_DESTINATION_CURRENCY | The request attempted an operation that requires the code of the currency to pay out, but the currency was not recognized. The request was rejected. Corrective action: Use the correct 3-letter ISO 4217 code for the currency, in uppercase letters. |
INVALID_PAYER_FIELDS | The request attempted an operation that requires a sender, but one of the fields in the 'sender' object contained a value that is not valid. The request was rejected. Corrective action: The name of the field appears at the end of the response code. Use a valid value. |
INVALID_PAYER_PAYOUT_ENTITY_TYPE | The request attempted an operation that requires the entity type of the sender, but the value was not found or not recognized. The request was rejected. Corrective action: Set the sender entity type to one of the following values: 'individual', 'company'. |
INVALID_PAYOUT | The request tried to create a payout, but the 'payout_type' parameter was not found. The request was rejected. Corrective action: Use the correct payout type. |
INVALID_PAYOUT_CURRENCIES | The request tried to create a payout, but the sender currency or the payout currency is not supported for the payout method type specified. The request was rejected. Corrective action: Choose a payout method type from the response to 'List Payout Method Types', and select currencies that are supported for the payout method type you want. |
INVALID_PAYOUT_ID | The request tried to create a hosted payout tracker page, but the 'payout_id' parameter was invalid. The request was rejected. Corrective action: Use a valid payout token that starts with 'payout_'. |
INVALID_PAYOUT_METHOD_TYPE | The request tried to perform an operation that requires a payout method type, but the type was not recognized. The request was rejected. Corrective action: To find payout method types, use 'List Payout Method Types'. |
INVALID_PAYOUT_TYPE | The request attempted an operation that requires a payout category, but the payout category was not found. The request was rejected. Corrective action: Set 'category' to one of the following values: 'bank', 'card’, 'cash', 'ewallet', 'rapyd_ewallet' |
INVALID_REQUIRED_FIELD | The request attempted a payout operation, but the value of one of the fields was not valid. The request was rejected. Corrective action: The name of the problematic field appears at the end of the error code. Provide a value that matches the regex defined in the response to 'Get Payout Required Fields'. |
MISSING_PAYOUT_BENEFICIARY_COUNTRY | The request attempted an operation that requires the country of the beneficiary, but the value was not found or not recognized. The request was rejected. Corrective action: Use the correct 2-letter ISO 3166-1 ALPHA-2 code, in uppercase letters, for the 'beneficiary_country' field. |
MISSING_PAYOUT_METHOD_REQUIRED_FIELDS | The request tried to create a payout, but one or more required fields were missing. The request was rejected. Corrective action: The names of the missing fields appear at the end of the error code. For the correct values, see the API Reference and the response to 'Get Payout Required Fields'. |
PAYOUT_METHOD_TYPE_BENEFICIARY_COUNTRY_MISMATCH | The request tried to create a payout, but the payout method type is not supported for the beneficiary country. The request was rejected. Corrective action: Run 'List Supported Payout Types' for the country of the beneficiary. The response lists the supported payout method types. |