Documentation

ERROR_GET_PAYMENT_METHOD_TYPE

The request attempted an operation that requires a payment method, but the payment method type was not recognized or is not available for this merchant. Corrective action: For the 'type' field in the 'payment_method' object or in the 'data' object, use a payment method type that this merchant is authorized to use.

ERROR_PAYMENT_METHOD_EXPIRED

The request attempted an operation that requires a payment method, but the payment method has expired. The request was rejected. Corrective action: Use a different payment method or use 'Add Payment Method to Customer' to refresh the payment method. Advise the customer to complete the authentication process.

ERROR_UPDATE_CARD_CVV_NOT_UPDATABLE

The request tried to update a card, but it tried to set a new value for the 'cvv' field. The 'cvv' field cannot be updated. The request was rejected. Corrective action: Do not change the 'cvv' field.

ERROR_UPDATE_PAYMENT_METHOD

The request tried to update a payment method, but one or more fields were missing or contained incorrect values. The request was rejected. Corrective action: Check all input fields. For details, see the API Reference.

INVALID_CARD_EXPIRATION_DATE

The request attempted an operation that requires a card payment method, but the card expiration date was not valid. The request was rejected. Corrective action: In the 'fields' object, set 'expiration_month' to a 2-digit number between 01 and 12, and set 'expiration_year' to a 2-digit number greater than or equal to the last two digits of the current year.

INVALID_PAYMENT_METHOD

The request tried to perform an operation that requires a payment method, but the payment method was not found. The request was rejected. Corrective action: Use the correct payment method ID or payment method object.

INVALID_PAYMENT_METHOD_TYPE

The request tried to perform an operation that requires a payment method type, but the type was not recognized. The request was rejected. Corrective action: To find payment method types for a country, use 'List Payment Methods by Country'.

INVALID_REQUIRED_PAYMENT_METHOD_FIELDS

The request attempted an operation that requires a payment method, but the required fields were missing. The request was rejected. Corrective action: Run 'Get Payment Method Required Fields'. Inside the 'payment_method' object, populate the 'fields' object with all required fields.

MISSING_PAYMENT_METHOD_REQUIRED_FIELD

The request attempted an operation that requires fields for a payment method, but a field parameter was missing or did not have a valid value. The request was rejected. Corrective action: The end of the response_code shows the name of the field. Provide this field with a proper value.

PAYMENT_METHOD_FIELD_NOT_UPDATABLE

The request tried to update a payment method of a customer, but it tried to set a new value for a field that does not exist or is not modifiable. The request was rejected. Corrective action: Do not change the value of the field named at the end of the error code.

UNKNOWN_PAYMENT_METHOD_FIELD

The request attempted an operation that requires an object describing a payment method, but there was an extra field in the 'fields' object. The name of the extra field appears at the end of the response code. The request was rejected. Corrective action: Populate the 'fields' object with only the fields that are required.

CREATE_PAYMENT_APPLE_PAY_MISSING_FIELDS

The request tried to create an Apple Pay payment with decrypted data, but one or more required fields were missing. The missing fields are listed at the end of the error code. The request was rejected. Corrective action: Provide all required fields.

ERROR_3DS_AUTHENTICATION_FAILURE

The request attempted an operation that requires a card, but the 3DS authentication failed. The request was rejected. Corrective action: Try the request again. If the error persists, advise the customer to contact the card issuer or use a different payment method.

ERROR_3DS_VERIFICATION_IS_NOT_SUPPORTED

The request tried to create a payment that requires 3DS verification, but the specified payment method does not support 3DS verification. The request was rejected. Corrective action: Omit the '3d_required' field under 'payment_method_options', change the value of the '3d_required' payment method option to false, or use a payment method that supports 3DS verification.

ERROR_ACCOUNT_FUNDING_TRANSACTION

The request tried to create an account funding transaction, but your organization is not configured for such transactions. The request was rejected. Corrective action: Contact Rapyd Client Support.

ERROR_AUTH_ONLY_IS_NOT_SUPPORTED

The request tried to create a card authorization, but authorization without capture is not supported for the selected payment method type. The request was rejected. Corrective action: Use a payment method type that supports authorization-only transactions.

ERROR_AUTHENTICATION_PHONE_UNAVAILABLE

The mandate process for a SEPA bank transfer requires access to the account holder’s phone, but the phone was unavailable. The payment was reversed. Corrective action: Resubmit the request and create a new mandate.

ERROR_CANCEL_PAYMENT

The request tried to cancel a payment, but the operation failed. Corrective action: Check all input fields, and verify that the payment exists and was not already closed.

ERROR_CAPTURE_PAYMENT

The request tried to capture a payment, but the payment could not be found or there was an error in the input parameters. The request was rejected. Corrective action: Determine whether the payment was closed, and check all input parameters.

ERROR_CAPTURE_PAYMENT_3DS_INCOMPLETE

The request tried to capture a payment, but the payment requires 3DS authentication, which is not completed. The request was rejected. Corrective action: Advise the customer to complete the 3DS authentication.

ERROR_CAPTURE_PAYMENT_AMOUNT_EXCEEDS_AUTHORIZATION_AMOUNT

The request tried to capture a payment for an amount that exceeds the amount in the original authorization transaction. The request was rejected. Corrective action: Set 'amount' less than or equal to the original authorization amount.

ERROR_CAPTURE_PAYMENT_FOR_CARD_METHODS_ONLY

The request tried to create a payment, but the 'category' of the payment method was not 'card' and 'capture' was set. For all non-card payment methods, 'capture' must be null. The request was rejected. Corrective action: Use a card payment method or set 'capture' to null.

ERROR_CARD_PAYMENT_REQUIRES_CUSTOMER_INPUT_AND_CUSTOMER_NOT_PRESENT

The request tried to make a card payment that requires the customer to fill in one or more of the card details, but the ‘initiation_type’ field was not set to ‘customer_present’. The request was rejected. Corrective action: Set the ‘initiation_type’ field to ‘customer_present’ and rerun the request.

ERROR_CARD_PAYMENT_WITHOUT_CAPTURE_NOT_SUPPORTED

The request tried to make a card payment with authorization only, but the selected payment method does not support it. The request was rejected. Corrective action: Set 'capture' to 'true' or use a different payment method.

ERROR_CARD_VALIDATION_CAPTURE_TRUE

The request attempted to validate a card, but the request also attempted to capture a payment. The request was rejected. Corrective action: Create a payment with a card payment method, set 'capture' to false, and set 'amount' to 0.

ERROR_CARD_VALIDATION_IN_GROUP_PAYMENT

The request attempted to validate a card as part of a group payment. The request was rejected. Corrective action: Create a payment with a card payment method, set 'capture' to false, set 'amount' to 0, and list only one payment in the 'payments' array.

ERROR_CARD_VALIDATION_IN_PAYMENT_WITH_ESCROW

The request attempted to validate a card as part of an escrow transaction. The request was rejected. Corrective action: Create a payment with a card payment method, set 'capture' to false, set 'amount' to 0, and set 'escrow' to null.

ERROR_CARD_VALIDATION_IN_PAYMENT_WITH_FX

The request attempted to validate a card, but the request also attempted to exchange currency. The request was rejected. Corrective action: Create a payment with a card payment method, set 'capture' to false, set 'amount' to 0, and set 'requested_currency' to null.

ERROR_CARD_VALIDATION_IN_SPLIT_PAYMENT

The request attempted to validate a card as part of a split payment. The request was rejected. Corrective action: Create a payment with a card payment method, set 'capture' to false, set 'amount' to 0, and list only one wallet in the 'ewallets' array.

ERROR_COMPLETE_PAYMENT_CARD_NOT_CAPTURED

The request tried to complete a card payment that was authorized and not yet captured, but this operation is not permitted. The request was rejected. Corrective action: Use 'Capture Payment'.

ERROR_CREATE_PAYMENT

The request tried to create a payment, but the payment method was not found. The request was rejected. Corrective action: Use the ID of the payment method in the 'payment_method' field. Alternatively, if the customer has a default payment method, you can use the ID of the customer in the 'customer' field.

ERROR_CREATE_PAYMENT_ADDRESS_VERIFICATION_FAILURE

The request tried to create a payment, but there was a problem with the cardholder's address. The request was rejected. Corrective action: Use a different payment method. Advise the cardholder to contact the card issuer.

ERROR_CREATE_PAYMENT_AMOUNT_EXCEEDS_MAXIMUM

The request tried to create a payment, but the amount was larger than what is allowed by the payment method. The request was rejected. Corrective action: Set 'amount' so that the amount is less than the 'max_amount' allowed for the currency in the payment method, as shown in the response to 'List Payment Methods by Country'.

ERROR_CREATE_PAYMENT_AMOUNT_LESS_THAN_MINIMUM

The request tried to create a payment, but the amount was smaller than what is allowed by the payment method. The request was rejected. Corrective action: Set 'amount' so that the amount is greater than the 'min_amount' allowed for the currency in the payment method, as shown in the response to 'List Payment Methods by Country'.

ERROR_CREATE_PAYMENT_CAPTURE_FOR_CARD_METHODS_ONLY

The request tried to create a payment, but the 'category' of the payment method was not 'card' and 'capture' was set. For all non-card payment methods, 'capture' must be null. The request was rejected. Corrective action: Use a card payment method or set 'capture' to null.

ERROR_CREATE_PAYMENT_CAPTURE_NOT_VALID

The request tried to create a payment, but the method of capture could not be determined. The request was rejected. Corrective action: Set 'capture' to true or false.

ERROR_CREATE_PAYMENT_CARD_NOT_SUPPORTED

The request tried to create a payment with a card, but the card acquirer does not support this card. The request was rejected. Corrective action: Use a different payment method.

ERROR_CREATE_PAYMENT_CERTIFICATE_MISMATCH

The request tried to create a payment with an Apple Pay payment method, but the but the merchant does not have a matching certificate. The request was rejected. Corrective action: Use the Client Portal to check the Apple Pay configuration, or contact Rapyd Client Support.

ERROR_CREATE_PAYMENT_COMPLETE_PAYMENT_URL_NOT_VALID

The request attempted an operation that requires a ‘complete payment’ URL, but it was missing or not recognized. The request was rejected. Corrective action: Use a valid URL for ‘complete_payment_url’.

ERROR_CREATE_PAYMENT_CURRENCY_MISMATCH

Rapyd was unable to complete the payment because the sell currency of the payment was not supported by the payment method. Corrective action: Set 'currency' to a currency that is supported by the payment method.

ERROR_CREATE_PAYMENT_CURRENCY_NOT_SUPPORTED

The request tried to create a payment, but the currency was not recognized or not supported by the payment method provided. The request was rejected. Corrective action: Choose a currency that is supported by the payment method, or choose a payment method that supports the currency.

ERROR_CREATE_PAYMENT_CUSTOMER_CANCEL

The payment failed because the customer canceled or disputed the transaction. Corrective action: Contact the customer.

ERROR_CREATE_PAYMENT_CUSTOMER_NOT_PRESENT

The request tried to create a payment for a recurring, installment or MOTO payment, but also asked for 3DS authentication. The request was rejected. Corrective action: Set '3d_required' to false.

ERROR_CREATE_PAYMENT_ERROR_PAYMENT_URL_NOT_VALID

The request attempted an operation that requires an ‘error payment’ URL, but it was missing or not recognized. The request was rejected. Corrective action: Use a valid URL for ‘error_payment_url’.

ERROR_CREATE_PAYMENT_INSUFFICIENT_FUNDS

The request tried to create a payment, but there were insufficient funds for the transaction. The request was rejected. Corrective action: None. Contact the customer.

ERROR_CREATE_PAYMENT_ODFI_CANCEL

The payment failed because the originating depository financial institution reversed the transaction. Corrective action: Advise the customer to contact the institution.

ERROR_CREATE_PAYMENT_PAD_PROBLEM

The payment failed because of a problem with the pre-authorized debit agreement. Corrective action: Contact the customer.

ERROR_CREATE_PAYMENT_PERCENTAGE_MUST_BE_BETWEEN_0_AND_100

The request tried to split a payment among several wallets according to percentage, but the percentage was out of range. The request was rejected. Corrective action: Set 'percentage' to a decimal number between 0 and 100, with up to 4 decimal places.

ERROR_CREATE_PAYMENT_SPLIT_MISSING_AMOUNT_OR_PERCENTAGE

The request tried to create a payment split among two or more wallets, but the allocation of funds was not recognized. The request was rejected. Corrective action: In the 'ewallets' array, indicate a 'percentage' for all wallets or an 'amount' for all wallets.

ERROR_CREATE_PAYMENT_SOURCE_UNAVAILABLE

The request tried to create a payment, but the source of funds was not available. The request was rejected. Corrective action: Use a different payment method.

ERROR_CRYPTOCURRENCY_PURCHASE_TRANSACTION

The request tried to create a cryptocurrency purchase transaction, but your organization is not configured for such transactions. The request was rejected. Corrective action: Contact Rapyd Client Support.

ERROR_DIGITAL_WALLET_NOT_SUPPORTED_FOR_GET_SESSION

The request tried to retrieve a session for digital wallet, but the digital wallet is not supported for getting payment session. The request was rejected. Corrective action: make sure that you are using the correct digital wallet wallet type and that it is supported.

ERROR_FEES_ONLY_ALLOWED_FOR_EWALLET_TRANSACTIONS

The request tried to make a payment, but it also tried to set a fee and the payment was not to a wallet. The request was rejected. Corrective action: For a payment that is not to a wallet, leave 'payment_fees' unset.

ERROR_FX_FEE_ONLY_ALLOWED_FOR_FX_TRANSACTIONS

The request tried to create a payment, but it also tried to set a foreign exchange fee and the payment was not a foreign exchange transaction. The request was rejected. Corrective action: For a payment that does not require foreign exchange, leave 'fx_fee' unset.

ERROR_GET_AMOUNT_AND_PERCENTAGE

The request tried to create a split payment, but the split was specified by both amount and percentage. The request was rejected. Corrective action: In the 'ewallets' array, indicate a 'percentage' for all wallets or an 'amount' for all wallets.

ERROR_GET_PAYMENT

The request tried to retrieve a payment, but the payment was not found. The request was rejected. Corrective action: Use a valid payment ID.

ERROR_INVALID_EWALLET_AMOUNT

The request tried to create a payment split by amount, but the amount was not valid. The request was rejected. Corrective action: Set 'amount' as a positive decimal number.

ERROR_INVALID_EWALLET_PERCENTAGE

The request tried to create a payment split by percentage, but the percentage was not valid. The request was rejected. Corrective action: Set 'percent' as a decimal number between 0 and 100, with up to two decimal places.

ERROR_INVALID_FX_FEE_CALC_TYPE

The request tried to create a payment, but the method of calculating the FX fee was missing or incorrect. The request was rejected. Corrective action: In the 'fx_fee' object, set 'calc_type' to 'gross' or 'net'.

ERROR_INVALID_FX_FEE_VALUE

The request tried to create a payment, but the FX fee was equal to or larger than the amount of the payment. The request was rejected. Corrective action: In the 'fx_fee' object, set 'value' to a decimal number greater than 0 and less than 100.

ERROR_INVALID_NET_FEES

The request tried to create a payment, but the total net fee was equal to or larger than the amount of the payment. The request was rejected. Corrective action: Set the transaction fee and the FX fee so that the total net fee is less than the amount of the payment.

ERROR_INVALID_PAYMENT_INITIATION_TYPE

The request tried to create a payment, but the initiation type was not recognized. The request was rejected. Corrective action: Set 'initiation_type' to one of the following values: 'customer_present', 'installment', 'moto', 'recurring', 'unscheduled'.

ERROR_INVALID_TRANSACTION_FEE_CALC_TYPE

The request tried to create a payment, but the method of calculating the transaction fee was missing or incorrect. The request was rejected. Corrective action: In the 'transaction_fee' object, set 'calc_type' to 'gross' or 'net'.

ERROR_INVALID_TRANSACTION_FEE_FEE_TYPE

The request tried to create a payment, but the fee type of the transaction fee was missing or incorrect. The request was rejected. Corrective action: In the 'transaction_fee' object, set 'fee_type' to 'percentage' or 'absolute'.

ERROR_INVALID_TRANSACTION_FEE_VALUE

The request tried to create a payment, but the transaction fee was negative or was equal to or larger than the amount of the payment. The request was rejected. Corrective action: In the 'transaction_fee' object, set 'value' and 'fee_type' so that the fee is positive and less than the amount of the payment.

ERROR_MISSING_PAYMENT_TOKEN

The request attempted an operation that requires a payment ID, but the value was not found. The request was rejected. Corrective action: Use the ID of a valid payment.

ERROR_PAYER_UNKNOWN

The request tried to create a payment, but the payer could not be identified on the basis of the information in the request. The request was rejected. Corrective action: Advise the customer to provide correct identifying information.

ERROR_PAYMENT_AMOUNT_HAS_TO_BE_POSITIVE

The request tried to create a payment, but the 'amount' parameter of a wallet was not valid. The request was rejected. Corrective action: Set the 'amount' field for each wallet to a positive number.

ERROR_PAYMENT_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 payment method. The request was rejected. Corrective action: Use an amount that is more than the minimum.

ERROR_PAYMENT_CAN_NOT_BE_CANCELED

The request tried to cancel a payment, but the payment was already closed. The request was rejected. Corrective action: None. Determine why an attempt was made to cancel a closed payment.

ERROR_PAYMENT_EWALLET_NOT_AN_ARRAY_OR_STRING

The request tried to create a payment, but the 'ewallet' parameter was not valid. The request was rejected. Corrective action: To indicate a payment to one wallet, set the 'ewallet' parameter to the ID of the wallet, which is a string starting with 'ewallet_'. To indicate a payment to several wallets, set the 'ewallet' parameter to an array of objects.

ERROR_PAYMENT_FIELD_NAME_NOT_KNOWN

The request attempted an operation that requires the names of fields in the Payment object, but one of the field names was unknown. The request was rejected. Corrective action: In the 'payment_fields' object, use the names of fields that exist in the Payment object.

ERROR_PAYMENT_FX_INVALID_EXPIRATION

The request tried to make a payment together with currency exchange, but the payment method requires an expiration date, and no valid expiration was found in the request. The request was rejected. Corrective action: Provide a valid value for 'expiration'.

ERROR_PAYMENT_INVALID_AMOUNT

The request tried to create a payment, but the amount was not found or not recognized. The request was rejected. Corrective action: Set 'amount' to a positive decimal number.

ERROR_PAYMENT_METHOD_TYPE_DOES_NOT_SUPPORT_FX

The request tried to make a payment together with currency exchange, but the payment method does not support currency exchange. The request was rejected. Corrective action: Use a different payment method.

ERROR_PAYMENT_METHOD_TYPE_DOES_NOT_SUPPORT_PAYMENT_CANCELLATION

The request tried to cancel a payment, but the payment type cannot be canceled. The request was rejected. Corrective action: None. If the payment method supports refunds, use 'Create Refund'.

ERROR_PAYMENT_METHODS_GET

The request attempted an operation that requires a payment method ID, but the payment method was not associated with the customer specified in the request. The request was rejected. Corrective action: Use a payment method that is associated with the specified customer.

ERROR_PAYMENT_MORE_THAN_TWO_AMOUNT_OR_PERCENTAGE_ARE_MISSING

The request tried to create a payment split among two or more wallets, but the allocation of funds was not recognized. The request was rejected. Corrective action: In the 'ewallets' array, indicate a 'percentage' for all wallets or an 'amount' for all wallets.

ERROR_PAYMENT_NOT_FOUND

The request attempted an operation that requires a payment ID, but the payment was not found. The request was rejected. Corrective action: Provide a valid payment ID.

ERROR_PAYMENT_NUMBER_OF_EWALLETS_EXCEEDED

The request tried to split a payment among several wallets, but there were too many wallets to process. The request was rejected. Corrective action: Split the payment among no more than 10 wallets.

ERROR_PAYMENT_PERCENT_MUST_BE_BETWEEN_0_TO_100

The request tried to split a payment among several eWallets according to percentage, but the 'percentage' was out of range. The request was rejected. Corrective action: Set 'percentage' as a decimal number between 0 and 100, with up to 4 decimal places.

ERROR_PAYMENT_PERCENTAGE_HAS_TO_BE_POSITIVE

The request tried to create a payment, but the 'percentage' parameter of a wallet was not valid. The request was rejected. Corrective action: For each wallet, set the 'percentage' field to a positive decimal number between 0 and 100, with up to 4 decimal places.

ERROR_PAYMENT_SPLIT_AMOUNT_EXCEEDS_PAYMENT_AMOUNT

The request tried to split a payment among several wallets, but the combined wallet amounts exceed the total amount of the payment. The request was rejected. Corrective action: Set the 'amount' of the payment to be the same as the total amount of transfers to all wallets.

ERROR_PAYMENT_SPLIT_EXCEEDED_MAXIMUM_NUMBER_OF_EWALLETS

The request tried to split a payment, but there were too many wallets in the request. The request was rejected. Corrective action: In the 'ewallets' array, specify no more than 10 wallets.

ERROR_REVERSE_PAYMENT_DISPUTE_IN_PROCESS

The request tried to reverse a payment, but the payment is already subject to a customer dispute. The request was rejected. Corrective action: None.

ERROR_SIMULATE_COMPLETE_PAYMENT_CARD_NOT_AUTHENTICATED

The request tried to complete a card payment in the sandbox, but the transaction requires 3DS authentication. The request was rejected. Corrective action: Browse to the URL in the 'redirect_url' field in the response to 'Create Payment'. In the simulated 3DS authentication window, enter '123456'.

ERROR_SPLIT_PAYMENT_DUPLICATE_EWALLET

The request tried to split a payment between two or more wallets, but one wallet appeared more than once in the request. The request was rejected. Corrective action: Combine all payments to one wallet into a single entry in the 'ewallets' list.

ERROR_TRANSACTION_FEE_INVALID_AMOUNT

The request tried to create a payment, but the amount of the transaction fee was incorrect. The request was rejected. Corrective action: In the 'transaction_fee' object, set 'value' to a positive decimal number.

ERROR_UPDATE_PAYMENT

The request tried to update a payment, but the status of the payment does not allow updates. The request was rejected. Corrective action: None. Determine why an attempt was made to change the payment when the 'status' was not 'ACT'.

ERROR_USING_TOKEN

The request tried to update a payment, but the payment method could not be found, or the payment failed. The request was rejected. Corrective action: Check all input fields, and verify that the payment method exists.

IDEMPOTENCY_ERROR

The request tried to create a payment, but the 'idempotency' header was identical to that of another request made earlier. The request was rejected. Corrective action. Set 'idempotency' to a unique value.

INVALID_COMPLETE_PAYMENT_URL

The request tried to create a payment, but the 'complete_payment_url' parameter was not valid. The request was rejected. Corrective action: Use the correct URL.

INVALID_ERROR_PAYMENT_URL

The request tried to create a payment, but the 'error_payment_url' parameter was not valid. The request was rejected. Corrective action: Use the correct URL.

INVALID_EXPIRATION

The request attempted an operation that requires a forward date or expiration date, but the date was not found or was not valid. The request was rejected. Corrective action: Provide a date that is a valid Unix time, not past, and not more than 1 year in the future.

INVALID_PAYMENT

The request attempted an operation that requires a payment ID, but the payment was not found. The request was rejected. Corrective action: Use the ID of a valid payment.

MISSING_PAYMENT

The request attempted an operation that requires a payment ID, but the payment was not found. The request was rejected. Corrective action: Use the ID of a valid payment.

PAYMENT_CAPTURED_BEFORE

The request tried to capture a payment, but the payment was previously closed. The request was rejected. Corrective action: None. Determine why capture was attempted for a closed payment.

UNKNOWN_PAYMENT_METHOD_FIELDS

The request tried to create or update a payment, but one of the fields in the 'payment_method' object was not recognized. The request was rejected. Corrective action: In the 'payment_method' object, submit a 'fields' object with documented fields only.

ERROR_ACCOUNT_FUNDING_TRANSACTION

The request tried to create an account funding transaction, but your organization is not configured for such transactions. The request was rejected. Corrective action: Contact Rapyd Client Support.

ERROR_CHECKOUT_AFT_WITH_MULTIPLE_WALLETS

The request tried to create a checkout page with 'aft' set to 'true', but the request included more than one wallet. The request was rejected. Corrective action: Set 'ewallets' to an array of one 'ewallet' object.

ERROR_CHECKOUT_COUNTRY_CURRENCY_MISMATCH

The request tried to create a checkout page, but there is no payment method that is supported in the country for the currency provided. The request was rejected. Corrective action: Use a different currency or country.

ERROR_CHECKOUT_CURRENCY_COUNTRY_MISMATCH

The request tried to create a checkout page, but there is no payment method that is supported in the country for the currency provided. The request was rejected. Corrective action: Use a different currency or country.

ERROR_CHECKOUT_CUSTOMER_MISSING_FOR_RECURRING_OR_INSTALLMENT_RECURRENCE_TYPE

The request tried to create a checkout page without a ‘customer’ field while ‘recurrence_type’ was set to ‘installment’ or ‘recurring’. The request was rejected. Corrective action: Add a ‘customer’ field to the request and rerun it.

ERROR_CHECKOUT_PAGE_REQUIRED_CUSTOMER_FIELDS_NOT_VALID

The request tried to create a checkout page, but one or more of the values in 'required_customer_fields' is not valid. The request was rejected. Corrective action: Provide an array of strings that contain only the following valid values: ‘name’, ‘email’, ‘phone_number’, ‘address’.

ERROR_CHECKOUT_PAGE_DELAYED_CAPTURE_NO_REMAINING_SUPPORTING_CARDS

The request tried to generate a checkout page for a card payment method with delayed capture, but the request filtered the list of payment methods and none of the remaining payment methods support delayed capture. The request was rejected. Corrective action: Set 'capture' to null, or set 'payment_method_type', 'payment_method_type_categories', 'payment_method_types_exclude' and 'payment_method_types_include' such that one or more remaining payment method types are cards that support delayed capture. To determine whether a payment method type supports delayed capture, run 'Get Payment Method Required Fields'.

ERROR_CHECKOUT_PAGE_DELAYED_CAPTURE_NO_SUPPORTING_CARDS

The request tried to generate a checkout page for a card payment method with delayed capture, but there are no card payment methods in the country that support delayed capture. The request was rejected. Corrective action: Set 'capture' to null.

ERROR_CHECKOUT_PAGE_PAYMENT_METHOD_TYPE_CATEGORIES_VALUE_NOT_VALID

The request tried to create a checkout page, but one or more of the values in 'payment_method_type_categories' was set to null, an empty string or an unrecognized value. The request was rejected. Corrective action: Provide an array of strings that contain only the following values: 'bank_redirect', 'bank_transfer', 'card', 'cash', 'ewallet'.

ERROR_CHECKOUT_PAGE_REQUIRED_CUSTOMER_FIELDS_NOT_VALID

The request tried to create a checkout page, but one or more of the values in 'required_customer_fields' is not valid. The request was rejected. Corrective action: Provide an array of strings that contain only the following valid values: ‘name’, ‘email’, ‘phone_number’, ‘address’.

ERROR_CHECKOUT_PAYMENT_METHOD_CATEGORY_CURRENCY_MISMATCH

The request tried to create a checkout page, but one of the payment method categories provided did not contain any payment methods that are supported in the country for the currency provided. The request was rejected. Corrective action: Remove the payment method category from the list.

ERROR_CHECKOUT_PAYMENT_METHOD_CURRENCY_MISMATCH

The request tried to create a checkout page, but the payment method was not recognized. The request was rejected. Corrective action: Specify a payment method that is valid for the country. Use 'List Payment Methods by Country'.

ERROR_CREATE_CHECKOUT_AMOUNT_OUT_OF_RANGE

The request tried to create a checkout page, but the amount was out of range for all payment methods available to you in the country, or for all payment methods that you specified. The request was rejected. Corrective action: For ‘amount’, specify an amount that is between the minimum and the maximum for at least one payment method. For details, run 'List Payment Methods by Country'.

ERROR_HOSTED_PAGE_AMOUNT_MISMATCH

The request tried to create a checkout page with a 'cart_items' object, but the value of the 'amount' parameter does not match the total amount of all items in the 'cart_items' object. The request was rejected. Corrective action: Specify the 'amount' parameter for each item in the cart, and omit it from the root of the request.

ERROR_HOSTED_PAGE_CONFLICTING_PAYMENT_METHOD_TYPES

The request tried to create a checkout page, but the request specified multiple ways of determining available payment methods. The request was rejected. Corrective action: Specify a 'payment_method_type', a list of types in 'payment_method_types_include', a list of types in 'payment_method_types_exclude' or a list of categories in 'payment_method_type_categories', or leave all of these parameters blank.

ERROR_HOSTED_PAGE_FX_FEE_VALUE_NOT_VALID

The request tried to create a payment, but the amount of the FX fee was incorrect. The request was rejected. Corrective action: In the 'fx_fee' object, set 'value' to a decimal number greater than 0 and less than 100.

ERROR_HOSTED_PAGE_GET_CUSTOMER

The request tried to create a checkout page, but the customer was not found. The request was rejected. Corrective action: For 'customer', provide a valid customer ID, a string starting with 'cus_'.

ERROR_HOSTED_PAGE_INVALID_COUNTRY

The request tried to create a checkout page, but the country was not recognized. The request was rejected. Corrective action: For the 'country' field, use the 2-letter ISO 3166-1 ALPHA-2 code in uppercase letters.

ERROR_HOSTED_PAGE_INVALID_EXPORT_TYPE

The request tried to create a follow-up message after a payment via checkout page, but the 'type' parameter was not recognized. The request was rejected. Corrective action: Set 'type' to 'email' or 'text'.

ERROR_HOSTED_PAGE_INVALID_PAYMENT_METHOD_TYPE

The request tried to create a checkout page, but the payment method was not recognized. The request was rejected. Corrective action: Specify a payment method that is valid for the country. Use 'List Payment Methods by Country'.

ERROR_HOSTED_PAGE_INVALID_PAYMENT_METHOD_TYPE_AND_PAYMENT_METHOD_TYPE_CATEGORIES

The request tried to create a checkout page, but the request specified both a payment method type and a set of payment method type categories. The request was rejected. Corrective action: Specify 'payment_method_type' or a set of types in 'payment_method_type_categories', or leave both parameters blank.

ERROR_HOSTED_PAGE_INVALID_PAYMENT_METHOD_TYPE_CATEGORIES

The request tried to create a checkout page, but one or more of the values in 'payment_method_type_categories' was set to null, an empty string or an unrecognized value. The request was rejected. Corrective action: Provide an array of strings that contain only the following values: 'bank_redirect', 'bank_transfer', 'card', 'cash', 'ewallet'.

ERROR_HOSTED_PAGE_INVALID_STATUS

The request tried to create a payment for a checkout page, but the checkout page was already paid. The request was rejected. Corrective action: Determine why there were multiple attempts to pay the same checkout page.

ERROR_HOSTED_PAGE_PAYMENT_METHOD_TYPE_CATEGORIES_NOT_ENABLED

The request tried to create a checkout page, but one or more of the payment method type categories was not enabled. The request was rejected. Corrective action: Use the Client Portal to enable the payment method type categories you want to appear in the checkout page.

ERROR_HOSTED_PAGE_UNREADABLE_PAYMENT_METHOD_TYPES_EXCLUDE_LIST

The request tried to create a checkout page with a list of payment method types to exclude, but the data was not recognized. The request was rejected. Corrective action: In 'payment_method_types_exclude', specify a list of strings, each of which is a payment method type.

ERROR_HOSTED_PAGE_UNREADABLE_PAYMENT_METHOD_TYPES_INCLUDE_LIST

The request tried to create a checkout page with a list of payment method types to include, but the data was not recognized. The request was rejected. Corrective action: In 'payment_method_types_include', specify a list of strings, each of which is a payment method type.

ERROR_HOSTED_PAGE_UNRECOGNIZED_PAYMENT_METHOD_TYPE

The request tried to create a checkout page, but the payment method type specified is not available or does not exist at all. The request was rejected. Corrective action: Specify payment method types that are valid for the country. Use ‘List Payment Methods by Country’.

ERROR_HOSTED_PAGE_UNRECOGNIZED_PAYMENT_METHOD_TYPES_TO_INCLUDE

The request tried to create a hosted page, but the payout method types in 'payout_method_types_include' were not recognized. The request was rejected. Corrective action: Specify payout method types that are valid for the category, country and entity type. Use 'List Payout Method Types'.

ERROR_NOT_AFT_METHOD

The request attempted a hosted page operation for funding a wallet, but one of the payment methods does not support account-funding transactions (AFT) The request was rejected. Corrective action: None. In the 'payment_method_types' array, list only payment methods that support AFT.

INVALID_DISCOUNT_PERCENT_AND_AMOUNT_OFF

The request tried to apply a discount, but the type of discount could not be determined. The request was rejected. Corrective action: Set 'percent_off' or set 'amount_off'.

ERROR_CREATE_PRODUCT_DUPLICATE_PRODUCT_ID

The request tried to validate identity, but the 'id' body parameter was previously used. The request was rejected. Corrective action: Provide a unique product ID for each identity verification operation, whether successful or unsuccessful.

ERROR_CREATE_SERVICE_PACKAGE_DIMENSIONS_NOT_ALLOWED

The request tried to create a product of type 'service', but package dimensions were specified. The request was rejected. Corrective action: Set 'package_dimensions' to null.

ERROR_DELETE_PRODUCT

The request tried to delete a product, but the product was not found. The request was rejected. Corrective action: Determine whether the product was already deleted, and why there were multiple requests to delete it.

ERROR_DELETE_PRODUCT_ACTIVE_SUBSCRIPTION

The request tried to delete a product, but the product is referred to in a plan that is the basis for one or more subscriptions. The request was rejected. Corrective action: Cancel all subscriptions that are associated with the product.

ERROR_GET_PRODUCT

The request tried to retrieve a product, but the product was not found. The request was rejected. Corrective action: Use a valid product ID.

ERROR_PRODUCT_ATTRIBUTE_MUST_BE_STRING

The request tried to create a product, but the 'attributes' field was not an array of strings. The request was rejected. Corrective action: Use an array of strings.

ERROR_SHIPPING_NOT_ALLOWED_FOR_PRODUCT_TYPE_SERVICE

The request tried to create a product of type 'service', but the 'shippable' field was set to 'true'. The request was rejected. Corrective action: Set 'shippable' to null or 'false'.

INVALID_PARAMETER_STATEMENT_DESCRIPTOR_MUST_BE_EMPTY

The request tried to create a product of type 'goods', but the statement descriptor was set. The request was rejected. Corrective action: Set 'statement_descriptor' to null.

INVALID_PARAMETER_UNIT_LABEL_MUST_BE_EMPTY

The request tried to create a product of type='goods', but the 'unit_label' field contained a value. The request was rejected. Corrective action: Use an empty string.

INVALID_PRODUCT

The request tried to perform an operation that requires a product, but the product was not found. The request was rejected. Corrective action: Use a valid product ID.

INVALID_PRODUCT_ATTRIBUTES

The request tried to create or update a product, but the 'attributes' body parameter was not found or is not an array. The request was rejected. Corrective action: Define the 'attributes' body parameter as an array.

INVALID_PRODUCT_ATTRIBUTES_LIMIT

The request tried to create or update a product, but the 'attributes' array contained more than 5 elements. The request was rejected. Corrective action: Define the 'attributes' body parameter as an array of zero to five strings.

INVALID_PRODUCT_ATTRIBUTES_MUST_BE_UNIQUE

The request tried to create a product, but the list of attributes contained a duplicate value. The request was rejected. Corrective action: In the 'attributes' array, list each string only one time.

INVALID_PRODUCT_IMAGES

The request tried to create a product, but the 'images' body parameter was not an array. The request was rejected. Corrective action: Define the 'images' body parameter as an array.

INVALID_PRODUCT_NAME

The request tried to create a product, but the 'name' body parameter was empty or not found. The request was rejected. Corrective action: Define the 'name' body parameter.

INVALID_PRODUCT_TYPE

The request tried to create a product, but the value for the 'type' body parameter was not recognized. The request was rejected. Corrective action: Define the 'type' body parameter as 'service' or 'goods'.

INVALID_STATEMENT_DESCRIPTOR

The request attempted an operation that uses a statement descriptor, but it contained illegal characters. The request was rejected. Corrective action: For the 'statement_descriptor' body parameter, use a string of 1-22 alphanumeric characters and spaces.

BILLING_SCHEME_SHOULD_BE_TIERED

The request tried to create a plan, but the request contains tiers and the 'billing_scheme' body parameter is not set to 'tiered'. The request was rejected. Corrective action: Set 'billing_scheme' to 'tiered' or remove the tiers.

ERROR_CREATE_PLAN

The request tried to create a plan, but the 'type' field of a product is set to 'goods'. The request was rejected. Corrective action: Add only products that have 'type' set to 'service'.

ERROR_CREATE_PLAN_INVALID_PRODUCT_TYPE

The request tried to create a plan, but the 'type' field of a product is set to 'goods'. The request was rejected. Corrective action: Add only products that have 'type' set to 'services'.

ERROR_CREATE_PLAN_MISSING_TIERS_OBJECT

The request tried to create a plan with 'billing_scheme' set to 'tiered', but the request does not define any tiers. The request was rejected. Corrective action: Set the 'tiers' object to contain one or more tiers.

ERROR_CREATE_PLAN_MISSING_TOP_TIER

The request tried to create a plan with 'billing_scheme' set to 'tiered', but the top tier was not defined. The request was rejected. Corrective action: Inside the 'tiers' object, for the top tier, set 'up_to' to 'inf'.

ERROR_CREATE_PLAN_PRODUCT_NOT_ACTIVE

The request tried to create a plan using a product that is not available for purchase. The request was rejected. Corrective action: Use 'Update Product' to set 'active' to true.

ERROR_CREATE_PLAN_TIER_PARAMETERS_NOT_VALID

The request tried to create a plan with 'billing_scheme' set to 'tiered', but the value for one of the fields in a tier object was not valid. The request was rejected. Corrective action: Set 'amount' and 'flat_amount' to a positive decimal number, and set 'up_to' to 'inf' or a positive integer.

ERROR_DELETE_PLAN

The request tried to delete a plan, but the operation failed. Corrective action: Determine whether the plan was already deleted, and why there were multiple requests to delete it.

ERROR_GET_PLAN

The request tried to retrieve a plan, but the plan was not found. The request was rejected. Corrective action: Use a valid plan ID.

ERROR_PLAN_CURRENCY_CODE_DOES_NOT_MATCH

The request tried to create a plan, but the currency of the subscription did not match the currency of all subscription items. The request was rejected. Corrective action: Add only plans that have the same currency as the subscription.

ERROR_PLAN_INTERVAL_COUNT_NOT_VALID

The request tried to create or update a plan, but the interval was defined for more than one year. The request was rejected. Corrective action: Provide correct values for 'interval' and 'interval_count' so that the defined interval is one year or less.

ERROR_PLAN_TRIAL_PERIOD_DAYS_DOES_NOT_MATCH

The request tried to create a plan, but the 'trial_period_days' field for the subscription did not match the 'trial_period_days' of all subscription items. The request was rejected. Corrective action: Add only plans that have the same 'trial_period_days' as the subscription, or change 'trial_period_days' in the relevant plans to match the value in the subscription.

ERROR_UPDATE_PLAN_INVALID_PRODUCT_TYPE

The request tried to update a plan, but the 'type' field of a product is set to 'goods'. The request was rejected. Corrective action: Add only products that have 'type' set to 'service'.

INVALID_AGGREGATE_USAGE

The request tried to create a plan, but the value of the 'aggregate_usage' body parameter was not recognized. The request was rejected. Corrective action: Set 'aggregate_usage' to one of the following values: 'max', 'sum', 'last_during_period', or 'last_ever'.

INVALID_AMOUNT_AND_TIERS

The request tried to create a plan, but the 'amount' and 'tiers' body parameters were both set. The request was rejected. Corrective action: Set 'amount' or 'tiers', but not both.

INVALID_BILLING_SCHEME

The request tried to create a plan, but the value of the 'billing_scheme' body parameter was unset or not recognized. The request was rejected. Corrective action: Set 'billing_scheme' to 'per_unit' or 'tiered'.

INVALID_PLAN_AND_PRODUCT

The request attempted an operation that requires a plan, but the plan was not found. The request was rejected. Corrective action: Use the ID of a valid plan.

INVALID_PLAN_ID

The request tried to retrieve a plan, but the plan was not found. The request was rejected. Corrective action: Use a valid plan ID.

INVALID_PLAN_INTERVAL

The request tried to create a plan or a subscription item. In the case of a plan, the 'interval' body parameter was not one of the following values: 'day', 'week', 'month', 'year'. In the case of a subscription item, the interval in the subscription item must be the same as the interval in the subscription. The request was rejected. Corrective action: Choose a correct value for 'interval', and make sure the intervals in the subscription and the subscription item are the same.

INVALID_TIERS

The request tried to create a plan, but one of the 'tier' objects failed to define 'amount' and 'up_to'. The request was rejected. Corrective action: Define the 'amount' and 'up_to' fields for each 'tier' object.

INVALID_TIERS_MODE

The request tried to create a plan, but the value for the 'tiers_mode' body parameter was not recognized. The request was rejected. Corrective action: Set 'tiers_mode' to one of the following values: 'graduated', 'volume'.

INVALID_TRANSFORM_USAGE

The request tried to create a plan, but the values for the fields of the 'transform_usage' object were not found or not recognized. The request was rejected. Corrective action: Set 'divide_by' to an integer and 'round' to 'up' or 'down'.

INVALID_TRIAL_PERIOD_DAYS

The request tried to create or update a plan, but the value of the 'trial_period_days' body parameter was not recognized. The request was rejected. Corrective action: Set 'trial_period_days' to a positive integer. If there is no free trial, do not set this parameter.

INVALID_USAGE_TYPE

The request tried to create a plan, but the value of the 'usage_type' body parameter was not recognized. The request was rejected. Corrective action: Set 'usage_type' to one of the following values: 'metered', 'licensed'.

ERROR_CANCEL_SUBSCRIPTION

The request tried to cancel a subscription, but the subscription was not found. The request was rejected. Corrective action: Determine whether the subscription was previously canceled, and check all input parameters.

ERROR_CANCELED_SUBSCRIPTION

The request tried to update a subscription, but the subscription was canceled. The request was rejected. Corrective action: None. Determine why an attempt was made to update a canceled subscription.

ERROR_DAYS_UNTIL_DUE_BILLING_INCORRECT

The request tried to create or update a subscription, but the 'days_until_due' body parameter was set and 'billing' was not set to 'send_invoice'. The request was rejected. Corrective action: Set 'billing' to 'send_invoice'.

ERROR_DEFINING_SUBSCRIPTION_TRIAL_PERIOD

The request tried to define a trial period for a subscription, but the trial period was already defined in the plan. The request was rejected. Corrective action: Set 'trial_from_plan' to false and define either 'trial_end' or 'trial_period_days'.

ERROR_DELETE_SUBSCRIPTION_DISCOUNT

The request tried to delete a discount from a subscription, but the operation failed. Corrective action: Determine whether the discount was already deleted, and why there were multiple requests to delete it.

ERROR_DELETE_SUBSCRIPTION_ITEM

The request tried to delete a subscription item from a subscription, but the operation failed. Corrective action: Determine whether the subscription item was already deleted, and why there were multiple requests to delete it.

ERROR_GET_PLANS

The request tried to create a subscription, but the plan was not found. The request was rejected. Corrective action: In each object in the ‘subscription_items’ array, set 'plan' to the ID of a valid plan.

ERROR_GET_SUBSCRIPTION

The request attempted an operation that requires a subscription, but the subscription was not found. The request was rejected. Corrective action: Use the ID of an active subscription.

ERROR_GET_SUBSCRIPTION_LIST

The request tried to retrieve a list of subscriptions, but there was an error in the query syntax. The request was rejected. Corrective action: Use the correct names of all query parameters.

ERROR_HOSTED_PAGE_TRIAL_FROM_PLAN_WAS_DEFINED_WITHOUT_PLAN_PERIOD_DAYS

The request tried to define trial_from_plan for a subscription, but the trial period was not defined in the plan. The request was rejected. Corrective action: Either set 'trial_from_plan' to false or define 'trial_period_days' to a valid number in the plan creation.

ERROR_INVALID_TAX_PERCENT_INPUT

The request tried to create or update a subscription, but the 'days_until_due' body parameter was set and 'billing' was not set to 'send_invoice'. The request was rejected. Corrective action: Set 'billing' to 'send_invoice'.

ERROR_PAYMENT_METHOD_DOES_NOT_SUPPORT_SUBSCRIPTIONS

The request attempted an action that requires a payment method that supports subscriptions. The payment method selected does not support this action. The request was rejected. Corrective action: For 'payment_method', use a payment method that supports subscriptions.

ERROR_PAYMENT_METHOD_TYPE_CURRENCY_DOES_NOT_MATCH_PLAN

The request tried to set a payment method for a subscription, but the payment method does not support the currency in the plan for a subscription item. The request was rejected. Corrective action: Choose a payment method that supports the currency of the subscription item.

ERROR_PLAN_INTERVAL_DOES_NOT_MATCH

The request tried to add a subscription item based on a plan, but the billing interval for the plan did not match the interval of all the subscription items in the subscription. The request was rejected. Corrective action: Add only plans that have the same 'interval' and 'interval_count' as the subscription items in the subscription.

ERROR_SET_TRIAL_TO_UNPAID_SUBSCRIPTION

The request tried to add a free trial to an existing subscription, but full payment was not received for the previous billing period. The request was rejected. Corrective action: Add the free trial after the previous billing period is fully paid.

ERROR_SUBSCRIPTION_BILLING_CYCLE_ANCHOR_IN_FUTURE

The request tried to create a subscription, but the billing cycle anchor was set too far in the future. The request was rejected. Corrective action: To create a subscription, set the 'billing_cycle_anchor' body parameter to a Unix timestamp within the current billing cycle or the first cycle after the free trial period.

ERROR_SUBSCRIPTION_BILLING_CYCLE_ANCHOR_INCORRECT

The request tried to create or update a subscription, but the billing cycle anchor was not recognized. The request was rejected. Corrective action: To create a subscription, set the 'billing_cycle_anchor' body parameter to a Unix timestamp. To update a subscription, set 'billing_cycle_anchor' to 'now' or 'unchanged'.

ERROR_SUBSCRIPTION_BILLING_CYCLE_ANCHOR_NOT_UPDATED

The request tried to update a free trial period for a subscription, but the billing cycle anchor was not updated correctly. The request was rejected. Corrective action: Leave 'billing_cycle_anchor' blank, which resets it to the end of the new trial period.

ERROR_SUBSCRIPTION_BILLING_CYCLE_ANCHOR_NOT_VALID

The request tried to create or update a subscription, but the date of the billing cycle anchor was set during the free trial period. The request was rejected. Corrective action: Set 'billing_cycle_anchor' with the same Unix timestamp as 'trial_end', or any time later than that.

ERROR_SUBSCRIPTION_BILLING_CYCLE_ANCHOR_WITHIN_TRIAL

The request tried to create a subscription, but the date of the billing cycle anchor was set during the free trial period. The request was rejected. Corrective action: Set 'billing_cycle_anchor' with the same Unix timestamp as 'trial_end', or any time later than that.

ERROR_SUBSCRIPTION_BILLING_INCORRECT

The request attempted an operation that requires the 'billing' body parameter, but it was not set to a valid value. The request was rejected. Corrective action: Set 'billing' to 'pay_automatically'.

ERROR_SUBSCRIPTION_COUPON_CURRENCY

The request tried to add a coupon to a subscription, but the currency in the coupon did not match the currency of the plans in the subscription items. The request was rejected. Corrective action: Add a coupon that has the same currency as the plans in the subscription items.

ERROR_SUBSCRIPTION_DUPLICATE_PLANS

The request attempted an operation on a subscription that would result in duplicate plans. The request was rejected. Corrective action: In the 'subscription_items' array, ensure that each plan ID is used one time, and set 'quantity' as required.

ERROR_SUBSCRIPTION_NOT_FOUND

The request attempted an operation that requires a subscription ID, but the value was missing or was not recognized. The request was rejected. Corrective action: Provide a valid subscription ID.

ERROR_SUBSCRIPTION_TRIAL_END_AND_TRIAL_PERIOD_SET

The request tried to create or update a subscription, but both 'trial_end' and 'trial_period_days' were set. The request was rejected. Corrective action: Set 'trial_end' or 'trial_period_days', but not both.

ERROR_SUBSCRIPTION_TRIAL_END_NOT_VALID

The request tried to create or update a subscription, but the value of the 'trial_end' body parameter was not recognized. The request was rejected. Corrective action: Use a valid Unix timestamp for the 'trial_end' parameter. The maximum trial period length is 2 years. If there is no free trial, do not set this parameter.

ERROR_SUBSCRIPTION_TRIAL_PERIOD_ALREADY_DEFINED

The request tried to define a trial period for a subscription, but the trial period was already defined in the plan. The request was rejected. Corrective action: Set 'trial_from_plan' to false and define either 'trial_end' or 'trial_period_days'.

ERROR_SUBSCRIPTION_TRIAL_PERIOD_DAYS_NOT_VALID

The request tried to create or update a subscription, but the value of the 'trial_period_days' body parameter was not recognized. The request was rejected. Corrective action: Set 'trial_period_days' to an integer between 1 and 710. If there is no free trial, do not set this parameter.

ERROR_SUBSCRIPTION_TRIAL_PERIOD_NOT_VALID

The request tried to update the trial period of a subscription, but the end of the new trial period is before the current date. The request was rejected. Corrective action: Set 'trial_period_days' such that the last day of the trial period is after the current day.

ERROR_TAX_PERCENTAGE_NOT_VALID

The request attempted an operation that requires a tax percentage, but the value was not valid. The request was rejected. Corrective action: Set 'tax_percent' to zero or a positive decimal number.

ERROR_TRIAL_END_TRIAL_FROM_PLAN_TOGETHER

The request tried to create or update a subscription, but the 'trial_end' and 'trial_from_plan' body parameters were both set. The request was rejected. Corrective action: To set a trial period, set 'trial_end' or 'trial_from_plan', but not both.

ERROR_TRIAL_PERIOD_DAYS_MISMATCH

The request tried to add or update the list of subscription items in a subscription, but the plans in the subscription items did not all have the same value for 'trial_period_days'. The request was rejected. Corrective action: Update the plans so that they all have the same value for 'trial_period_days', or set 'trial_from_plan' in the subscription to 'false'.

ERROR_UPDATE_SUBSCRIPTION_CUSTOMER_MISMATCH

The request tried to update a subscription with a new payment method, but the payment method does not belong to the customer. The request was rejected. Corrective action: For 'payment_method', use the ID of a payment method belonging to the customer specified for the subscription.

ERROR_UPDATE_SUBSCRIPTION_PAYMENT_PENDING

The request tried to add a new payment method to a subscription, but the last payment on the subscription is still pending. The request was rejected. Corrective action: Complete or cancel the earlier payment, then resubmit the request.

ERROR_UPDATE_SUBSCRIPTION_STATUS_NOT_UPDATABLE

The request tried to update a free trial period for a subscription, but the subscription status was not 'active' or 'trialing'. The request was rejected. Corrective action: Create a new subscription with a new trial period.

INVALID_BILLING

The request tried to create a subscription or invoice, but the value of the 'billing' body parameter was not recognized. The request was rejected. Corrective action: Set 'billing' to 'pay_automatically'.

INVALID_STATUS

The request tried to retrieve a list of subscriptions, but the 'status' query parameter was not recognized. The request was rejected. Corrective action: Set 'status' to one of the following values: 'trialing', 'active', 'past_due', 'unpaid', 'canceled', 'all'

INVALID_SUBSCRIPTION_ID

The request tried to process a subscription or subscription item, but the subscription was not found. The request was rejected. Corrective action: Use the ID of a valid subscription.

INVALID_SUBSCRIPTION_ITEM_QUANTITY

The request tried to create a subscription or a usage record, but the quantity for a subscription item was not valid or 'usage_type' in the relevant plan was set to 'metered'. The request was rejected. Corrective action: Use a positive integer for 'quantity' or create a new subscription item with a plan that has 'usage_type' set to 'metered'.

INVALID_SUBSCRIPTION_ITEMS

The request tried to create or update a subscription, but the subscription items could not be identified. The request was rejected. Corrective action: Set the 'subscription_items' body parameter to be an object or an array of not more than 20 objects.

ERROR_CREATE_SUBSCRIPTION_ITEM

The request attempted an operation that requires a plan ID, but the value was missing or was not recognized. The request was rejected. Corrective action: Provide a valid plan ID.

ERROR_CURRENCY_OR_INTERVAL_MISMATCH

The request tried to add or update the list of subscription items in a subscription, but the plans in the subscription items did not all have the same values for 'currency' and 'interval'. The request was rejected. Corrective action: Include only plans that all have the same values for 'currency' and 'interval'.

ERROR_DELETE_LAST_SUBSCRIPTION_ITEM

The request tried to delete a subscription item from a subscription, but the subscription item is the only one in the subscription. The request was rejected. Corrective action: Delete the subscription.

ERROR_GET_SUBSCRIPTION_ITEM

The request tried to retrieve a subscription item, but the subscription item was not found. The request was rejected. Corrective action: Use a valid subscription item ID.

ERROR_PRORATION_DATE_NOT_VALID

The request attempted to set a proration date on a subscription item, but the date selected was not valid. The request was rejected. Corrective action: For ‘proration_date’, use a date within the current billing period.

ERROR_UPDATE_SUBSCRIPTION_ITEM_USAGE_TYPE

The request tried to update a subscription item, but the usage type in the new plan did not match the usage type in the old plan. The request was rejected. Corrective action: Choose a plan that has the same 'usage_type'.

INVALID_PRORATE_VALUE

The request tried to set a proration date on a subscription item, but the value of 'prorate' was not valid. The request was rejected. Corrective action: Set 'prorate' to true.

INVALID_SUBSCRIPTION_ITEM_PRORATE

The request tried to create or update a subscription item, but the setting for the 'prorate' body parameter was not a Boolean. The request was rejected. Corrective action: Select a Boolean value for the 'prorate' parameter.

INVALID_SUBSCRIPTION_ITEM_PRORATION_DATE

The request attempted to set a proration date on a subscription item, but the date selected was not valid. The request was rejected. Corrective action: For 'proration_date', use a Unix timestamp within the current billing period.

INVALID_SUBSCRIPTION_ITEM_QUANTITY

The request tried to create a usage record for a subscription item, but the quantity was not valid or 'usage_type' in the relevant plan was set to 'metered'. The request was rejected. Corrective action: Use a positive integer for 'quantity' or create a new subscription item with a plan that has 'usage_type' set to 'metered'.

INVALID_SUBSCRIPTION_ITEM_USAGE_RECORD_TIMESTAMP

The request tried to create a usage record, but the value for the 'timestamp' body parameter was not in the correct format. The request was rejected. Corrective action: Use a valid Unix timestamp.

ERROR_DELETE_SUBSCRIPTION_ITEM_USAGE_RECORD

The request tried to delete a subscription usage record, but the operation failed. Corrective action: Determine whether the subscription usage record was already deleted, and why there were multiple requests to delete it.

ERROR_UPDATE_USAGE_RECORDS

The request tried to update subscriptions usage records. The request was rejected.

ERROR_USAGE_RECORD_ACTION_NOT_VALID

The request tried to create a usage record, but the action was not recognized. The request was rejected. Corrective action: Define the 'action' body parameter as 'increment' or 'set'.

ERROR_USAGE_RECORD_TIMESTAMP_NOT_VALID

The request tried to create a usage record for a subscription item, but the timestamp was not valid. The request was rejected. Corrective action: Provide a valid Unix timestamp for a time in the current billing period for the relevant subscription.

INVALID_GET_USAGE_RECORD_SUMMARIES_ENDING_BEFORE

The request tried to get a list of usage record summaries, but the query was not valid. The request was rejected. Corrective action: For the 'ending_before' query parameter, use a valid Unix timestamp.

INVALID_GET_USAGE_RECORD_SUMMARIES_LIMIT

The request tried to get a list of usage record summaries, but the query was not valid. The request was rejected. Corrective action: Set the 'limit' query parameter to an integer between 1 and 100.

INVALID_GET_USAGE_RECORD_SUMMARIES_STARTING_AFTER

The request tried to get a list of usage record summaries, but the query was not valid. The request was rejected. Corrective action: For the 'starting_after' query parameter, use a valid Unix timestamp.

INVALID_GET_USAGE_RECORD_SUMMARIES_SUBSCRIPTION_ITEM_ID

The request tried to get a list of usage record summaries, but the relevant subscription item was not found. The request was rejected. Corrective action: Provide the ID of a valid subscription item, which is a string starting with 'subi'.

INVALID_SUBSCRIPTION_ITEM_USAGE_RECORD_QUANTITY

The request tried to create a usage record, but the quantity was in incorrect format or a negative number. The quantity must be a positive number. The request was rejected. Corrective action: Use a positive number for the quantity.

INVALID_SUBSCRIPTION_ITEM_USAGE_RECORD_TIMESTAMP

The request tried to create a usage record, but the value for the 'timestamp' body parameter was not in the correct format. The request was rejected. Corrective action: Use a valid Unix timestamp.

ERROR_DELETE_INVOICE

The request tried to delete an invoice, but the operation failed. Corrective action: Check all input fields, and verify that the invoice exists and was not already deleted.

ERROR_DELETE_NOT_DRAFT_INVOICE

The request tried to delete an invoice, but the invoice is not in 'draft' status. Only a draft invoice can be deleted. The request was rejected. Corrective action: None. Determine why an attempt was made to delete an invoice that is not in ‘draft’ status.

ERROR_GET_INVOICE

The request tried to retrieve an invoice, but the invoice was not found. The request was rejected. Corrective action: Use a valid invoice ID.

ERROR_MARK_UNCOLLECTIBLE_NOT_OPEN_INVOICE

The request tried to mark an invoice as uncollectible, but the invoice status was not 'open'. The request was rejected. Corrective action: None. Determine why the invoice was not in 'open' status.

ERROR_PAY_INVOICE

The request tried to pay an invoice, but the invoice was not found. The request was rejected. Corrective action: Use the ID of a valid invoice.

ERROR_PAY_INVOICE_PAYMENT

The request attempted to pay invoice, but the invoice type is not payment. The request was rejected.

ERROR_PAY_INVOICE_PAYMENT_PENDING

The request tried to pay an invoice, but there is already an active payment associated with it. The request was rejected. Corrective action: Cancel the active payment.

ERROR_UPDATE_NOT_DRAFT_INVOICE

The request tried to a update an invoice but the invoice is not draft. Can only update draft invoice. The request was rejected.

ERROR_UPDATE_PAYOUT_INVOICE

The request tried to update an invoice, but the invoice was not a payment invoice. The request was rejected. Corrective action: Set 'type' to 'payment'.

ERROR_VOID_NOT_UNCOLLECTIBLE_OR_OPEN_INVOICE

The request tried to a void an invoice but the invoice is draft or paid. Can only void open or uncollectible invoice. The request was rejected.

ERROR_VOID_PAYOUT_INVOICE

The request tried to set status 'void' to an invoice but the invoice type is 'payout'. Can only set status 'void' 'payment' invoice. The request was rejected.

INVALID_DAYS_UNTIL_DUE_AND_BILLING

"The request tried to update an invoice, but the 'billing' body parameter was set to 'pay_automatically', and 'days_until_due' field was set. 'days_until_due' is relevant only when 'billing' is set to 'send_invoice'. The request was rejected. Corrective action: Set 'billing' to 'send_invoice', or set 'days_until_due' to null.

INVALID_DUE_DATE

The request tried to set or update the due date of an invoice, but the value was not valid. The request was rejected. Corrective action: Set the 'due_date' body parameter to a valid Unix timestamp in the future.

INVALID_INVOICE_CURRENCY

The request tried to add an invoice item to an invoice, but the currency specified in the request was not the same as the currency defined for other existing items in the invoice. The request was rejected. Corrective action: Use the same currency for all invoice items in the invoice.

INVALID_INVOICE_CUSTOMER

The request attempted an operation that requires a customer, but the customer specified in the request was not the same as the customer defined for the subscription. The request was rejected. Corrective action: For the invoice and all of its invoice items, use the customer identified in the subscription.

INVALID_INVOICE_ID

The request attempted an operation that requires an invoice, but the invoice was not found. The request was rejected. Corrective action: Use the ID of a valid invoice.

INVALID_INVOICE_ID_AND_SUBSCRIPTION_ID

The request tried to create an invoice item, but the request attempted to link it to both a subscription and an invoice. The request was rejected. Corrective action: Link the invoice item to an invoice or to a subscription, but not both.

INVALID_SUBSCRIPTION_TRIAL_END

The request tried to retrieve the upcoming invoice for a customer, but the 'trial_end' body parameter was set in the subscription and there were no invoice items in the 'lines' array. The request was rejected. Corrective action: Add valid items to the 'lines' array in the subscription or the invoice.

ERROR_DELETE_INVOICE_ITEMS

The request tried to delete an invoice item, but the invoice item was not found. The request was rejected. Corrective action: Determine whether the invoice item was already deleted, and why there were multiple requests to delete it.

ERROR_GET_INVOICE_ITEMS

The request tried to retrieve an invoice item, but the invoice item was not found. The request was rejected. Corrective action: Use a valid invoice item ID.

ERROR_INVOICE_ITEM_AMOUNT_PARAM

The request tried to create an invoice item, but the amount was not was not clear. The request was rejected. Corrective action: Specify the 'amount' field, or specify both 'unit_amount' and 'quantity'.

ERROR_INVOICE_ITEM_CURRENCY_MISMATCH

The request tried to create an invoice item, but there is no upcoming scheduled invoice with matching currency. The request was rejected. Corrective action: For 'currency', use the currency of the subscription's plan.

ERROR_INVOICE_ITEM_CURRENCY_NO_MATCHING_UPCOMING_INVOICE

The request tried to create a Invoice item with, but there is no upcoming scheduled invoice with matching currency to be added to . The request was rejected. Corrective action: Create invoice item with matching subscription's plan currency.

ERROR_INVOICE_ITEM_NOT_FOUND

The request attempted an operation that requires an invoice item, but the invoice item was not found. The request was rejected. Corrective action: Use the ID of a valid invoice item.

ERROR_INVOICE_ITEM_SUBSCRIPTION_TYPE

The request tried to create an invoice item for a payout subscription, but this action is not possible. The request was rejected. Corrective action: None. Determine why an attempt was made to create an invoice item for a payout subscription.

INVALID_INVOICE_ITEM_ID

The request tried to update or delete an invoice item, but the invoice item could not be found. The request was rejected. Corrective action: Use the correct ID for a valid invoice item.

ERROR_CARD_VALIDATION_IN_GROUP_PAYMENT

The request attempted to validate a card as part of a group payment. The request was rejected. Corrective action: Create a payment with a card payment method, set 'capture' to false, set 'amount’ to 0, and list only one payment in the 'payments' array.

ERROR_CASH_NOT_SUPPORTED_FOR_GROUP_PAYMENT

The request tried to create a group payment, but one of the payment methods in the individual payments was a cash payment method. The request was rejected. Corrective action: For all payments, use the following types of payment methods: card, bank_redirect, bank_transfer.

ERROR_CREATE_GROUP_PAYMENT_EXCEEDED_MAX_PARTICIPANTS

The request tried to create a group payment, but there were too many individual payments. The request was rejected. Corrective action: Use 2 to 10 payments.

ERROR_CREATE_GROUP_PAYMENT_INVALID_EXPIRATION

The request tried to create a group payment, but the expiration was not valid. The request was rejected. Corrective action: For 'expiration', use a Unix timestamp for a time in the future.

ERROR_CREATE_GROUP_PAYMENT_INVALID_PAYMENTS

The request tried to create a group payment, but the payments were not in the form of an array. The request was rejected. Corrective action: For the 'payments' array, use an array of 'payment' objects.

ERROR_CREATE_GROUP_PAYMENT_MISSING_CURRENCY

The request tried to create a group payment, but one of the payment methods did not specify a currency. The request was rejected. Corrective action: For all payments, specify the same currency.

ERROR_CREATE_GROUP_PAYMENT_MISSING_PAYMENTS

The request tried to create a group payment, but the payments were not found. The request was rejected. Corrective action: For the 'payments' array, use an array of 'payment' objects.

ERROR_CREATE_GROUP_PAYMENT_PARTICIPANTS_LESS_THAN_MIN

The request tried to create a group payment, but there was only one individual payment. The request was rejected. Corrective action: Use 2 to 10 payments.

ERROR_DIFFERENT_COUNTRIES_NOT_SUPPORTED_FOR_GROUP_PAYMENT

The request tried to create a group payment, but the payment methods in the individual payments were not all from the same country. The request was rejected. Corrective action: For all payments, use payment methods that are supported in the same country.

ERROR_DIFFERENT_CURRENCIES_NOT_SUPPORTED_FOR_GROUP_PAYMENT

The request tried to create a group payment or replace a failed payment in a group payment, but the individual payments did not all use the same currency. The request was rejected. Corrective action: Use the same currency for all payments.

ERROR_ESCROW_NOT_SUPPORTED_FOR_GROUP_PAYMENT

The request tried to create a group payment, but one of the payment methods required an escrow. The request was rejected. Corrective action: For all payments, do not use escrow.

ERROR_FX_NOT_SUPPORTED_FOR_GROUP_PAYMENT

The request tried to create a group payment, but one of the payment methods required currency exchange. The request was rejected. Corrective action: For all payments, do not use currency exchange.

ERROR_GET_GROUP_PAYMENT

The request attempted an operation that requires a group payment, but the group payment was not found. The request was rejected. Corrective action: Use the ID of a valid group payment, a string starting with 'gp_'.

ERROR_GROUP_PAYMENT_CAN_NOT_BE_CANCELED

The request tried to cancel a group payment, but the statuses of the individual payments were not all 'ERR' or 'ACT'. The request was rejected. Corrective action: None. Contact Rapyd Client Support.

ERROR_GROUP_PAYMENT_CAN_NOT_BE_REFUNDED

The request tried to create a refund on a group payment, but the statuses of the individual payments were not all 'ERR' or 'CLO'. The request was rejected. Corrective action: None. Wait until all payments are closed, or contact Client Support.

ERROR_GROUP_PAYMENT_NO_FAILED_PAYMENTS_TO_REPLACE

The request tried to replace a payment in a group payment, but there were no failed payments to replace. The request was rejected. Corrective action: None. Wait until one of the payments fails.

ERROR_GROUP_PAYMENT_PAYMENT_AMOUNT_EXCEEDS_FAILED_PAYMENTS_TOTAL_AMOUNT

The request tried to replace a payment in a group payment, but the amount was greater than the total amount of failed payments. The request was rejected. Corrective action: Set 'amount' to the total amount of failed payments.

ERROR_INVALID_GROUP_PAYMENT

The request attempted an operation that requires a group payment, but the ID of the group payment was not a string. The request was rejected. Corrective action: For 'group_payment', use the ID of a valid group payment, which is a string starting with 'gp'.

ERROR_MISSING_GROUP_PAYMENT

The request attempted an operation that requires a group payment, but the group payment was not found. The request was rejected. Corrective action: Use the ID of a valid group payment, a string starting with 'gp_'.

ERROR_REFUND_GROUP_PAYMENT_INVALID_AMOUNT

The request tried to refund against a group payment, but the amount was not valid. The request was rejected. Corrective action: For 'amount', use a decimal number.

ERROR_CARD_VALIDATION_IN_PAYMENT_WITH_ESCROW

The request attempted to validate a card as part of an escrow transaction, but these two operations must be done separately. The request was rejected. Corrective action: Create a payment with a card payment method, set 'capture' to false, set 'amount’ to 0, and set 'escrow' to null. Next, create the payment with the escrow.

ERROR_ESCROW_ALREADY_RELEASED

The request tried to create or update a payment that does not involve an escrow, but 'escrow_release_days' was set. The request was rejected. Corrective action: Set 'escrow_release_days' to null.

ERROR_ESCROW_RELEASE_DAYS_NOT_VALID

The request tried to set the number of days for release of an escrow, but the number was out of range. The request was rejected. Corrective action: For 'escrow_release_days', use an integer between 1 and 90.

ERROR_GET_ESCROW

The request attempted an operation that requires a payment and its escrow, but the payment or the escrow was not found. The request was rejected. Corrective action: Use a valid ID for the payment and for the escrow.

ERROR_PAYMENT_ESCROW_RELEASE_DAYS_NOT_APPLICABLE

The request tried to create or update a payment that does not involve an escrow, but 'escrow_release_days' was set. The request was rejected. Corrective action: Set 'escrow_release_days' to null.

ERROR_PREVIOUS_RELEASE_FROM_ESCROW_WAS_NOT_PROPORTIONATE

The request tried to do a proportionate partial release of an escrow to multiple wallets, but there was a previous partial release by percentage or by specific amounts. The request was rejected. Corrective action: In the body of the request, provide an array of wallets, and for each wallet, indicate its ID and the specific 'percentage' or 'amount' to release.

ERROR_RELEASE_ESCROW_DUPLICATE_EWALLET

The request tried to release an escrow, but one wallet appeared more than one time. The request was rejected. Corrective action: In the array of wallets, list each wallet only one time.

ERROR_RELEASE_ESCROW_EWALLET_ALREADY_FULLY_RELEASED

The request tried to release an escrow, but the entire amount of the payment was already released, or the entire portion allotted to one wallet was already released. The request was rejected. Corrective action: None. Determine why an attempt was made to release more funds than was specified in the payment.

ERROR_RELEASE_ESCROW_EWALLET_AMOUNT_EXCEEDS_ORIGINAL_SPLIT

The request tried to release an escrow, but the amount specified for one of the wallets and the amount previously released to that wallet was greater than the amount set in the payment for that wallet. The request was rejected. Corrective action: For each wallet in the 'ewallets' array, set an amount that is less than or equal to the amount set in the payment.

ERROR_RELEASE_ESCROW_EWALLET_NOT_FOUND_IN_PAYMENT

The request tried to release an escrow, but one of the wallets was not specified when the payment was created. The request was rejected. Corrective action: In the 'ewallets' array, specify only wallets that were part of the payment.

ERROR_RELEASE_ESCROW_EWALLETS_CANNOT_SET_BOTH_AMOUNT_AND_PERCENTAGE

The request tried to release an escrow, but the amount released to one of the wallets was specified by both amount and percentage. The request was rejected. Corrective action: In the 'ewallet' object, specify 'amount' or 'percentage' or neither. If you specify neither, the amounts will be released to the wallets in proportion to the amounts defined in the payment.

ERROR_RELEASE_ESCROW_EWALLETS_INCONSISTENCY

The request tried to release an escrow to multiple wallets, but the method of determining the amounts was not the same for all the wallets. The request was rejected. Corrective action: For all of the wallets in the 'ewallets' array, use 'amount' or 'percentage' or neither. If you specify neither, the amounts will be released to the wallets in proportion to the amounts defined in the payment.

ERROR_RELEASE_ESCROW_INVALID_AMOUNT

The request tried to release an escrow, but the amount was not recognized. The request was rejected. Corrective action: For 'amount', use a positive decimal number.

ERROR_RELEASE_ESCROW_INVALID_EWALLETS

The request tried to release an escrow, but the wallets were not specified as part of an array. The request was rejected. Corrective action: For 'ewallets', use an array of one or more objects.

ERROR_RELEASE_ESCROW_INVALID_EWALLETS_AMOUNT

The request tried to release an escrow, but the amount for one of the wallets was not a positive decimal number. The request was rejected. Corrective action: For 'amount', use a positive decimal number.

ERROR_RELEASE_ESCROW_INVALID_EWALLETS_PERCENTAGE

The request tried to release an escrow, but the amount for one of the wallets was not recognized. The request was rejected. Corrective action: For 'percentage', use a positive decimal number less than 100, with up to two decimal places.

ERROR_RELEASE_ESCROW_INVALID_PERCENTAGE

The request tried to release an escrow, but the allocation by percentage was not recognized. The request was rejected. Corrective action: For 'percentage' in each object in the 'ewallets' array, use a positive decimal number less than 100, with up to two decimal places.

ERROR_RELEASE_ESCROW_MISSING_EWALLET_ID

The request tried to release an escrow, but one of the wallets was not found. The request was rejected. Corrective action: In the 'ewallets' array, use IDs of valid wallets.

ERROR_RELEASE_ESCROW_MUST_SET_AMOUNT_OR_PERCENTAGE_OR_EWALLETS

The request tried to release an escrow, but the method of distributing the funds was unclear. The request was rejected. Corrective action: Specify one of the following fields: 'amount', 'percentage', 'ewallets', or none of them.

ERROR_RELEASE_ESCROW_NO_FUNDS_ON_HOLD

The request tried to release funds from an escrow, but there are no funds on hold. The request was rejected. Corrective action: Release funds from escrow when there are funds on hold.

ERROR_RELEASE_ESCROW_NOT_ENOUGH_FUNDS_ON_HOLD

The request tried to release an escrow, but the amount specified was more than the amount on hold. The request was rejected. Corrective action: Use 'amount' or 'percentage' or neither to define the release so that the amount released is less than or equal to the amount on hold.

ERROR_RELEASE_ESCROW_STATUS

The request tried to release funds from an escrow, but the status of the escrow does not allow release. The request was rejected. Corrective action: Release funds from escrow when the 'status' of the escrow is 'released' or 'on_hold'.

ERROR_ADDING_REFUND

The request tried to create a refund, but the payment was not found. The request was rejected. Corrective action: Use the ID of a valid payment that is in 'closed' status.

ERROR_CREATE_PARTIAL_REFUND_NOT_READY

The request tried to create a partial refund of a card payment, but this service is temporarily unavailable. The request was rejected. Corrective action: Try again after 24 hours. If the issue persists, contact Rapyd Client Support.

ERROR_CREATE_REFUND

The request tried to create a refund against a payment, but the operation failed. Corrective action: Verify that the payment exists and is not closed, and check all input parameters.

ERROR_CREATE_REFUND_CURRENCY_NOT_VALID

The request tried to create a refund, but the currency was not recognized. The request was rejected. Corrective action: Set 'currency' to the value of 'merchant_requested_currency' or 'currency_code' from the response to 'Create Payment'.

ERROR_CREATE_REFUND_DUPLICATE_EWALLET

The request tried to refund a split payment, but the same wallet was specified more than once. The request was rejected. Corrective action: In the 'ewallets' array, specify each wallet only one time.

ERROR_CREATE_REFUND_EWALLET_ALREADY_FULLY_REFUNDED

The request tried to create a refund of a payment, but the payment was already fully refunded. The request was rejected. Corrective action: None. To transfer money to the payer, use 'Create Payout' or 'Transfer Funds Between Wallets'.

ERROR_CREATE_REFUND_EWALLET_NOT_FOUND_IN_PAYMENT

The request tried to refund a payment, but the wallet was not found in the payment. The request was rejected. Corrective action: In the 'ewallets' array, specify wallets that appear in the payment.

ERROR_CREATE_REFUND_EWALLETS_INCONSISTENCY

The request tried to refund a split payment, but the refund split was not defined correctly. The request was rejected. Corrective action: In the 'ewallets' array, specify the 'amount' field for all wallets or the 'percent' field for all wallets.

ERROR_CREATE_REFUND_INVALID_EWALLETS_AMOUNT

The request tried to create a refund, but the amount from one wallet was not valid. The request was rejected. Corrective action: In the 'ewallets' array, set the 'amount' field for all wallets to a positive decimal number.

ERROR_CREATE_REFUND_INVALID_EWALLETS_PERCENTAGE

The request tried to create a refund, but the percentage from one wallet was not valid. The request was rejected. Corrective action: In the 'ewallets' array, set the 'percentage' field for all wallets to a decimal number between 0 and 100.

ERROR_CREATE_REFUND_MISSING_EWALLET_ID

The request tried to refund a payment, but the ID of one of the wallets was missing. The request was rejected. Corrective action: In the 'ewallet' field, provide the ID of the wallet that the refund will be taken from.

ERROR_CREATE_REFUND_PAYMENT_NOT_REFUNDABLE

The request tried to create a refund, but the payment method does not allow this operation. The request was rejected. Corrective action: Send the funds to the payer using ‘Create Payout’ or ‘Transfer Funds Between Wallets’, or contact Client Support.

ERROR_GET_EWALLET_NOT_ENOUGH_FUNDS

The request tried to create a refund of a payment to one or more wallets, but one of the wallets did not have enough funds to complete the refund. The request was rejected. Corrective action: Fund the wallet with 'Create Payment' or transfer funds from another wallet using 'Transfer Funds Between Wallets'.

ERROR_PREVIOUS_REFUND_WAS_NOT_PROPORTIONATE

The request tried to create a refund to two or more wallets, but the previous refund was not proportionate and the current request did not specifically state the amount to return to each wallet. The request was rejected. Corrective action: Specify an 'ewallets' array. For each 'ewallet', specify the 'amount' that it will receive from the refund.

ERROR_REFUND_AMOUNT_EXCEEDS_PAYMENT_AMOUNT

The request tried to create a refund of payment that was collected to one or more wallets, but the amount of all refunds against this payment exceeded the amount of the payment. The request was rejected. Corrective action: None. Determine why an attempt was made to refund more money than was collected originally.

ERROR_REFUND_REQUEST_FOR_PAYMENT_IN_DISPUTE

A refund request for a payment that is already in dispute was rejected. Corrective action: None.

ERROR_UPDATE_REFUND

The request tried to update a refund, but the refund was not found, or the operation failed. The request was rejected. Corrective action: Check all input fields, and verify that the refund exists and was not already closed.

INVALID_REFUND

The request attempted an operation that requires a refund, but the refund was not found. The request was rejected. Corrective action: Use the ID of a valid refund.

INVALID_REFUND_STATUS

The request tried to complete a refund, but the refund was already completed and closed. The request was rejected. Corrective action: Determine why multiple attempts were made to complete the same refund.

INVALID_REFUND_TOKEN

The request tried to update a refund, but the refund was not found. The request was rejected. Corrective action: Use the ID of a valid refund.

PAYMENT_NOT_COMPLETED

The request tried to create a refund, but the payment object on which the refund is based is not in 'closed' status. The request was rejected. Corrective action: Wait until the payment is closed, and then create the refund.

ERROR_CREATE_DISPUTE_AMOUNT_EXCESSIVE

The request tried to dispute a payment, but the total amount of all disputes exceeded the unreversed portion of the payment. The request was rejected. Corrective action: Set 'amount' to be less than or equal to the unreversed portion of the payment.

ERROR_CREATE_DISPUTE_AUTHORIZATION_NOT_COMPLETE

The request tried to dispute a payment, but the status of the authorization prevented the action. The request was rejected. Corrective action: Contact Rapyd Client Support.

ERROR_CREATE_DISPUTE_CURRENCY_MISMATCH

The request tried to dispute a payment, but the currency for the dispute does not match the currency of the payment. The request was rejected. Corrective action: Set 'currency' to be the same as the currency paid by the customer.

ERROR_CREATE_DISPUTE_TOO_LATE

The request tried to dispute a payment, but 110 days have passed since the payment was captured. The request was rejected. Corrective action: None.

CREDIT_CARD_EXISTS

The request tried to add a credit card to a customer, but the customer already has this card as a payment method. The request was rejected. Corrective action: None. Determine why an attempt was made to add the same card twice.

CUSTOMER_ALREADY_ASSIGNED_TO_EWALLET

The request tried to add a wallet to a customer, but the customer already has a wallet. The request was rejected. Corrective action: Create a new customer and add the wallet to the new customer.

DELETE_CUSTOMER_DEFAULT_PAYMENT_METHOD_NOT_ALLOWED

The request tried to delete the default payment method from a customer, but this operation is not allowed. The request was rejected. Corrective action: Assign another payment method to be the default payment method, then repeat the delete request.

ERROR_CREATE_CUSTOMER

The request tried to create or update a customer, but the wallet ID provided is already in use by another customer. The request was rejected. Corrective action: Create a new wallet.

ERROR_CUSTOMER_DATA_MISSING

The request attempted an operation that requires a customer, but required data in the customer is missing. The request was rejected. Corrective action: Use 'Update Customer' to correct the values of all of the fields listed at the end of the error code. For more information, see the API Reference.

ERROR_CREATE_CUSTOMER_EWALLET_ALREADY_IN_USE

The request tried to add a wallet to a customer, but the proposed wallet belongs to a different customer. The request was rejected. Corrective action: For 'ewallet', use the ID of a wallet that does not already belong to a customer.

ERROR_DEFAULT_PAYMENT_METHOD_BELONGS_TO_DIFFERENT_CUSTOMER

The request tried to update a customer, but the proposed default payment method belongs to a different customer. The request was rejected. Corrective action: For 'default_payment_method', use a payment method that belongs to the customer you want to update.

ERROR_DELETE_CUSTOMER

The request tried to delete a customer, but the operation failed. Corrective action: Determine whether the customer was already deleted, and why there were multiple requests to delete it.

ERROR_DELETE_CUSTOMER_DISCOUNT

The request tried to delete a discount from a customer, but the operation failed. Corrective action: Determine whether the discount was already deleted, and why there were multiple requests to delete it.

ERROR_GET_CUSTOMER

The request attempted an operation that requires the ID of a customer, but the customer was not found. The request was rejected. Corrective action: Use the correct ID of the customer, a string starting with 'cus_'.

ERROR_GET_PAYMENT_METHOD

The request attempted an operation that requires the ID of a payment method, but the payment method was not found for the customer. The request was rejected. Corrective action: Add a valid payment method to the customer.

INVALID_CUSTOMER

The request attempted an operation that requires a valid customer ID, but the customer was not found. The request was rejected. Corrective action: Use the correct customer, or create a new customer.

INVALID_CUSTOMER_EMAIL

The request attempted an operation that requires a valid email address, but the information was not in proper email address format. The request was rejected. Corrective action: Use the correct format for an email address.

INVALID_CUSTOMER_FIRST_OR_LAST_NAME

The request attempted an operation that requires a customer, but the customer did not have a valid first name or last name. The request was rejected. Corrective action: Create a customer that has all fields required for this operation. Run 'Get Payment Method Required Fields'.

INVALID_CUSTOMER_ID

The request attempted an operation that requires a valid customer ID, but the customer was not found. The request was rejected. Corrective action: Use the correct customer, or create a new customer.

INVALID_CUSTOMER_NAME

The request tried to create a customer, but the name was missing. The request was rejected. Corrective action: In the 'name' field, provide the customer's full name.

INVALID_CUSTOMER_PHONE_NUMBER

The request tried to create a customer, but the phone number was not recognized. The request was rejected. Corrective action: Provide the customer's phone number in proper E.164 format.

INVALID_REQUIRED_PAYMENT_METHOD_FIELDS

The request tried to create or update a customer, or add or update a payment method for a customer, but a required field in the payment method was not found. The request was rejected. Corrective action: Use all fields required for the payment method.

INVALID_TOKENS_LIMIT

The request tried to retrieve a list of customers, but the value for the 'limit' query parameter was more than 30. The request was rejected. Corrective action: Set 'limit' from 1-30.

ERROR_ADDRESS_GET

The request attempted an operation that requires an address, but the address was not found. The request was rejected. Corrective action: For the 'address' parameter, use a valid address ID.

ERROR_DELETE_ADDRESS

The request tried to delete the address, but this operation failed. The request was rejected. Corrective action: None. Only an address that is linked to a customer or not linked to any object can be deleted.

INVALID_ADDRESS_ID

The request tried to update an address, but the address was not found. The request was rejected. Corrective action: Create a new address.

INVALID_ADDRESS_LINE_1

The request attempted an operation that requires an address, but Line 1 of the address was missing. The request was rejected. Corrective action: In the 'line_1' field, provide a valid street address.

INVALID_ADDRESS_NAME

The request attempted an operation that requires an address, but the name associated with the address was missing. The request was rejected. Corrective action: In the 'name' field, provide a valid personal or business name.

INVALID_ADDRESS_PHONE_NUMBER

The request tried to add or update a phone number for an address, but the phone number is not in proper E.164 format or is not valid. The request was rejected. Corrective action: Submit the phone number in proper E.164 format.

INVALID_ADDRESS_ZIP

The request tried to create or update an address, but the postal code was not valid. The request was rejected. Corrective action: In the 'zip' field, use the correct postal code.

INVALID_ADDRESSES_FORMAT

The request attempted an operation that requires an array of addresses, but the request provided a single address object. The request was rejected. Corrective action: For 'addresses', use an array of address objects.

INVALID_CITY

The request tried to create or update an address, but the city contained special characters. The request was rejected. Corrective action: Submit the name of the city without special characters.

INVALID_STATE

The request tried to add a state or province to an address, but the name contained special characters. The request was rejected. Corrective action: Use the correct spelling of the name.

CREATE_CARD_TYPE_REQUIRES_ONLY_ONE_OF_FIELDS_OR_TOKEN

The request tried to add a payment method to a customer, but both the 'type' and 'token' body parameters are set, or they are both unset. The request was rejected. Corrective action: Set one of the following parameters: 'type' or 'token'.

ERROR_CREATE_PAYMENT_METHOD

The request attempted an operation that requires specific fields for payment method, but a required field was missing, or an extra, unallowed field was included. Corrective action: Run 'Get Payment Method Required Fields' and check all input fields.

ERROR_CUSTOMER_PAYMENT_METHOD_NOT_FOUND

The request attempted an operation that requires the default payment method of a customer, but the customer does not have a default payment method. The request was rejected. Corrective action: Use 'Update Customer' to select a default payment method, or use 'Add Payment Method to Customer'.

ERROR_DELETE_DEFAULT_PAYMENT_METHOD_IN_USE

The request tried to delete a customer's default payment method, but the payment method was in use. The request was rejected. Corrective action: Use 'List Subscriptions', filtered by the customer's ID, then use 'Cancel Subscription' to remove all subscriptions that use the customer's ID or the payment method that you want to delete.

ERROR_DELETE_PAYMENT_METHOD_FROM_WRONG_CUSTOMER

The request tried to delete a payment method from a customer, but the payment method was not assigned to the customer that was specified in the request. The request was rejected. Corrective action: Indicate a payment method that is on the current list of payment methods for the designated customer.

ERROR_DELETE_PAYMENT_METHOD_IN_USE

The request tried to delete a customer's payment method, but the payment method was in use. The request was rejected. Corrective action: Use 'List Subscriptions', filtered by the customer's ID, then use 'Cancel Subscription' to remove all subscriptions that use the customer's ID or the payment method that you want to delete.

ERROR_GET_CUSTOMER_DEFAULT_PAYMENT_METHOD

The request attempted an operation that requires a customer's default payment method, but the default payment method was not found. The request was rejected. Corrective action: Use 'Update Customer' to set the default payment method.

ERROR_GET_PAYMENT_METHOD_TYPE

The request attempted an operation that requires a payment method, but the payment method type was not recognized or is not available for this merchant. Corrective action: For the 'type' field in the 'payment_method' object or in the 'data' object, use a payment method type that this merchant is authorized to use, or contact Client Support.

PAYMENT_METHOD_FIELD_NOT_UPDATABLE

The request tried to update a payment method of a customer, but it tried to set a new value for a field that does not exist or is not modifiable. The request was rejected. Corrective action: Do not change the value of the field named at the end of the error code.

PAYMENT_METHOD_REQUIRES_ONLY_ONE_OF_TYPE_OR_TOKEN

The request tried to add a payment method to a customer, but both the 'type' and 'token' body parameters are set, or they are both unset. The request was rejected. Corrective action: Set one of the following parameters: 'type' or 'token'.

ERROR_TOKENIZE_CARD_NO_PAYMENT_METHODS

The request tried to create a token for future use of a card, but there are no relevant card payment methods available in the country for the merchant. The request was rejected. Corrective action: Contact Client Support.

ERROR_TOKENIZE_CARD_PAYMENT_METHOD_NOT_AVAILABLE_IN_COUNTRY

The request tried to create a token for future use of a card, but the payment method requested is not available in the country specified. The request was rejected. Corrective action: Set 'payment_method_type' to null.

ERROR_TOKENIZE_CARD_PAYMENT_METHOD_NOT_AVAILABLE_TO_CLIENT

The request tried to create a token for future use of a card, but the payment method requested is not available to the client. The request was rejected. Corrective action: Set 'payment_method_type' to a valid payment method type that the client is authorized to use.

ERROR_TOKENIZE_CARD_PAYMENT_METHOD_NOT_FOUND

The request tried to create a token for future use of a card, but the payment method could not be determined. The request was rejected. Corrective action: Set 'country' or 'payment_method_type'.

ERROR_CREATE_SKU_WRONG_PRODUCT_TYPE

The request tried to create an SKU, but the 'type' field of the associated product was set to 'service'. The request was rejected. Corrective action: Set 'product' to the ID of a product that has its 'type' field set to 'goods'.

ERROR_DELETE_SKU

The request tried to delete an SKU, but the SKU was not found. The request was rejected. Corrective action: Determine whether the SKU was already deleted, and why there were multiple requests to delete it.

ERROR_GET_SKU

The request tried to retrieve an SKU, but the SKU was not found. The request was rejected. Corrective action: Use a valid SKU ID.

ERROR_INVALID_SKU_ACTIVE_VALUE

The request tried to create an SKU, but the value for 'active' was not valid. The request was rejected. Corrective action: Set the 'active' field to 'true' or 'false'.

ERROR_INVALID_SKU_ID

The request attempted an operation that requires an SKU, but the SKU was not found. The request was rejected. Corrective action: Use a valid SKU ID.

INVALID_INVENTORY_QUANTITY

The request tried to create or update an SKU, but the quantity specified for the inventory was not valid. The request was rejected. Corrective action: For 'quantity' in the 'inventory' object, specify a positive integer.

INVALID_SKU_ATTRIBUTES

The request tried to create or update an SKU, but the attributes did not match the list of attributes defined in the associated product. The request was rejected. Corrective action: Define attributes that match the list of attributes defined in the associated product.

ERROR_SKU_ID_ALREADY_EXISTS

The request tried to create an SKU, but the SKU ID was already in use. The request was rejected. Corrective action: Set the 'id' field to a unique value.

INVALID_SKU_HEIGHT

The request tried to create an SKU, but the product height was not valid. The request was rejected. Corrective action: Set the 'height' field to a positive number.

INVALID_SKU_INVENTORY_QUANTITY

The request tried to create or update an SKU, but the quantity specified for the inventory was not valid. The request was rejected. Corrective action: For 'quantity' in the 'inventory' object, specify a positive integer.

INVALID_SKU_INVENTORY_TYPE

The request tried to create or update an SKU, but the 'type' field in the 'inventory' object was not recognized. The request was rejected. Corrective action: Use 'finite', 'infinite' or 'bucket'.

INVALID_SKU_LENGTH

The request tried to create an SKU, but the product length was not valid. The request was rejected. Corrective action: Set the 'length' field to a positive number.

INVALID_SKU_PRICE

The request tried to create or update an SKU, but the 'price' was not recognized. The request was rejected. Corrective action: Use a valid decimal for the price.

INVALID_SKU_PRODUCT_TOKEN

The request tried to create or update an SKU, but the product was not recognized. The request was rejected. Corrective action: For 'product', use the ID of a valid product of type 'goods'.

INVALID_SKU_WEIGHT

The request tried to create an SKU, but the product weight was not valid. The request was rejected. Corrective action: Set the 'weight' field to a positive number.

INVALID_SKU_WIDTH

The request tried to create an SKU, but the product width was not valid. The request was rejected. Corrective action: Set the 'width' field to a positive number.

ERROR_GET_LIST_ORDER

The request tried to retrieve an order for a customer or a return on an order, but the order was not found. The request was rejected. Corrective action: Use a valid order ID.

ERROR_GET_ORDER

The request attempted an operation that requires an order, but the order was not found. The request was rejected. Corrective action: Use the ID of a valid order, a string starting with ‘order’.

ERROR_GET_ORDER_RETURN

The request tried to retrieve a return on an order, but the order was not found. The request was rejected. Corrective action: Use a valid order ID.

ERROR_INVALID_COUPON_TYPE

The request tried to add a coupon to an order, but the 'type' of the coupon was not 'once'. The request was rejected. Corrective action: Choose a coupon that has 'type' set to 'once.'

ERROR_INVALID_ORDER_CURRENCY

The request tried to create an order, but the currency of the order items did not match the currency of the order. The request was rejected. Corrective action: For 'currency' in each object in the 'items' array, use the currency of the order.

ERROR_INVALID_ORDER_SHIPPING_ADDRESS

The request tried to create an order, but the order contained order items that are marked 'shippable,' and there was no shipping address. When an order contains shippable items, the shipping address is required. The request was rejected. Corrective action: Add a shipping address.

ERROR_MISSING_CUSTOMER

The request tried to create an order, but the customer was not found. The request was rejected. Corrective action: For 'customer', provide the ID of a valid customer, a string starting with 'customer'.

ERROR_MISSING_ORDER_EMAIL

The request tried to create an order, but the 'email' of the customer was not found in the order or the 'customer' object. The request was rejected. Corrective action: Add the customer's email to the customer or the order.

ERROR_MISSING_ORDER_ITEMS

The request tried to create an order or a return against an order, but no items were added. An order requires at least one order item, and a return requires at least one return item. The request was rejected. Corrective action: Add one or more items.

ERROR_MISSING_PRODUCT_TOKEN

The request tried to create an order, but the SKU for an item was not found. The request was rejected. Corrective action: Use a valid SKU ID in the 'parent' field of the item.

ERROR_ORDER_COUPON_FIELD_NOT_UPDATABLE

The request tried to update a coupon for an order, but the order status was not 'new'. An order can only be updated when the status is 'new.' The request was rejected. Corrective action: Create a new order and add the coupon to it.

ERROR_ORDER_COUPON_INVALID_CURRENCY

The request tried to add an 'amount off' coupon to an order, but the curency was not recognized. The request was rejected. Corrective action: Set 'coupon' to the ID of a coupon that has 'currency' set to the same currency as the order.

ERROR_ORDER_INVALID_EMAIL

The request tried to create an order, but the format of the email address was incorrect, or no email address was found for the order or for the customer. The request was rejected. Corrective action: Use a valid email address for the customer or the order.

ERROR_ORDER_INVALID_STATUS

The request tried to update the status of an order, but the status offered was not valid. The request was rejected. Corrective action: Set the status to one of the valid values.

ERROR_ORDER_INVALID_TAX_PERCENT

The request tried to set the 'tax_percent' field of an order to a negative number. The request was rejected. Corrective action: Set the tax percent to zero or a positive number.

ERROR_ORDER_ITEM_INVALID_AMOUNT_NUMBER

The request tried to create an order, but the amount of an item was zero or negative. The amount must be a positive number. The request was rejected. Corrective action: For 'amount' in each object in the 'items' array, use a positive decimal number.

ERROR_ORDER_ITEM_INVALID_DISCOUNT

The request tried to process an order item that was subject to a discount, but the discount was based on a coupon that was not found. The request was rejected. Corrective action: Delete the discount from the order, then add a valid coupon.

ERROR_ORDER_ITEM_INVALID_TYPE

The request tried to create an order, but the 'type' of an order item was not recognized. The request was rejected. Corrective action: Set 'type' to one of the following values: 'sku' or 'shipping'.

ERROR_ORDER_ITEM_MISSING_PARENT

The request tried to create an order, but a coupon or sku object was not found. The request was rejected. Corrective action: For each order item of type 'sku' in the 'items' array, use a valid SKU ID in the 'parent' field. For each order item of type 'coupon', use a valid coupon ID in the 'parent' field.

ERROR_ORDER_MISSING_CURRENCY

The request tried to create an order, but the 'currency' body parameter was blank or not found. The request was rejected. Corrective action: Use the correct 3-letter ISO 4217 code for the currency.

ERROR_ORDER_MISSING_SHIPPING_ITEM

The request tried to create an order, but the list of items in the order did not contain an item for shipping. The request was rejected. Corrective action: Add an item with 'type' set to 'shipping'. If the shipping is free, set 'amount' to 0.

ERROR_ORDER_MISSING_SKU_ITEM

The request tried to create an order, but the list of items in the order did not contain an SKU item. The request was rejected. Corrective action: Add an item with 'type' set to 'sku'.

ERROR_ORDER_SAME_SKU_PRESENT_IN_MORE_THAN_ONE_ORDER_ITEM

The request tried to create an order, but two or more order items had the same SKU. Each SKU object can appear only one time in the list of items. The request was rejected. Corrective action: Combine the quantities of all line items that refer to the same SKU object.

ERROR_ORDER_SHIPPING_ITEM_INVALID_QUANTITY

The request tried to create an order, but the quantity of shipping items was not correct. The request was rejected. Corrective action: In the list of items, set the 'quantity' field in the 'shipping' item to 1.

ERROR_ORDER_STATUS_DOES_NOT_ALLOW_RETURNS

The request tried to create a return against an order, but the status was 'created', 'pending' or 'canceled'. The request was rejected. Corrective action: Check why an attempt was made to create a return against an order that was already fully returned or never delivered.

ERROR_ORDER_TAX_FIELD_NOT_UPDATABLE

The request tried to update the 'tax_percent' body parameter of an order, but the order status was not 'new'. An order can only be updated when the status is 'new.' The request was rejected. Corrective action: Create a new order and add the correct value to the 'tax_percent' field.

ERROR_PAY_ORDER

The request tried to pay an order, but the order was already paid. The request was rejected. Corrective action: None. Determine why multiple attempts were made to pay the same order.

ERROR_PAY_ORDER_COMPLETED_WITHOUT_ORDER_STATUS_UPDATE

The request to pay the order was successful, but the status of the order was not updated. Please contact Rapyd customer support for more information.

ERROR_PAYMENT_COMPLETED_WITHOUT_ORDER_STATUS_UPDATE

The request to complete the payment was successful, but the status of the order was not updated. Please contact Rapyd customer support for more information.

IDENTITY_PROOF_REQUIRED

The request tried to create an order, but validation of the customer's identity was required and was not found. The request was rejected. Corrective action: Verify the customer's identity.

ERROR_CREATE_ORDER_RETURN_ITEM

The request tried to create a return against an order, but one of the items in the return could not be created. The request was rejected. Corrective action: Check all input parameters.

ERROR_GET_ORDER_RETURN

The request tried to retrieve a return on an order, but the order was not found. The request was rejected. Corrective action: Use the ID of a valid return, a string starting with 'orre'.

ERROR_MISSING_ORDER_ID

The request attempted an operation that requires an order, but the order was not found. The request was rejected. Corrective action: Use the ID of a valid order, a string starting with 'order'.

ERROR_RETURN_ORDER_INVALID_ITEM_QUANTITY

The request tried to create a return against an order, but the quantity was missing or not a positive integer, or the item was already returned, or the item in the return does not match any item in the order. The request was rejected. Corrective action: Check all input fields.

ERROR_RETURN_ORDER_INVALID_ORDER

The request tried to create a return against an order, but the order was not found. The request was rejected. Corrective action: Use the ID of an order that is in 'paid', 'fulfilled' or 'returned' status.

ERROR_RETURN_ORDER_INVALID_SHIPPING_ITEM

The request tried to create a return against an order, but the SKU was not found. The request was rejected. Corrective action: Set 'parent' in each object in the 'items' array to the ID of an SKU in the order.

ERROR_RETURN_ORDER_INVALID_TAX_ITEM

The request tried to create a return against an order, but the item was a tax item and was not found in the order. The request was rejected. Corrective action: Check all input fields.

ERROR_RETURN_ORDER_RETURN_ITEM

The request tried to create a return against an order, but the order item was not found in the order. The request was rejected. Corrective action: Check all input fields.

ERROR_COUPON_DISCOUNT_NOT_RECOGNIZED

The request tried to create a coupon, but the discount was set by both percentage and fixed amount. The request was rejected. Corrective action: Set 'percent_off' or set 'amount_off' and 'currency'.

ERROR_COUPON_WAS_USED_OR_OUT_OF_DATE

The request tried to apply a coupon to a customer, order or subscription, but the coupon was applied its maximum number of times or was expired. The request was rejected. Corrective action: Create a new coupon.

ERROR_CREATE_COUPON_ID_ALREADY_USED

The request tried to create a coupon, but the ID provided was already used. The request was rejected. Corrective action: For the 'id' field, use a unique string.

ERROR_DELETE_COUPON

The request tried to delete a coupon, but the operation failed. Corrective action: Determine whether the coupon was already deleted, and why there were multiple requests to delete it.

ERROR_GET_COUPON

The request attempted an operation that requires the ID of a coupon, but the coupon was not found. The request was rejected. Corrective action: Use the ID of a valid coupon.

ERROR_GET_DISCOUNT

The request attempted an operation that requires the ID of a coupon, but the coupon was not found. The request was rejected. Corrective action: Use the ID of a valid coupon.

INVALID_AMOUNT_OFF_AND_CURRENCY

The request tried to create a coupon, but 'amount_off' was set and 'currency' was unset or invalid. The request was rejected. Corrective action: Use the correct 3-letter ISO 4217 code for the currency, in uppercase letters.

INVALID_COUPON_AMOUNT_OFF

The request tried to create a coupon, but the amount off was not a positive number. The request was rejected. Corrective action: Use a positive decimal value for 'percent_off'.

INVALID_COUPON_DURATION

The request tried to create a coupon, but the value for the 'duration' parameter was not recognized. The request was rejected. Corrective action: Set 'duration' to one of the following values: 'forever', 'once', 'repeating'

INVALID_COUPON_LIMIT

The request tried to retrieve a list of coupons, but the 'limit' query parameter was out of range. The request was rejected. Corrective action: Set 'limit' to an integer between 10 and 100.

INVALID_COUPON_PERCENT_OFF

The request tried to create a coupon, but the percent off was less than 1 or greater than 100. The request was rejected. Corrective action: Set 'percent_off' to an integer between 0-100.

INVALID_COUPON_PERCENT_AND_AMOUNT_OFF

The request tried to create a coupon, but the type of discount could not be determined. The request was rejected. Corrective action: Set 'percent_off' or set 'amount_off' and 'currency'.

INVALID_PERCENT_OFF

The request tried to create a coupon, but the percent off was less than 1 or greater than 100. The request was rejected. Corrective action: Use an integer value between 0-100 for 'percent_off'.

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.

ERROR_HOSTED_PAGE_BENEFICIARY_INVALID_CATEGORY

The request tried to create a beneficiary tokenization page, but the payout category was not valid. The request was rejected. Corrective action: Set 'category' to 'bank' or 'card'.

ERROR_HOSTED_PAGE_BENEFICIARY_INVALID_COMPANY_NAME

The request attempted to create a beneficiary with a hosted page, but the type of entity for the beneficiary was 'individual' and a company name was provided. The request was rejected. Corrective action: Set ‘sender_entity_type’ to ‘company’ or leave 'company_name' blank.

ERROR_HOSTED_PAGE_BENEFICIARY_INVALID_EXPIRATION_TIMESTAMP

The request tried to create a beneficiary tokenization page, but the page expiration timestamp was not valid. The request was rejected. Corrective action: Set 'page_expiration' to a Unix timestamp in the future.

ERROR_HOSTED_PAGE_BENEFICIARY_INVALID_IDENTIFICATION_TYPE

The request attempted to create a beneficiary with a hosted page, but the ID type was not valid. The request was rejected. Corrective action: In the 'beneficiary_optional_fields' object, set a valid value for 'identification_type'. For details, see the API reference.

ERROR_HOSTED_PAGE_BENEFICIARY_INVALID_IDENTIFICATION_VALUE

The request attempted to create a beneficiary with a hosted page, but the ID value was not valid. The request was rejected. Corrective action: In the 'beneficiary_optional_fields' object, set 'identification_value' to a string.

ERROR_HOSTED_PAGE_INVALID_BENEFICIARY_ENTITY_TYPE

The request attempted to create a beneficiary with a hosted page, but the type of entity for the beneficiary was not recognized. The request was rejected. Corrective action: Set 'beneficiary_entity_type' to 'individual' or 'company'.

ERROR_HOSTED_PAGE_INVALID_SENDER_ENTITY_TYPE

The request attempted to create a beneficiary with a hosted page, but the type of entity for the sender was not recognized. The request was rejected. Corrective action: Set ‘sender_entity_type’ to ‘individual’ or ‘company’.

ERROR_UPLOAD_DOCUMENT_NOT_PROVIDED

The request attempted to upload a document, but no document file was provided. The request was rejected. Corrective action: Rerun the request with a valid document file.

ERROR_UPLOAD_FILE_SIZE_TOO_LARGE

The file size is too large. Please contact Rapyd Client Support.

ERROR_UPLOAD_FILE_TOO_MANY_FILES

The request attempted to upload multiple document files, but it includes too many files. The request was rejected. Corrective action: Lower the number of files in the request and resend it.

ERROR_NAME_OF_DOCUMENT_IS_TOO_LONG

The request attempted to upload a document, but the document’s file name is too long. The request was rejected. Corrective action: Rename the file according to the length limitation.

ERROR_UPLOAD_FILE_UNSUPPORTED_FILE_TYPE

The request tried to upload a file, but the file type was not supported. The request was rejected. Corrective action: Upload a file that is of a supported file type.

ERROR_CREATE_USER_INVALID_EWALLET_REFERENCE_ID

The request tried to create a wallet, but the ewallet reference ID was not valid. The request was rejected. Corrective action: Set ‘ewallet_reference_id’ to a string of less than 200 characters.

ERROR_CREATE_USER_EWALLET_REFERENCE_ID_ALREADY_EXISTS

The request tried to create a wallet, but the reference ID was already in use. The request was rejected. Corrective action: For 'ewallet_reference_id', enter a unique string.

ERROR_EWALLET_ALREADY_ASSIGNED_TO_THIS_CUSTOMER

The request tried to assign a wallet to a customer, but the customer already had this wallet. The request was rejected. Corrective action: None. Determine why an effort was made to duplicate this assignment.

ERROR_EWALLET_DISABLED

The request attempted an operation that requires a wallet, but the wallet is disabled. The request was rejected. Corrective action: Enable the wallet.

ERROR_FIRST_NAME_CONTAINS_ILLEGAL_CHARS

The request attempted an operation that requires a person's first name, but the name contained special characters. The request was rejected. Corrective action: Use only alphabetic characters and spaces for 'first_name'.

ERROR_GET_EWALLET

The request attempted an operation that requires a wallet, but the wallet was not found. The request was rejected. Corrective action: Use the ID of a valid wallet, a string starting with 'ewallet_'.

ERROR_GET_USER

The request attempted an operation that requires a wallet, but the wallet was not found. The request was rejected. Corrective action: Use the ID of a valid wallet that has not been deleted. The ID is a string starting with 'ewallet_'.

ERROR_INVALID_EWALLET

The request attempted an operation that requires a wallet, but the wallet was not recognized. The request was rejected. Corrective action: Use the ID of a valid wallet, a string starting with 'ewallet_'.

ERROR_INVALID_EWALLET_REFERENCE_ID

The request attempted an operation that requires the ewallet reference ID, but the ewallet ID was not valid. The request was rejected. Corrective action: Set 'ewallet_reference_id' to a string of less than 200 characters.

ERROR_INVALID_EWALLET_TYPE

The request attempted an operation that requires the 'type' parameter, but the 'type' was not a recognized value. The request was rejected. Corrective action: Set 'type' to one of the following values: 'person', 'company', 'client'.

ERROR_INVALID_EWALLET_VERIFICATION_STATUS

The request attempted an operation that requires the verification status, but the verification status was not valid. The request was rejected. Corrective action: Set 'verification_status' to one of the following values: 'verified', 'not verified'

ERROR_NOT_PERSON_WALLET

The request attempted an operation that requires a wallet with 'type' = 'person', but the wallet was not of that type. The request was rejected. Corrective action: None. Use a wallet with 'type' set to 'person'.

ERROR_PAYCODE_AND_REFUND_CODE_OBSOLETE

The request attempted an operation that requires a pay code or refund code, but these codes are now obsolete. The request was rejected. Corrective action: Use 'Create Payment' and related methods.

ERROR_UPDATE_EWALLET_TYPE

The request tried to update a wallet type, but the 'type' cannot be changed. The request was rejected. Corrective action: None. Create a new wallet.

ERROR_UPDATE_FUNDS

The request tried to add funds to or remove funds from a wallet, but the wallet was not found. The request was rejected. Corrective action: Use a valid wallet phone number in E.164 format, or a valid wallet ID, which is a string starting with 'ewallet_'.

ERROR_UPDATE_USER

The request tried to update a wallet, but the wallet was not found. The request was rejected. Corrective action: Use a valid wallet phone number in E.164 format, or a valid wallet ID, which is a string starting with 'ewallet_'.

ERROR_UPDATE_USER_EWALLET_REFERENCE_ID_ALREADY_EXISTS

The request tried to update a wallet, but the reference ID was already in use. The request was rejected. Corrective action: For 'ewallet_reference_id', enter a unique string.

ERROR_WALLET_INSUFFICIENT_FUNDS

The request tried to transfer funds from a Rapyd wallet, but the wallet did not have sufficient funds in the required currency. The request was rejected. Corrective action: Transfer funds to the wallet in the required currency and resubmit the request.

ERROR_WALLET_TYPE_NOT_PERSON

The request attempted an operation that requires a 'person' wallet, but the wallet was not of that type. The request was rejected. Corrective action: None. Set 'ewallets.ewallet' to the ID of a Rapyd Wallet of type 'person'.

EWALLET_BUSINESS_DETAILS_ADDRESS_LINE1_NOT_VALID

The request created a company wallet, but the first line of the business address was not found. The wallet was created with no 'business_details' object, and it is not valid without it. Corrective action: Use 'Update Wallet' to set 'line1' in the 'address' object to a string made up of alphabetic characters and spaces.

EWALLET_BUSINESS_DETAILS_ADDRESS_NAME_NOT_VALID

The request created a company wallet, but the name associated with the business address was not found or contained special characters. The wallet was created with no 'business_details' object, and it is not valid without it. Corrective action: Use 'Update Wallet' to set 'name' in the 'address' object to a string made up of alphabetic characters and spaces.

EWALLET_UPDATED_WITH_NO_BUSINESS_DETAILS_DUE_TO_INVALID_ADDRESS

The request tried to update a wallet, but the business address was missing required information or contained special characters. The request was rejected. Corrective action: Inside the 'address' object, which is inside the 'business_details' object, provide 'name' with alphanumerics and spaces and 'line_1' with a string.

EWALLET_WITH_ACCOUNT_CANNOT_BE_DELETED

The request tried to delete a wallet, but the wallet held an account. The request was rejected. Corrective action: None. Determine why an attempt was made to delete the wallet.

EWALLET_WITH_VIRTUAL_ACCOUNT_CANNOT_BE_DELETED

The request tried to delete a wallet, but the wallet held a virtual account. The request was rejected. Corrective action: Close all of the wallet’s virtual accounts and try again.

INVALID_ACCOUNT_LIMIT_TYPE

The request attempted an operation on a wallet account, but the balance type was not recognized or the account was not found. The request was rejected. Corrective action: Make sure the wallet has the indicated account, and set 'type' to 'max_balance_limit' or 'min_balance_threshold'.

INVALID_EMAIL

The request attempted an operation that requires an email address, but the email was not valid or is already in use. The request was rejected. Corrective action: Provide a valid, unique email address for 'email'.

INVALID_EWALLET_ACCOUNT_ID

The request tried to set or delete a limit on a wallet account, but the account was not found. The request was rejected. Corrective action: Add funds to the wallet in the currency you want, then set 'account_id' to the correct account ID, or set 'currency' to the currency of the account.

INVALID_EWALLET_TYPE

The request tried to create a wallet, but the wallet type could not be determined. The request was rejected. Corrective action: Set 'type' to 'person' or 'company'.

INVALID_LAST_NAME

The request tried to perform an operation that requires the family name of an individual, but the 'last_name' field was blank or invalid. The request was rejected. Corrective action: Submit a valid last name.

MISSING_EWALLET_CONTACT_TYPE

The request tried to create or update a wallet contact, but the 'contact_type' was missing. The request was rejected. Corrective action: Set 'contact_type' to one of the following values: 'personal', 'business'

MISSING_EWALLET_ID

The request attempted an operation that requires a wallet, but the wallet was not found. The request was rejected. Corrective action: Use the ID of a valid wallet.

MISSING_EWALLET_TOKEN

The request attempted an operation that requires a wallet, but the wallet was not found. The request was rejected. Corrective action: Provide a valid wallet ID.

MISSING_PHONE_NUMBER_OR_EWALLET_ID

The request attempted an operation that requires a wallet, but the wallet was not found. The request was rejected. Corrective action: Provide the wallet's phone number in E.164 format or wallet ID, which is a string starting with 'ewallet_'.

USER_ALREADY_EXISTS

The request tried to assign a phone number to a wallet, but the phone number is already in the database. A wallet must have a unique phone number, but wallet contacts are not restricted. The request was rejected. Corrective action: In the 'contact' object, assign the number to the 'phone_number' field.

BUSINESS_DETAILS_NOT_ALLOWED_FOR_PERSONAL_CONTACT

The request tried to create a personal contact for a Rapyd wallet, but the contact type was 'personal' and business details were given. Business details are not allowed for a personal contact. The request was rejected. Corrective action: In the 'contact' object, set 'business_details' to null.

CANNOT_CREATE_MORE_THAN_ONE_BUSINESS_CONTACT

The request tried to add a second business contact to a company wallet, but a company wallet can have only one business contact. The request was rejected. Corrective action: Set 'contact_type' to 'personal'.

CREATE_PERSONAL_WALLET_REQUIRES_PERSONAL_CONTACT

The request tried to create a personal wallet, but the contact type was 'business'. The request was rejected. Corrective action: In the 'contact' object, set 'contact_type' to 'personal'.

ERROR_ADD_CONTACT_TOO_MANY_CONTACTS

The request tried to add a contact to a personal wallet, but a personal wallet can have only one contact. The request was rejected. Corrective action: None. Determine why an attempt was made to give a personal wallet two contacts. Consider creating a company wallet.

ERROR_CREATE_EWALLET_CONTACT

The request tried to create a contact in a wallet, but the operation failed. Corrective action: Verify that the wallet exists, and check all input parameters.

ERROR_CREATE_PERSONAL_CONTACT_WRONG_IDENTIFICATION_TYPE

The request tried to create a personal contact for a wallet, but the type of identification is not supported for a personal contact. The request was rejected. Corrective action: Set 'identification_type' to one of the values for a personal contact, as returned in the response to 'List Official Identification Documents'.

ERROR_DEFAULT_CONTACT_PHONE_NUMBER_DIFFERENT_THAN_EWALLET_PHONE_NUMBER

The request tried to create a wallet, but there was a mismatch between the phone numbers provided. The request was rejected. Corrective action: If you provide a phone number for the wallet, it must have the same value as the 'phone_number' field in the 'contact' object.

ERROR_DELETE_BUSINESS_CONTACT

The request tried to remove a business contact from a company wallet, but this operation is not possible. The request was rejected. Corrective action: None. If you are trying to replace the business contact with another business contact, use 'Update Wallet Contact'.

ERROR_DELETE_CONTACT_FROM_PERSONAL_EWALLET

The request tried to delete a contact, but the wallet was a personal wallet. A personal wallet can have only one contact and it cannot be deleted. The request was rejected. Corrective action: None. Determine why an attempt was made to delete the contact.

ERROR_DELETE_EWALLET_CONTACT

The request tried to delete a contact from a wallet, but the contact was not found. The request was rejected. Corrective action: Determine whether the contact was already deleted, and why there were multiple requests to delete it.

ERROR_EWALLET_CONTACT_ADDRESS_CITY_NOT_FOUND

The request attempted an operation that requires a wallet contact, but the city of the contact was not found. The request was rejected. Corrective action: Use 'Update Wallet Contact' to add the name of the city to the 'city' field in the 'address' object.

ERROR_EWALLET_CONTACT_COUNTRY_NOT_SUPPORTED

The request tried to create or update a wallet contact, but the country is not supported. The request was rejected. Corrective action: Contact Rapyd Client Support.

ERROR_EWALLET_CONTACT_NOT_FOUND

The request attempted an operation that requires a wallet contact, but the contact was not found. The request was rejected. Corrective action: Provide the ID of a valid wallet contact, which is a string starting with 'cont_'.

ERROR_GET_EWALLET_CONTACT

The request attempted an operation that requires a wallet contact, but the contact was not found. The request was rejected. Corrective action: In the path, specify the ID of a valid wallet, a string starting with 'ewallet', and the ID of a valid contact belonging to that wallet, a string starting with 'cont'.

ERROR_UPDATE_EWALLET_CONTACT

The request tried to update a business wallet contact, but there was a format error in the business details. The request was rejected. Corrective action: Provide all data in the correct format. See the API reference.

ERROR_UPDATE_WALLET_CONTACT_TYPE

The request tried to change the type of a wallet contact, but this operation is not allowed. The request was rejected. Corrective action: None. Create a new wallet with the type of contact you want.

ERROR_WALLET_CONTACT_NATIONALITY_CODE_NOT_VALID

The request tried to add or update a nationality, but it was not in the correct format. The request was rejected. Corrective action: In the 'country' field, enter the 2-letter ISO 3166-1 ALPHA-2 country code.

EWALLET_BUSINESS_DETAILS_ADDRESS_NAME_NOT_VALID

The request created a wallet, but the address of the contact did not have a name. The wallet was created and it is not valid without it. Corrective action: Contact Client Support.

EWALLET_BUSINESS_DETAILS_ADDRESS_LINE1_NOT_VALID

The request created a wallet, but the address of the contact did not have a 'line1’ field or was not an object. The wallet was created and it is not valid without it. Corrective action: Contact Client Support.

EWALLET_UPDATED_WITH_NO_BUSINESS_DETAILS_DUE_TO_INVALID_ADDRESS

The request tried to update a wallet, but the business address was missing required information or contained special characters. The request was rejected. Corrective action: Inside the 'address' object, which is inside the 'business_details' object, provide 'name' with alphanumerics and spaces and 'line_1' with a string.

INVALID_EWALLET_BUSINESS_ENTITY_TYPE

The request tried to create a company wallet, but the entity type was missing or not recognized. The request was rejected. Corrective action: In the 'business_details' object, set 'entity_type' to one of the following values: 'sole_prop', 'partnership', 'company', 'government', 'charity', 'NPO', 'association', 'trust'.

INVALID_EWALLET_BUSINESS_NAME

The request tried to create a company wallet, but the business name was missing or contained special characters. The request was rejected. Corrective action: In the 'business_details' object, set the 'name' field to a string made up of alphabetic characters and spaces.

INVALID_EWALLET_BUSINESS_REGISTRATION_NUMBER

The request tried to create a company wallet, but the business registration number was missing or contained special characters. The request was rejected. Corrective action: In the 'business_details' object, set the 'registration_number' field to a string made up of alphabetic characters and spaces.

INVALID_EWALLET_BUSINESS_SUB_CATEGORY

The request tried to create a company wallet, but 'business_sub_category' contained special characters. The request was rejected. Corrective action: Provide a valid business subcategory.

INVALID_EWALLET_CONTACT_TYPE

The request tried to create or update a wallet contact, but the contact type was not recognized. The request was rejected. Corrective action: Set 'contact_type' to 'personal' or 'business'.

INVALID_EWALLET_INDUSTRY_CATEGORY

The request tried to create a company wallet, but 'industry_category' was not set or contained special characters. The request was rejected. Corrective action: Provide a valid industry category.

INVALID_GENDER

The request tried to create a wallet contact, but the gender was not recognized. The request was rejected. Corrective action: Set 'gender' to one of the following values: 'male', 'female', 'other', 'not_applicable'

INVALID_HOUSE_TYPE

The request tried to create a wallet contact, but the house type was not recognized. The request was rejected. Corrective action: Set 'house_type' to one of the following values: 'lease', 'live_with_family', 'own', 'owner', 'month_to_month', 'housing_project'

INVALID_MARITAL_STATUS

The request tried to create a wallet contact, but the marital status was not recognized. The request was rejected. Corrective action: Set 'marital_status' to one of the following values: 'married', 'single', 'divorced', 'widowed', 'cohabiting', 'not_applicable'

INVALID_MIDDLE_NAME

The request tried to create a wallet contact, but the middle name contained special characters. The request was rejected. Corrective action: Use only alphabetic characters and spaces for 'middle_name'.

INVALID_SECOND_LAST_NAME

The request tried to create a wallet contact, but the second last name contained special characters. The request was rejected. Corrective action: Use only alphabetic characters and spaces for 'second_last_name'.

CANCEL_TRANSACTION_ERROR

The request tried to cancel a wallet transaction, but the transaction was not found. The request was rejected. Corrective action: Provide a valid transaction ID.

COMPLETE_TRANSACTION_ERROR

The request tried to complete a wallet transaction, but the transaction was not found. The request was rejected. Corrective action: Provide a valid transaction ID.

ERROR_AMOUNT_EXCEEDS_DESTINATION_EWALLET_LIMIT

The request attempted an operation that puts funds in a wallet, but the amount exceeds the limit set for that wallet for funds of that currency. The request was rejected. Corrective action: Transfer an amount that does not put the destination wallet over its limit for that currency.

ERROR_AMOUNT_EXCEEDS_DESTINATION_EWALLET_LIMIT_BY_MERCHANT_CONTROLLED_PARAMETERS

The request tried to transfer funds to a wallet, but the amount would cause the wallet to exceed its balance limit. The request was rejected. Corrective action: Remove money from the wallet before trying to add more, or deposit a different amount. To raise the balance limit, you can complete the customer identity verification process.

ERROR_BALANCE_TRANSFER

The request tried to convert currency and transfer it to another wallet, but the destination wallet was disabled. The request was rejected. Corrective action: None. Determine why the destination wallet was disabled.

ERROR_CARD_AUTHENTICATION_FAILURE

The request created a card payment that requires 3DS authentication, but the authentication was not completed in the time allowed. The payment was canceled. Corrective action: None. Create another payment.

ERROR_CREATE_TRANSFER

The request tried to create a transfer of funds from one wallet to another, but one wallet was not found. The request was rejected. Corrective action: Provide valid IDs for both wallets.

ERROR_EWALLET_ACCOUNT_LIMIT_EXCEEDS_CURRENT_BALANCE

The request tried to create or update a limit on a wallet currency account, but the limit offered was lower than the amount of currency in the account. The request was rejected. Corrective action: Set a limit that is less than or equal to the amount currently in the account.

ERROR_EWALLET_LIMIT_NOT_VALID

The request tried to create or update a limit on a wallet currency account, but the limit was not valid. The request was rejected. Corrective action: Use a positive number.

ERROR_EWALLET_TRANSFER_DESTINATION_EWALLET_DISABLED

The request tried to transfer funds to a wallet, but the wallet was disabled. The request was rejected. Corrective action: Enable the destination wallet.

ERROR_EWALLET_TRANSFER_ID_NOT_FOUND

The request tried to set a response to a transfer between wallets, but the ID of the transfer transaction was not found. The request was rejected. Corrective action: Use a valid transaction ID.

ERROR_EWALLET_TRANSFER_SOURCE_EWALLET_DISABLED

The request tried to transfer funds from a wallet, but the wallet was disabled. The request was rejected. Corrective action: Enable the source wallet.

ERROR_EWALLET_TRANSFER_SOURCE_EWALLET_NOT_FOUND

The request tried to transfer funds from a wallet, but the wallet was not found. The request was rejected. Corrective action: Use the correct phone number for the source wallet.

ERROR_GET_ACCOUNT_FUNDS_DETAILS

The request tried to retrieve details of a transaction, but the transaction was not found. The request was rejected. Corrective action: Provide a valid transaction ID, which is a UUID.

ERROR_GET_ISSUING_TRANSACTION

The request tried to retrieve a transfer to a virtual account, but the transaction was not found. The request was rejected. Corrective action: In the path, use the ID of the Virtual Account Number object that was issued to the wallet, which is a string starting with 'issuing_'. Also use the ID of the transaction, which is a UUID. To find the transaction ID, use 'Retrieve Virtual Account History'.

ERROR_GET_TRANSACTION

The request tried to retrieve a transaction, but the transaction was not found. The request was rejected. Corrective action: Use the ID of a wallet that has not been closed, and the ID of a transaction that is associated with that wallet.

ERROR_REMOVE_ACCOUNT_LIMIT

The request tried to remove a limit on a wallet account, but the account did not have the indicated limit. The request was rejected. Corrective action: None. Determine why an attempt was made to remove a non-existent limit.

ERROR_RESPONSE_TRANSFER

The request tried to accept, reject or cancel a transfer that was previously declined by the transferee. The request was rejected. Corrective action: If the intent was to accept, create a new transfer. Otherwise, determine why a transfer response was attempted on a declined transaction.

ERROR_TRANSFER_FUNDS_DESTINATION_AND_SOURCE_CANNOT_BE_THE_SAME

The request tried to transfer funds, but the source was the same as the destination. The request was rejected. Corrective action: Set 'source_ewallet' and 'destination_ewallet' to the IDs of two different wallets.

ERROR_TRANSFER_RESPONSE_INVALID_DETAILS

The request tried to accept, reject or cancel a transfer between wallets, but the transaction was not found. The request was rejected. Corrective action: If the intent was to accept, create a new transfer.

ERROR_TRANSFER_RESPONSE_PREVIOUSLY_CANCELED

The request tried to accept, reject or cancel a transfer that was previously canceled by the sender. The request was rejected. Corrective action: If the intent was to accept, create a new transfer. Otherwise, determine why a transfer response was attempted on a canceled transaction.

ERROR_TRANSFER_RESPONSE_PREVIOUSLY_DECLINED

The request tried to accept, reject or cancel a transfer that was previously declined by the transferee. The request was rejected. Corrective action: If the intent was to accept, create a new transfer. Otherwise, determine why a transfer response was attempted on a declined transaction.

ERROR_UPDATE_FUNDS

The request tried to add funds to or remove funds from a wallet, but the wallet was not found. The request was rejected. Corrective action: Set 'ewallet' to the ID of a valid wallet that has not been blocked or deleted. The ID is a string starting with 'ewallet_'.

INVALID_TRANSACTION_ID

The request tried to retrieve a transaction, but the transaction was not found. The request was rejected. Corrective action: Verify that the transaction ID is correct and that it is associated with the wallet specified in 'token'.

INVALID_TRANSFER_DETAILS

The request tried to transfer funds from a wallet to another wallet, but the input parameters were not valid. The request was rejected. Corrective action: For 'currency', use the ISO 4217 code. For 'source_ewallet' and 'destination_ewallet', use the IDs of valid wallets.

INVALID_TRANSFER_STATUS

The request tried to set a response to a transfer between wallets, but the status was not recognized. The request was rejected. Corrective action: Set 'status' to one of the following values: 'accept', 'decline', 'cancel'.

NOT_ENOUGH_FUNDS

The request attempted an operation that requires funds in a specific currency, but there were not sufficient funds in that currency. The request was rejected. Corrective action: Transfer funds to the wallet in the required currency.

TRANSFER_DESTINATION_USER_ID_IS_INVALID

The request tried to transfer funds to a wallet, but the destination wallet was not found. The request was rejected. Corrective action: Use the correct wallet ID for the destination wallet.

WALLET_TO_WALLET_TRANSFER_EXPIRED

The request tried to respond to a wallet-to-wallet transfer, but the transaction had already expired. The request was rejected. Corrective action: Create a new wallet-to-wallet transfer.

WALLET_TRANSFER_NOT_ALLOWED_FOR_COLLECT_WALLET

The request tried to transfer funds from a wallet to wallet, but one of the wallets was a client wallet of type 'collect' and this action is not allowed. The request was rejected. Corrective action: None.

ERROR_GET_ISSUING

The request tried to retrieve a bank account object issued to a wallet, but the ID of the object was not recognized. The request was rejected. Corrective action: Provide the ID of a valid issued bank account object, a string starting with 'issuing_'.

ERROR_GET_ISSUING_TRANSACTION

The request tried to retrieve a transfer to a virtual account, but the transaction was not found. The request was rejected. Corrective action: In the path, use the ID of the Virtual Account Number object that was issued to the wallet, which is a string starting with 'issuing_'. Also use the ID of the transaction, which is a UUID. To find the transaction ID, use 'Retrieve Virtual Account History'.

ERROR_ISSUE_BANK_ACCOUNT_NUMBER_WALLET_CONTACT_DATA_MISSING

The request tried to issue a bank account number to a wallet, but required data in the wallet is missing. The request was rejected. Corrective action: Use 'Update Wallet' to add the fields listed at the end of the error code. For more information, see the API Reference.

ERROR_ISSUE_BANK_ACCOUNT_NUMBER_WALLET_DATA_MISSING

The request tried to issue a bank account number to a wallet, but required data in the wallet is missing. The request was rejected. Corrective action: Use 'Update Wallet' to add the fields listed at the end of the error code. For more information, see the API Reference.

ERROR_ISSUING_BANK_ACCOUNT_COUNTRY_CURRENCY_MISMATCH

The request tried to issue a virtual account number to a wallet, but the currency is not supported for the country provided. The request was rejected. Corrective action: Contact Client Support.

ERROR_ISSUING_DEPOSIT

The request tried to simulate a deposit to a bank account number that was issued to a wallet in the sandbox, but the bank account was not found. The request was rejected. Corrective action: For 'issued_bank_account', use the ID of a bank account number that was issued to a wallet. The ID is a string starting with 'issuing'.

ERROR_ISSUING_VIRTUAL_ACCOUNT_REQUEST_NOT_SUPPORTED

The request attempted to issue a virtual account to a wallet, but this request is not supported. The request was rejected. Corrective action: Contact Rapyd Support.

ERROR_ISSUING_VIRTUAL_ACCOUNT_WITH_TRANSACTIONS_ON_HOLD_CANNOT_BE_CLOSED

The request tried to close a virtual account, but virtual account transactions were on hold for compliance review. The request was rejected. Corrective action: Contact Rapyd Support.

INVALID_EWALLET_TOKEN

The request tried to issue a virtual account number to a wallet, but the wallet ID was missing from the request. The request was rejected. Corrective action: In the 'ewallet' field, provide the ID of a valid wallet, a string starting with 'ewallet_'.

ERROR_ACTIVATE_BLOCKED_CARD

The request tried to activate an issued card, but the card was blocked. The request was rejected. Corrective action: Contact Rapyd Client Support.

ERROR_ACTIVATE_CARD_NOT_PERSONALIZED

The request tried to activate a bulk-issued card, but the card was not personalized. The request was rejected. Corrective action: Personalize the card.

ERROR_ACTIVATE_ISSUED_CARD

The request tried to activate an issued card, but the card was not found. The request was rejected. Corrective action: For 'card_number', use the number of an issued card.

ERROR_AUTHORIZATION_INVALID_AMOUNT

The request tried to simulate an authorization operation on a card transaction, but the amount was not valid. The request was rejected. Corrective action: Set 'amount' to a positive decimal number.

ERROR_AUTHORIZATION_INVALID_CURRENCY

The request tried to simulate an authorization operation on a card transaction, but the currency was not valid. The request was rejected. Corrective action: Set 'currency' to a 3-letter ISO 4217 code.

ERROR_AUTHORIZATION_INVALID_FINANCIAL_IMPACT

The request tried to simulate an adjustment of a card transaction, but the financial impact was not valid. The request was rejected. Corrective action: Set 'financial_impact' to 'credit' or 'debit'.

ERROR_AUTHORIZATION_MISSING_AMOUNT

The request tried to simulate an authorization operation on a card transaction, but the amount was not found. The request was rejected. Corrective action: Set 'amount' to a positive decimal number.

ERROR_AUTHORIZATION_MISSING_CARD_ID

The request tried to simulate an authorization operation on a card transaction, but the card was not found. The request was rejected. Corrective action: Set 'card_id' to the card ID, a string starting with 'card'.

ERROR_AUTHORIZATION_MISSING_CARD_TRANSACTION_ID

The request tried to simulate an adjustment of a card transaction, but the transaction was not found. The request was rejected. Corrective action: Set 'card_transaction_id' to the ID of the transaction, a string starting with 'cit'.

ERROR_AUTHORIZATION_MISSING_CURRENCY

The request tried to simulate an authorization operation on a card transaction, but the currency was not found. The request was rejected. Corrective action: Set 'currency' to a 3-letter ISO 4217 code.

ERROR_AUTHORIZATION_MISSING_FINANCIAL_IMPACT

The request tried to simulate an authorization operation on a card transaction, but the financial impact was not found. The request was rejected. Corrective action: Set 'financial_impact' to 'credit' or 'debit'.

ERROR_CARD_AUTHORIZATION

The request tried to simulate an authorization operation on a card transaction, but the card was not active. The request was rejected. Corrective action: Run 'Activate Issued Card'.

ERROR_CARD_NOT_FOUND

The request attempted to retrieve data on a non-existent card or a card that is not linked to your account. The request was rejected. Corrective action: Check the card token and rerun the request with the correct card details.

ERROR_CREATE_ISSUED_CARD

The request tried to personalize a card, but the card was already personalized to another wallet contact. The request was rejected. Corrective action: For 'card_number', use the card number of a different card that was issued in bulk.

ERROR_EWALLET_ADDRESS_NOT_FOUND

The request tried to issue a card to a wallet contact, but the contact does not have an address. The request was rejected. Corrective action: Use 'Update Wallet Contact' to add an 'address' object to the contact.

ERROR_EWALLET_CONTACT_LAST_NAME_NOT_FOUND

The request tried to issue a card to a contact on a wallet, but the contact was a personal contact and did not have a last name. The request was rejected. Corrective action: Update the contact and set 'last_name', or use a business contact.

ERROR_GET_CARD

The request attempted an operation that requires a card ID, but the card was not found. The request was rejected. Corrective action: In the 'card' field, provide the ID or card number of a valid card.

ERROR_GET_CARD_ISSUING_TRANSACTION

The request attempted an operation that requires a transaction for an issued card, but the transaction was not found. The request was rejected. Corrective action: Use the ID of an issued card, which is a string starting with 'card', and the ID of a transaction created on that card, which is a string starting with 'cit'.

ERROR_GET_LIST_CARD_PROGRAM

The request tried to list transactions for an issued card, but the 'page_size' query parameter was not valid. The request was rejected. Corrective action: Set 'page_size' to a positive integer.

ERROR_ISSUE_CARD_CONTACT_COUNTRY_NOT_VALID

The request tried to issue a card to a wallet contact, but the country of the contact is not valid for this card program. The request was rejected. Corrective action: Use ‘Update Wallet Contact' to update 'address.country'.

ERROR_ISSUE_CARD_CONTACT_DATA_NOT_VALID

The request tried to issue a card to a wallet contact, but required data in the contact is not valid. The request was rejected. Corrective action: Use 'Update Wallet Contact' to correct the values of all of the fields listed at the end of the error code. For more information, see the API Reference.

ERROR_ISSUE_CARD_CONTACT_DATE_OF_BIRTH_NOT_VERIFIED

The request tried to issue a card to a wallet contact, but the contact's date of birth could not be verified. The request was rejected. Corrective action: Use 'Update Wallet Contact' to correct the 'date_of_birth' field.

ERROR_ISSUE_CARD_CONTACT_ID_NUMBER_NOT_VERIFIED

The request tried to issue a card to a wallet contact, but the contact's identification number could not be verified. The request was rejected. Corrective action: Resubmit the request after one minute. If the error persists, contact Client Support.

ERROR_ISSUE_CARD_CONTACT_ID_TYPE_NOT_VALID

The request tried to issue a card, but the identification type required by the card program was not provided. The request was rejected. Corrective action: Use 'Update Wallet Contact' to set 'identification_type' to 'ID'.

ERROR_ISSUE_CARD_CONTACT_STREET_ADDRESS_NOT_VALID

The request tried to issue a card to a wallet contact, but the card program requires a specific format for the street address in the contact. The request was rejected. Corrective action: Use 'Update Wallet Contact' to correct the value of the 'line_1' field mentioned at the end of the error code. The street name appears first, then an optional comma, and then the house or building number. If there is no number, use '0'.

ERROR_ISSUE_CARD_MISSING_CONTACT_DATA

The request tried to issue a card to a wallet contact, but required data is missing from the contact. The request was rejected. Corrective action: Use 'Update Wallet Contact' to add valid values to all of the fields listed at the end of the error code. For more information, see the API Reference.

ERROR_ISSUE_CARD_CONTACT_MISSING_ID_NUMBER

The request tried to issue a card to a wallet contact, but identification number required by the card program was not provided. The request was rejected. Corrective action: Use 'Update Wallet Contact' to add a valid value to the ‘identification_number’ field.

ERROR_ISSUE_CARD_CONTACT_MOTHERS_NAME_NOT_VERIFIED

The request tried to issue a card to a wallet contact, but the name of the contact's mother could not be verified. The request was rejected. Corrective action: Use 'Update Wallet Contact' to correct the 'mothers_name' field.

ERROR_ISSUE_CARD_CONTACT_NAME_NOT_VERIFIED

The request tried to issue a card to a wallet contact, but the contact's name could not be verified. The request was rejected. Corrective action: Use 'Update Wallet Contact' to correct the 'first_name' and 'last_name' fields.

ERROR_ISSUE_CARD_CONTACT_STREET_ADDRESS_NOT_VALID

The request tried to issue a card to a wallet contact, but the card program requires a specific format for the street address in the contact. The request was rejected. Corrective action: Use 'Update Wallet Contact' to correct the value of the 'line_1' field mentioned at the end of the error code. The street name appears first, then an optional comma, and then the house or building number.

ERROR_ISSUE_CARD_MISSING_CONTACT_DATA

The request tried to issue a card to a wallet contact, but required data is missing from the contact. The request was rejected. Corrective action: Use 'Update Wallet Contact' to add valid values to all of the fields listed at the end of the error code. For more information, see the API Reference.

ERROR_ISSUE_CARD_PERSONAL_CONTACT_MISSING

The request tried to issue a card to a business contact, but the company wallet does not have any personal contacts. The request was rejected. Corrective action: Run 'Add Contact to Wallet' and complete the identity verification process.

ERROR_ISSUE_CARD_PERSONAL_CONTACT_NOT_VERIFIED

The request tried to issue a card to a business contact, but none of the personal contacts in the company wallet has permissions to run transactions. The request was rejected. Corrective action: Complete the identity verification process for one of the personal contacts.

ERROR_ISSUE_CARD_PERSONAL_CONTACT_TYPE_MISMATCH

The request tried to issue a card to a personal contact, but the card program type is 'business'. The request was rejected. Corrective action: For 'card_program', use the ID of a personal card program.

ERROR_ISSUED_CARD

The request tried to issue a card, but the contact was not found. The request was rejected. Corrective action: For 'ewallet_contact', use the ID of a valid wallet contact, a string starting with 'cont'.

ERROR_ISSUED_CARD_ALREADY_ACTIVATED

The request tried to activate an issued card, but the card was already activated. The request was rejected. Corrective action: None. Determine why there were multiple attempts to activate the card.

ERROR_ISSUED_CARD_BLOCKED

The request attempted an action on an issued card, but the card is blocked. The request was rejected. Corrective action: Unblock the card.

ERROR_ISSUED_CARD_PIN_NUMBER_NOT_VALID

The request tried to set a PIN number for an issued card, but the PIN number was not valid. The request was rejected. Corrective action: Set 'new_pin' to a numeric string.

ERROR_ISSUED_CARD_PIN_FORMAT_NOT_VALID

The request tried to set a PIN for an issued card, but the format of the PIN was not valid. The request was rejected. Corrective action: Set 'new_pin' to a numeric string.

ERROR_ISSUED_CARD_STATUS_NOT_SUPPORTED

The request tried to update the status of an issued card, but the value provided was not valid. The request was rejected. Corrective action: Set 'status' to 'block' or 'unblock'.

ERROR_ISSUING_DEPOSIT

The request tried to simulate a deposit to a virtual account number that was issued to a wallet in the sandbox, but the virtual account was not found. The request was rejected. Corrective action: For 'issued_bank_account', use the ID of a Virtual Account Number that was issued to a wallet, which is a string starting with 'issuing'.

ERROR_MISSING_PIN_NUMBER

The request tried to set a PIN for an issued card, but the new PIN was not found. The request was rejected. Corrective action: Set 'new_pin' to a numeric string.

ERROR_MISSING_EWALLET_CONTACT_EWALLET_ID

The request attempted an operation that requires a wallet contact, but the contact was not found. The request was rejected. Corrective action: For 'ewalletcontact', use the ID of a valid wallet contact, a string starting with 'cont'._

ERROR_PERSONALIZE_ISSUED_CARD

The request tried to personalize an issued card, but the card was already personalized or the card number was not found. The request was rejected. Corrective action: Set 'card_number' to a valid card number.

ERROR_READ_CARD_ISSUED_DETAILS

The request attempted an operation that requires an issued card, but the card was not activated. The request was rejected. Corrective action: Activate the card.

ERROR_SIMULATE_CLEARING_FINANCIAL_IMPACT_NOT_VALID

The request tried to simulate a clearing operation on a card transaction, but the preceding simulated authorization was a credit transaction. The request was rejected. Corrective action: None. A credit transaction is complete on completion of the authorization.

ERROR_SIMULATE_CLEARING_MISSING_FIELD_FOR_FEE

The request tried to simulate a clearing operation on a card transaction, but only 'category' or 'fee_amount' was set. The request was rejected. Corrective action: Set both fields

ERROR_UPDATE_CARD_CVV_NOT_UPDATABLE

The request tried to update the CVV of a card, but this value cannot be updated. The request was rejected. Corrective action: None. Determine why an attempt was made to update the CVV.

ERROR_UPDATE_ISSUED_CARD_STATUS

The request tried to update the status of an issued card, but the card number was not found or not recognized. The request was rejected. Corrective action: For 'card_number', use the number of an issued card.

INVALID_EWALLET_TOKEN

The request tried to issue a virtual account number to a wallet, but the wallet ID was missing from the request. The request was rejected. Corrective action: In the 'ewallet' field, provide the ID of a valid wallet, a string starting with 'ewallet_'.

INVALID_ISSUED_CARD_CHANGE_STATUS

The request tried to block or unblock a card, but the card is already in that status, or it has not been activated or personalized. The request was rejected. Corrective action: If the card was issued in bulk, personalize it. If the card was issued through the API, activate it.

NOT_SUPPORTED_CARD_NUMBER_FOR_PERSONALIZE

The request tried to personalize a card, but the card was not issued in bulk. The request was rejected. Corrective action: For 'card_number', use the card number of a valid card that was issued in bulk.

ERROR_AUTHORIZATION_INVALID_AMOUNT

The request tried to simulate an authorization operation on a card transaction, but the amount was not valid. The request was rejected. Corrective action: Set 'amount' to a positive decimal number.

ERROR_AUTHORIZATION_INVALID_CURRENCY

The request tried to simulate an authorization operation on a card transaction, but the currency was not valid. The request was rejected. Corrective action: Set 'currency' to a 3-letter ISO 4217 code.

ERROR_AUTHORIZATION_MISSING_AMOUNT

The request tried to simulate an authorization operation on a card transaction, but the amount was not found. The request was rejected. Corrective action: Set 'amount' to a positive decimal number.

ERROR_AUTHORIZATION_MISSING_CARD_ID

The request tried to simulate an authorization operation on a card transaction, but the card was not found. The request was rejected. Corrective action: Set 'card_id' to the card ID, a string starting with 'card’.

ERROR_AUTHORIZATION_MISSING_CARD_TRANSACTION_ID

The request tried to simulate an authorization operation on a card transaction, but the transaction was not found. The request was rejected. Corrective action: Set 'card_transaction_id' to the ID of the transaction, a string starting with 'cit’.

ERROR_AUTHORIZATION_MISSING_CURRENCY

The request tried to simulate an authorization operation on a card transaction, but the currency was not found. The request was rejected. Corrective action: Set 'currency' to a 3-letter ISO 4217 code.

ERROR_AUTHORIZATION_MISSING_FINANCIAL_IMPACT

The request tried to simulate an authorization operation on a card transaction, but the financial impact was not found. The request was rejected. Corrective action: Set 'financial_impact' to 'credit' or 'debit'.

ERROR_SIMULATE_CLEARING_FINANCIAL_IMPACT_NOT_VALID

The request tried to simulate a clearing operation on a card transaction, but the preceding simulated authorization was a credit transaction. The request was rejected. Corrective action: None. A credit transaction is complete on completion of the authorization.

ERROR_SIMULATE_CLEARING_MISSING_FIELD_FOR_FEE

The request tried to simulate a clearing operation on a card transaction, but only 'category' or 'fee_amount' was set. The request was rejected. Corrective action: Set both fields.

ERROR_SET_PIN_BY_HOSTED_PAGE_NOT_ALLOWED

The request attempted an action that would allow the customer to reset the PIN on a hosted page, but the card program permits only viewing the PIN. The request was rejected. Corrective action: Set 'skip_view_pin' to false and advise the customer to set the PIN at an ATM.

ERROR_SET_PIN_SERVICE_NOT_AVAILABLE

The request tried to set a PIN for an issued card, but this operation is not allowed by the card program. The request was rejected. Corrective action: None. Advise the cardholder to set the PIN at an ATM.

ERROR_VIEW_PIN_ALREADY_USED

The request attempted to view an issued card pin, but the action was already completed. The request was rejected. Corrective action: Generate a new pin page.

ERROR_ID_VERIFICATION

The request tried to validate identity, but the operation failed. The request was rejected. Corrective action: Check all parameters and provide a unique reference ID for each identity verification operation, whether successful or unsuccessful.

ERROR_ID_VERIFICATION_ALREADY_COMPLETE

The request tried to verify the identity of a wallet contact, but the identity was already verified and cannot be verified twice. The request was rejected. Corrective action: None. Determine why multiple attempts were made to verify the same identity.

ERROR_ID_VERIFICATION_ALREADY_IN_PROGRESS

The request tried to verify the identity of a wallet contact, but the verification process is still pending. The request was rejected. Corrective action: Wait for the process to complete.

ERROR_ID_VERIFICATION_AUTHENTICITY_FAILED

The request tried to validate identity, but the operation failed due to the authenticity of the document. The request was rejected. Corrective action: Upload a scan of a legal and valid ID document that passes the authenticity tests. If issue persists, contact support.

ERROR_ID_VERIFICATION_BACK_SIDE_IMAGE_ENCODING_INVALID

The request tried to validate identity, but the back side image provided was not properly encoded into Base64. The request was rejected. Corrective action: Convert the image into Base64 encoding, using all options that are required, as verified by your testing.

ERROR_ID_VERIFICATION_BACK_SIDE_IMAGE_MIME_TYPE_INVALID

The request tried to validate identity, but the back side image provided was not the correct MIME type. The request was rejected. Corrective action: Use a JPEG or PNG image.

ERROR_ID_VERIFICATION_BACK_SIDE_IMAGE_MISSING

The request tried to validate identity, but the required back side image was not found. The request was rejected. Corrective action: Submit the back side image with JPEG or PNG format, Base-64 encoded.

ERROR_ID_VERIFICATION_BARCODE_NOT_DECODED

The request tried to validate identity, but the barcode on the image was not decoded. The request was rejected. Corrective action: Upload an image with a clear, readable, and decodable barcode.

ERROR_ID_VERIFICATION_BARCODE_NOT_READABLE

The request tried to validate identity, but the barcode on the image was not readable. The request was rejected. Corrective action: Upload an image with a clear and readable barcode.

ERROR_ID_VERIFICATION_COUNTRY_MISMATCH

The request tried to validate identity, but the operation failed due to a country mismatch. The request was rejected. Corrective action: Upload a document that matches the declared country.

ERROR_ID_VERIFICATION_DOCUMENT_BLOCKED

The request tried to validate identity, but the document is in a blocked list. The request was rejected. Corrective action: Upload another document.

ERROR_ID_VERIFICATION_DOCUMENT_FLAGGED

The request tried to validate identity, but the document is in a flagged list. The request was rejected. Corrective action: Upload another document.

ERROR_ID_VERIFICATION_DUPLICATE_REFERENCE_ID

The request tried to validate identity, but the 'reference_id' body parameter was previously used. The request was rejected. Corrective action: Provide a unique reference ID for each identity verification operation, whether successful or unsuccessful.

ERROR_ID_VERIFICATION_EXPIRED

The request tried to validate the identity, but the operation failed since the document expired. The request was rejected. Corrective action: Upload a valid ID document.

ERROR_ID_VERIFICATION_GRAYSCALE_IMAGE

The request tried to validate identity, but the image is in grayscale format. The request was rejected. Corrective action: Use clear, readable images that are in color.

ERROR_ID_VERIFICATION_INCOMPLETE_DOCUMENT_UPLOAD

The request tried to validate identity, but the document is incomplete. The request was rejected. Corrective action: Upload a complete document.

ERROR_ID_VERIFICATION_INTERNAL_PROCESSING_ERROR

The document was not processed due to an internal error. Corrective action: Use a clear, readable document and upload it again.

ERROR_ID_VERIFICATION_INVALID_IMAGE_MIME_TYPE_OR_SIZE

The request tried to parse a document, but the image provided was not the correct MIME type or the correct size. The request was rejected. Corrective action: Use a JPEG or PNG image that is not larger than the maximum size.

ERROR_ID_VERIFICATION_IMAGE_NOT_RECOGNIZED

The request tried to validate identity, but the image was not recognized. The request was rejected. Corrective action: Use clear, readable images.

ERROR_ID_VERIFICATION_IMAGE_NOT_VALID

The request tried to validate identity, but an image was not valid. The request was rejected. Corrective action: Use clear, readable images.

ERROR_ID_VERIFICATION_INVALID_BACK_SIDE_IMAGE_ENCODING

The request tried to validate identity, but the back side image provided was not properly encoded into Base64. The request was rejected. Corrective action: Convert the image into Base64 encoding, using all options that are required, as verified by your testing.

ERROR_ID_VERIFICATION_BACK_SIDE_IMAGE_IS_REQUIRED

The request tried to validate identity, but the back side image was not provided. The request was rejected. Corrective action: Upload a back side image of the ID that matches the front side image.

ERROR_ID_VERIFICATION_BACK_SIDE_IMAGE_NOT_SUPPORTED

The request tried to validate identity, but the back side image is not supported for this ID. The request was rejected. Corrective action: Upload a back side image of the ID that supports the front side image.

ERROR_ID_VERIFICATION_INVALID_BACK_SIDE_IMAGE_MIME_TYPE

The request tried to parse a document, but the back side image provided was not the correct MIME type. The request was rejected. Corrective action: Use a JPEG or PNG image.

ERROR_ID_VERIFICATION_INVALID_DOCUMENT_TYPE

The request tried to validate identity, but the document provided was not a supported type. The request was rejected. Corrective action: Run 'List Official Identification Documents' to find the documents supported in the country.

ERROR_ID_VERIFICATION_INVALID_EWALLET

The request tried to validate identity, but the associated wallet was not found. Corrective action: In the 'ewallet' field, provide the wallet ID, a string starting with 'ewallet'.

ERROR_ID_VERIFICATION_INVALID_FACE_IMAGE_ENCODING

The request tried to validate identity, but the face image provided was not properly encoded into Base64. The request was rejected. Corrective action: Convert the image into Base64 encoding, using all options that are required, as verified by your testing.

ERROR_ID_VERIFICATION_INVALID_FACE_IMAGE_MIME_TYPE

The request tried to validate identity, but the face image provided was not the correct MIME type. The request was rejected. Corrective action: Use a JPEG or PNG image.

ERROR_ID_VERIFICATION_INVALID_FRONT_SIDE_IMAGE_ENCODING

The request tried to verify identity, but the front side image provided was not properly encoded into Base64. The request was rejected. Corrective action: Convert the image into Base64 encoding using all options that are required, as verified by your testing.

ERROR_ID_VERIFICATION_INVALID_FRONT_SIDE_IMAGE_MIME_TYPE

The request tried to verify identity, but the front side image provided was not the correct MIME type. The request was rejected. Corrective action: Use a JPEG or PNG image.

ERROR_ID_VERIFICATION_INVALID_IDENTIFICATION_TYPE

The request tried to validate identity, but the document type was missing or not recognized. The request was rejected. Corrective action: Provide the required document type. To determine valid types, run 'List Official Identification Documents'.

ERROR_ID_VERIFICATION_INVALID_REFERENCE_ID

The request tried to verify identity, but the reference ID contains more than 36 characters. The request was rejected. Corrective action: Use a reference ID with 36 characters or less.

ERROR_ID_VERIFICATION_LOW_QUALITY_IMAGE

The request tried to validate identity, but the image scan was of low quality. The request was rejected. Corrective action: Use clear, readable images.

ERROR_ID_VERIFICATION_MISSING_BACK_SIDE_IMAGE

The request tried to parse a document, but the required back side image was not found. The request was rejected. Corrective action: Submit the back side image with JPEG or PNG format, Base-64 encoded.

ERROR_ID_VERIFICATION_MISSING_COUNTRY

The request tried to validate identity, but the 'country' body parameter was empty or missing. Corrective action: Provide the 2-letter ISO code for the country in uppercase letters.

ERROR_ID_VERIFICATION_MISSING_DOCUMENT_TYPE

The request tried to validate identity, but the 'document_type' body parameter was empty or missing. Corrective action: Use 'List Official Identification Documents' to find the document types that are supported in the country.

ERROR_ID_VERIFICATION_MISSING_EWALLET

The request tried to validate identity, but the 'ewallet' body parameter was empty or missing. Corrective action: Provide the wallet ID, a string starting with 'ewallet_'.

ERROR_ID_VERIFICATION_MISSING_EWALLET_ID

The request tried to validate identity, but the 'ewallet' body parameter was empty or missing. Corrective action: Provide the wallet ID, a string starting with 'ewallet_'.

ERROR_ID_VERIFICATION_MISSING_FACE_IMAGE

The request tried to validate identity, but the face image was missing. The request was rejected. Corrective action: Provide the face image.

ERROR_ID_VERIFICATION_MISSING_FRONT_SIDE_IMAGE

The request tried to parse a document, but the required front side image was not found. The request was rejected. Corrective action: Submit the front side image with JPEG or PNG format, Base-64 encoded.

ERROR_ID_VERIFICATION_MISSING_REFERENCE_ID

The request tried to validate identity, but the 'reference_id' body parameter was empty or missing. Corrective action: Provide the merchant's reference ID for the identity verification operation.

ERROR_ID_VERIFICATION_MULTIPLE_IMAGE_UPLOAD

The request tried to validate identity, but the document has multiple images. The request was rejected. Corrective action: Upload a document with one image.

ERROR_ID_VERIFICATION_MULTIPLE_PAGE_DOCUMENT

The request tried to validate identity, but document provided has multiple pages. The request was rejected. Corrective action: Upload a single page document.

ERROR_ID_VERIFICATION_MULTIPLE_PAGE_MISMATCH

The request tried to validate identity, but the multiple page document has a mismatch. The request was rejected. Corrective action: Provide the document with no mismatch.

ERROR_MAX_NUMBER_OF_IDENTITY_VERIFICATIONS

The request tried to validate identity, but the maximum number of requests for this individual has been reached. The request was rejected. Corrective action: None. Contact Client Support.

INVALID_DATE_OF_BIRTH

The request tried to add or update a date of birth, but it was not in the correct format or was a date in the future. The request was rejected. Corrective action: Provide a valid birthdate in mm/dd/yyyy format.

INVALID_IDENTIFICATION_NUMBER

The request tried to validate identity, but the ID number was missing or not recognized. The request was rejected. Corrective action: Provide the ID number and verify that it contains only alphanumeric characters and spaces.

INVALID_IDENTIFICATION_TYPE

The request tried to validate identity, but the document type was missing or not recognized. The request was rejected. Corrective action: Provide the required document type. To determine valid types, use 'List Official Identification Documents'.

INVALID_IMAGE_URL

The request attempted an operation that processed a URL for an image, but the operation failed. Corrective action: Provide a valid HTTP or HTTPS URL with a JPG or PNG file extension.

ERROR_HOSTED_PAGE_INVALID_CONTACT

The request attempted a hosted page operation for identity verification process, but the contact was of type 'business' and the verification process is only for personal contacts. The request was rejected. Corrective action: Add a personal contact to the wallet and run the verification process on the personal contact.

ERROR_HOSTED_PAGE_VERIFY_IDENTITY_DOCUMENT_TYPE_NOT_VALID

The request tried to create a hosted page for identity verification, but the type of identification document is not correct for the country specified. The request was rejected. Corrective action: In the 'document_type' field, provide the code for the document type, as appears in the response to 'List Official Identification Documents'.

REQUEST_DECLINED

Your request was declined. For more information, please contact Rapyd Client Service.

REQUEST_UNDER_REVIEW

Your request is under review by Rapyd's operations department. For more information, please contact Rapyd Client Service.

REQUEST_DECLINED_RP

Your request was declined. For more information, please log in to Client Portal.

REQUEST_UNDER_REVIEW_RP

Your request is under review. For more information, please log in to Client Portal.

INVALID_FIELDS

The request attempted an operation, but one of the fields 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.

partner

The value is invalid or the partner is not authorized.

partner_merchant_reference

The value is not a string.

partner_query_reference

The value is not a string.

search_criteria

The object is missing.

business_category

The value is not a string.

dba_name

Incorrect format.

email

Incorrect format.

is_ecommerce

The value is not Boolean.

legal_name

Incorrect format.

mcc

Incorrect format.

phone_numbers

The value is not an array of strings.

url

Incorrect format.

email

Incorrect format.

first_name

The value is not a string.

last_name

The value is not a string.

middle_initial

The value is not a string.

phone_number

Incorrect format.

address_line_1

Incorrect format.

address_line_2

Incorrect format.

city

The value is not a string.

country

The value is not a string with a two-letter ISO 3166-1 ALPHA-2 country code.

postal_code

Incorrect format.

EMAIL_IS_VERIFIED

The request tried to verify the email address of a white level user, but the email was already verified. The request was rejected. Corrective action: Determine why an attempt was made to verify the same email twice.

ERROR_AMOUNT_MUST_BE_POSITIVE

The request attempted an operation that requires an amount, but the amount was negative or zero. The request was rejected. Corrective action: Use a positive decimal number.

ERROR_AMOUNT_NOT_VALID

The request tried to create a transaction, but the amount was not valid. The request was rejected. Corrective action: Set the amount to a positive decimal number.

ERROR_BANK_IDENTIFIER_MISMATCH

The request attempted an operation that requires both an account number and a bank identifier, but the bank portion of the account number does not match the bank identifier. The request was rejected. Corrective action: Verify the account number and bank identifier and retry.

ERROR_CARD_EXPIRED

The request attempted an operation that requires a card, but the card expired. The request was rejected. Corrective action: Advise the cardholder to contact the issuer.

ERROR_CARD_NOT_AUTHENTICATED

The request tried to use a card ID, but the cardholder has not completed the 3DS verification process. The request was rejected. Corrective action: None. Create a new card ID and wait for the cardholder to complete the 3DS process. To create a new card ID, use 'Create Payment', 'Add Payment Method to Customer' or 'Create Card Token - Hosted Page'.

ERROR_CARD_TRANSACTION_AMOUNT

The request attempted an operation to move funds to or from a card, but the transaction amount exceeds the limits set by the card issuer. The request was rejected. Corrective action: Advise the cardholder to contact the issuer.

ERROR_CARD_TRANSACTION_FREQUENCY

The request attempted an operation to move funds to or from a card, but the number of times this operation has been attempted exceeds the limits set by the card issuer. The request was rejected. Corrective action: Advise the cardholder to contact the issuer.

ERROR_CSV_FILE_NOT_VALID

The request tried to upload a CSV file, but there was a problem with the format of the file. The request was rejected. Corrective action: Use a file that has correct CSV formatting.

ERROR_CURRENCY_NOT_AUTHORIZED

The request attempted an operation that requires a currency, but the client is not authorized to use this currency for this action. The request was rejected. Corrective action: Contact Client Support.

ERROR_DATA_NOT_FOUND_IN_RELATED_OBJECT

The request attempted an operation that requires data from an object that is referenced in the request by ID, but the data is missing. The request was rejected. Corrective action: Update the related object.

ERROR_DAYS_UNTIL_DUE_NOT_VALID

The request tried to set or update the 'days_until_due' parameter in an invoice or subscription, but the value was not valid. The request was rejected. Corrective action: Set 'days_until_due' to a positive integer.

ERROR_DUPLICATE_TRANSACTION

The request attempted an operation, but the action was attempted before and completed. The request was rejected. Corrective action: None. Determine why a duplicate attempt was made.

ERROR_GET_CARD

The request attempted an operation that requires a card ID, but the card was not found. The request was rejected. Corrective action: In the 'card' field, provide the ID or card number of a valid card.

ERROR_LIST_PAYMENTS_PAYOUTS_QUERY_MISMATCH

The request tried to list payments or payouts filtered with query parameters, but the query parameters were mutually incompatible. The request was rejected. Corrective action: Use any combination of 'created_before' and 'created_after' or any combination of 'ending_before' and 'starting_after'.

ERROR_MISSING_COUNTRY

The request attempted an operation that requires a country, but the country was not found. The request was rejected. Corrective action: For 'country', use the 2-letter ISO 3166-1 ALPHA-2 code, in uppercase letters.

ERROR_REQUEST_TIMED_OUT

The request attempted an action, but it timed out. The request was probably not processed. Corrective action: Contact Rapyd Client Support.

ERROR_STATEMENT_DESCRIPTOR_TOO_LONG

The request attempted an operation that uses a statement descriptor, but it contained too many characters. The request was rejected. Corrective action: For the 'statement_descriptor' body parameter, use a string of 1-22 alphanumeric characters and spaces.**

ERROR_UNSUPPORTED_CURRENCY

The request attempted an operation that requires a currency, but the value is not supported. The request was rejected. Corrective action: Use a supported currency.

ERROR_WRONG_CARD_TYPE

The request attempted an operation that requires a card, but the card number did not match the card brand. The request was rejected. Corrective action: Use the correct payment method type for the card number.

ERROR_ZERO_AMOUNT

The request attempted an operation that would result in a zero-amount transaction. The request was rejected. Corrective action: Adjust the split or the amount so that the final amounts are all greater than zero.

INVALID_ACCESS_KEY

The request was rejected due to an authentication issue. Corrective action: Check the status of your account in the 'Account Details' page of the Client Portal.

INVALID_ADDRESS_FORMAT

The request attempted an operation that requires an address, but the request provided an array of addresses. The request was rejected. Corrective action: Use a single 'address' object.

INVALID_AMOUNT

The request attempted an operation that requires an amount, but the amount was not found, was not a valid number or was out of bounds. The request was rejected. Corrective action: Use the correct amount.

INVALID_COUNTRY

The request attempted an operation that requires a country, but the value was missing or not recognized. The request was rejected. Corrective action: Use the correct 2-letter ISO 3166-1 ALPHA-2 code for the country, in uppercase letters.

INVALID_COUNTRY_CODE

The request attempted an operation that requires a country code, but the country code was missing or not recognized. The request was rejected. Corrective action: Use the 2-letter ISO 3166-1 ALPHA-2 country code in uppercase letters.

INVALID_CURRENCY

The request attempted an operation that requires a currency, but the value 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.

INVALID_CUSTOMER_EMAIL

The request attempted an operation that requires a valid email address, but the information was not in proper email address format. The request was rejected. Corrective action: Use the correct format for an email address.

INVALID_DESCRIPTION

The request attempted an operation that requires a description, but the description was not found. The request was rejected. Corrective action: In the 'description' field, provide a description of the operation.

INVALID_FIELDS

The request attempted an operation, but one of the fields 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_FIRST_NAME

The request tried to perform an operation that requires the first name of an individual, but the 'first_name' field was blank or invalid. The request was rejected. Corrective action: Provide a valid first name.

INVALID_LIMIT

The request tried to retrieve a list of objects, but the 'limit' query parameter was not set to a valid value. The request was rejected. Corrective action: Set 'limit' to an integer between 1 and 100.

INVALID_NAME

The request attempted an operation that requires a name, but the 'name' field was missing, empty or not recognized. The request was rejected. Corrective action: Use a valid string.

INVALID_PAGE_NUMBER

The request attempted a GET operation that requires a page number, but the value was not recognized. The request was rejected. Corrective action: For 'page_number', use a positive integer.

INVALID_PAGE_SIZE

The request attempted a list operation that requires the size of the page to return, but the page size was not a valid number. The request was rejected. Corrective action: For the 'page_size' query parameter, use a positive integer.

INVALID_PARAMETER

The request attempted to retrieve records, but one of the query parameters did not have a valid value. The request was rejected. Corrective action: Use a valid value. The name of the affected parameter appears at the end of the error code. See the API Reference for details.

INVALID_PHONE_NUMBER

The request attempted an operation that requires a phone number, but the phone number was missing or not recognized. The request was rejected. Corrective action: Use the correct number in E.164 format.

INVALID_REGEX_FIELDS

The request attempted an operation, but one or more of the required fields did not match the expected regular expression pattern. The request was rejected. Corrective action: Use the correct regular expression pattern for all of the fields that are listed at the end of the response code.

INVALID_ROUTING_NUMBER

The request attempted an operation that requires a bank routing number, but the number was not recognized. The request was rejected. Corrective action: Use a valid bank routing number.

INVALID_TOKEN

The request tried to perform an operation that requires the ID of an object, but the object was not found. The request was rejected. Corrective action: Use a valid 'id' for this operation.

MISSING_CURRENCIES

The request attempted an operation that requires a currency, but the currency was not found. The request was rejected. Corrective action: Use the three-letter ISO 4217 code, in uppercase letters.

MISSING_FIELDS

The request attempted an operation, but one or more required fields were missing. The request was rejected. Corrective action: Provide all of the fields that are listed at the end of the error code. For more information, see the API Reference.

MISSING_INVALID_PARAMETERS

A parameter is missing or contains an invalid value. The request was rejected. Corrective action: Check all input parameters.

REQUEST_DECLINED

Your request was declined. For more information, please contact Rapyd Customer Service.

REQUEST_UNDER_REVIEW

Your request is under review by Rapyd's operations department. For more information, please contact Rapyd Customer Service.

SERVICE_TEMPORARILY_UNAVAILABLE

The request attempted an operation, but the service is temporarily unavailable. The request was rejected. Corrective action: Retry in a few minutes. If the problem persists, contact Rapyd Client Support.

UNAUTHENTICATED_API_CALL

The request was rejected due to an authentication issue. Corrective action: Check the status of your account in the 'Account Details' page of the Client Portal.

ERROR_BATCH_FILE_DOES_NOT_EXIST_IN_PATH

The request attempted a batch file operation, but the file was not found. The request was rejected. Corrective action: Set 'file' to the name of a file that was previously uploaded.

ERROR_BATCH_FILE_MISSING_REQUIRED_FIELDS

This record is missing one or more required fields. The request was rejected. Corrective action: Check all input parameters.

ERROR_BATCH_FILE_NOT_FOUND

The request attempted a batch file operation, but the request did not include the batch file. The request was rejected. Corrective action: Include the required batch file in the HTTP request.

ERROR_BATCH_FILE_PARTNER_NOT_VALID

The request attempted a batch file operation, but the partner was not found. The request was rejected. Corrective action: For 'partner', use the ID of a valid partner.

ERROR_BATCH_FILE_TYPE_NOT_VALID

The request attempted a batch file operation, but the file type could not be determined. The request was rejected. Corrective action: Set the 'type' field to 'batch_payout'.

ERROR_BATCH_FILES_TOTAL_SIZE_EXCEEDED_MAX_SIZE

The request attempted a batch file operation, but the file contained too many records, or there were too many batch files. The request was rejected. Corrective action: Send less files than MAX_SIZE and put less than MAX_SIZE number of records in each file.

ERROR_CSV_FILE_NOT_VALID

The request tried to upload a CSV file, but there was a problem with the format of the file. The request was rejected. Corrective action: Use a file that has correct CSV formatting.

ERROR_GET_BATCH_FILE

The request tried to perform an operation to fetch a file, but the file was not found. The request was rejected.

ERROR_GET_BATCH_FILE_DETAILS

The request tried to retrieve details of a batch file, but the batch file was not found. The request was rejected. Corrective action: Use the ID of a valid batch file.

ERROR_MISSING_BATCH_FILE_REQUIRED_FIELDS

The request attempted a batch file operation, but the file did not contain all fields required for the operation. The request was rejected. Corrective action: Send a CSV file that contains all required fields. The names of the missing fields appear at the end of the response code.

ERROR_MISSING_BATCH_FILE_TYPE

The request attempted a batch file operation, but the file type was not provided. The request was rejected. Corrective action: Set the 'type' field to 'batch_payout'.

ERROR_NO_FILE_WAS_UPLOADED

The request attempted a batch file operation, but no batch file was included in the request. The request was rejected. Corrective action: Upload the required type of batch file as part of the request.

ERROR_PARSE_BATCH_FILE_RECORD

This record could not be parsed. The request was rejected. Corrective action: Check all input parameters.

ERROR_RETRIEVE_BATCH_FILE_DETAILS

The request attempted an operation that requires the ID of a valid batch file, but the file was not found. The request was rejected. Corrective action: Use the ID of a valid batch file.

MISSING_MANDATORY_HEADER

The request tried to run a batch file operation, but one of the required header fields was missing. The name of the missing field appears at the end of the response code. The request was rejected. Corrective action: Include all required fields in the header of the batch file.

01

Refer to card issuer

The request attempted a card operation, but the card issuer refused the transaction. The request was rejected. Corrective action: Advise the customer to use a different payment method and contact the card issuer.

02

Refer to card issuer, special condition

The request attempted a card operation, but the card issuer refused the transaction. The request was rejected. Corrective action: Advise the customer to use a different payment method and contact the card issuer.

02

Push funds transaction is not supported for American Express Cards.

Push funds transaction is not supported for American Express Cards. The request was rejected. Corrective action: Try a Visa or Mastercard.

03

Invalid Merchant

The request attempted a card operation, but there was a problem with the merchant’s status. The request was rejected. Corrective action: Contact the card issuer. Advise the customer to use a different payment method.

04

Pick Up Card, no fraud

The request attempted a card operation, but the card issuer wants the card returned. The request was rejected. Corrective action: Advise the cardholder to contact the card issuer to resolve the problem. In addition, if you have the physical card, confiscate it and return it to the issuer.

05

Do Not Honor

The request attempted a card operation, but the card issuer refused the transaction. The request was rejected. Corrective action: Advise the customer to use a different payment method.

05

Invalid card number

The request attempted an operation that requires a card number, but the number was not recognized. The request was rejected. Corrective action: Use the card number of a valid card.

06

Error

The request attempted a card operation, but the payment failed for an unknown reason. The request was rejected. Corrective action: Try again. If the error persists, advise the customer to use a different payment method.

07

Pick Up Card, fraud suspected

The request attempted a card operation, but the card issuer wants the card returned because of suspected fraud. The request was rejected. Corrective action: Advise the cardholder to contact the card issuer to resolve the problem. In addition, if you have the physical card, confiscate it and return it to the issuer.

12

Invalid Transaction

The request attempted a card operation, but the card is not authorized for this type of transaction. The request was rejected. Corrective action: Advise the customer to use a different payment method.

13

Invalid Amount

The request attempted a card operation, but the card is not authorized for online purchases or the amount contains a non-numeric symbol. The request was rejected. Corrective action: Correct the amount or advise the customer to use a different payment method.

14

Invalid Card Number

The request attempted a card operation, but the card issuer did not recognize the card number. The request was rejected. Corrective action: Correct the card number or advise the customer to use a different payment method.

15

Invalid Issuer

The request attempted a card operation, but the card number was not valid. The request was rejected. Corrective action: Correct the card number.

17

Customer Cancellation

The customer canceled the transaction. Corrective action: Create a new payment.

19

Re-enter

The request attempted a card operation, but the payment failed for an unknown reason. The request was rejected. Corrective action: Try again. If the error persists, advise the customer to use a different payment method.

41

Lost Card, pick up

The request attempted a card operation, but the card issuer wants the card returned because the cardholder reported it lost. The request was rejected. Corrective action: Advise the cardholder to contact the card issuer to resolve the problem. In addition, if you have the physical card, confiscate it and return it to the issuer.

42

Stolen Card, pick up

The request attempted a card operation, but the card issuer wants the card returned because the cardholder reported it stolen. The request was rejected. Corrective action: Consider not doing business with this customer. In addition, if you have the physical card, confiscate it and return it to the issuer.

43

Stolen Card, pick up

The request attempted a card operation, but the card issuer wants the card returned because the cardholder reported it stolen. The request was rejected. Corrective action: Consider not doing business with this customer. In addition, if you have the physical card, confiscate it and return it to the issuer.

46

Closed Account

The request attempted a card operation, but the account is closed. The request was rejected. Corrective action: Advise the cardholder to use a different payment method.

50

Invalid Payment Condition

Timeout or invalid password. Corrective action: Create a new payment.

51

Insufficient Funds

The request attempted a card operation, but the transaction would exceed the card limit. The request was rejected. Corrective action: Advise the cardholder to add funds to the account or use a different payment method.

54

Expired Card

The request attempted a card operation, but the card has expired. The request was rejected. Corrective action: Advise the cardholder to use a different payment method, or contact the card issuer to issue a new card.

56

No Card Record

The request tried to create a card payment, but there was no record of the card number. The request was rejected. Corrective action: Correct the card number or advise the customer to use a different payment method.

57

Transaction not Permitted to Cardholder

The request attempted a card operation, but the card is not authorized for this type of transaction. The request was rejected. Corrective action: Advise the customer to contact the card issuer for authorization for the transaction, or use a different payment method.

58

Transaction not Permitted to Acquirer or Terminal

The request attempted a card operation, but the acquirer or terminal is not authorized for this type of transaction. The request was rejected. Corrective action: Contact Client Support.

59

Suspected Fraud

The request attempted a card operation, but the card issuer suspects fraud in this transaction. The request was rejected. Corrective action: Consider not doing business with this customer.

61

Withdrawal Amount Limit Exceeded

The request attempted a card operation, but the transaction would exceed the card limit. The request was rejected. Corrective action: Advise the cardholder to add funds to the account or use a different payment method.

62

Restricted Card

The request attempted a card operation, but the card is not authorized for use in the country of the merchant. The request was rejected. Corrective action: Advise the cardholder to use a different payment method.

63

Security Violation

The request attempted a card operation, but there was a problem with the card’s security features. The request was rejected. Corrective action: Verify the CVV, or advise the cardholder to use a different payment method.

65

Authentication Required or Activity Limit Exceeded

The request attempted a card operation, but 3DS was not completed or the transaction would exceed the card’s activity limit. The request was rejected. Corrective action: Resubmit with 3DS required or use another payment method.

68

Response Received Too Late

Late Response. Corrective action: Create a new payment.

70

PIN Required or Contact Issuer

The request attempted a card operation, but the PIN was not provided or the card issuer requests contact from the cardholder. The request was rejected. Corrective action: Ask the cardholder to enter the PIN or use another payment method.

75

Allowable Number of PIN Tries Exceeded

The request attempted a card operation, but the customer has entered the PIN code incorrectly too many times. The request was rejected. Corrective action: Advise the cardholder to use a different payment method.

76

Visa: Previous message not found

Mastercard: 'To account' not found

Visa: The request attempted an operation that requires the ID of a previous message, but the ID was not found. The request was rejected. Corrective action: Enter the message ID and try again.

Mastercard: The request tried to push funds to a card, but the card account was not found. The request was rejected. Corrective action: Enter the card number and try again.

77

Visa: Message data not consistent

Mastercard: 'From account' not found

Visa: The request attempted an operation that requires ID of a previous message, but the data of this request did not match. The request was rejected. Corrective action: Enter the correct information and try again.

Mastercard: The request tried to push funds to a card, but the source of funds was not found. The request was rejected. Corrective action: Enter the card number and try again.

78

Blocked, first used

The request attempted a card operation, but the card is new and has not yet been unblocked. The request was rejected. Corrective action: Advise the cardholder to complete the process for unblocking the card.

83

Security Issue or Suspected Fraud

The request attempted a card operation, but there was a security issue or the card issuer suspects fraud. The request was rejected. Corrective action: None. Advise the cardholder to contact the card issuer.

Fraud or security concerns. Corrective action: Advise the customer to contact the issuing bank.

91

Authorization Platform or Issuer System Inoperative

The request attempted a card operation, but the issuing bank was not available. The request was rejected. Corrective action: Try again. If the error persists, advise the customer to use a different payment method.

93

Violation, cannot complete

The request attempted a card operation, but there was an issue with the customer’s account. The request was rejected. Corrective action: Try again. Advise the customer to contact the card issuer, or use a different payment method.

94

Duplicate transmission detected

The request attempted a card operation, but there was a duplicate transmission. The request was rejected. Corrective action: Retry.

96

System Malfunction

The request attempted a card operation, but the issuing bank was temporarily unavailable. The request was rejected. Corrective action: Try again. If the error persists, advise the customer to use a different payment method.

O1

Card type could not be determined

The request attempted a card operation, but the card type could not be determined from the card number. The request was rejected. Corrective action: Check the card number and try again.

O2

Push funds is not supported for Amex

The request tried to pay funds out to an American Express card, but this operation is not supported. The request was rejected. Corrective action: None.

O5

Primary account number (PAN) is not valid

The request attempted a card operation, but the primary account number (PAN) was not valid. The request was rejected. Corrective action: Check the card number and try again.

CV

Card Verification Error

00

Success

08

Success

10

Partial approval

11

Success

1A

Additional Authentication Required

21

No Action Taken

25

Record Not Found in File

28

File Temporarily Unavailable

30

Format Error

39

No credit account

3X

Additional Authentication Required

52

Checking Account Not Found

53

Savings Account Not Found

55

PIN Not Valid

64

AML Requirements Not Met

6P

Customer ID Verification Failed

71 (Mastercard)

PIN not changed.

74

Encryption Error

76

Unsolicited Reversal

79

Already Reversed by Switch

80

Credit Issuer Unavailable

81

Cryptographic Error in PIN

81 (Mastercard)

Domestic debit transaction not allowed.

82

Negative CAM, dCVV, iCVV, or CVV results

82 (Mastercard)

Policy issue.

84 (Mastercard)

Invalid authorization life cycle.

85 (Visa)

No reason to decline verification of account number, address or CVV2

86

Pin Not Validated

87 (Mastercard)

Purchase amount only, no cash back allowed.

88 (Mastercard)

Cryptographic failure.

89

Not Eligible to Receive Financial Position Information

92

Unable to Route Transaction

B1

Surcharge Amount Not Permitted

B2

Surcharge Amount Not Supported

N0

Force STIP

N3

Cash Service Not Available

N4

Cash Request Exceeds Limit

N5

Ineligible for Resubmission

N7

CVV2 Failure

N8

Transaction Exceeds Authorized Amount

P2 (Visa)

Invalid biller information

P5

PIN Change Declined

P6

Requested PIN Not Safe

Q1

Card Authentication Failed

R0

Customer Requested Stop Payment

R1

Customer Revoked Authorization

R2

Transaction Does Not Qualify for Visa PIN

R3

All Authorizations Revoked

W1, W2, W9

Error Connecting to Bank

XA, XD (Visa)

Forward to issuer.

Z1

Offline - Declined

Z3

Unable to go online

01

Do not try again

02

Try again later

03

Update account information

04

Retry using authentication

05

Suspected fraud, do not try again

06

Payment cancellation, do not try again

07

Merchant does not qualify for product code

08

Retry after 1 hour

09

Retry after 24 hour

10

Retry after 2 days

11

Retry after 4 days

12

Retry after 6 days

13

Retry after 8 days

14

Retry after 10 days

15

The issuer recognizes the product as a consumer non-reloadable prepaid card

16

The issuer recognizes the product as a consumer single-use virtual card number

17

Token requirements not fulfilled for this token type

18

Negotiated value not approved

ERROR_CREATE_PAYMENT_ACCOUNT_UNAVAILABLE

Rapyd was unable to complete the payment because the source of the funds was closed. Corrective action: Use a different payment method.

ERROR_CREATE_PAYMENT_BANK _TRANSFER_MANDATE_INCOMPLETE

Rapyd was unable to complete the payment because the data in the mandate was not complete. Corrective action: Resubmit the request and create a new mandate.

ERROR_CREATE_PAYMENT_CONTACT_BANK

Rapyd was unable to complete the payment because there was a problem with the source of funds. Corrective action: Contact the payer's bank or use a different payment method.

ERROR_CREATE_PAYMENT_CUSTOMER_DISPUTE

The customer disputed the payment. The payment was reversed. Corrective action: Contact the customer, then create a new payment.

ERROR_CREATE_PAYMENT_INSUFFICIENT_FUNDS

The request tried to create a payment, but there were insufficient funds for the transaction. Corrective action: None. Contact the customer.

ERROR_CREATE_PAYMENT_MANDATE_NOT_VALID

The request tried to create a SEPA bank transfer payment, but the mandate was not valid. The request was rejected. Corrective action: Resubmit the request and complete the mandate process.

ERROR_CREATE_PAYMENT_PAYER_DECEASED

The financial institution reported that the payer is now deceased. The request was rejected. Corrective action: None.

ERROR_CREATE_PAYMENT_TRANSACTION_NOT _ALLOWED_FOR_THIS_TYPE_OF_ACCOUNT

Rapyd was unable to complete the payment because the source of the funds cannot be used for this type of transaction. Corrective action: Use a different payment method.

ERROR_CARD_AUTHENTICATION_FAILURE

The request created a card payment that requires 3DS authentication, but the authentication was not completed in the time allowed. The payment was canceled. Corrective action: None. Create another payment.

ERROR_CARD_CVV_NOT_VALID

The request attempted an operation that requires the CVV of a card, and the CVV was correctly formatted, but the number was not valid. The request was rejected. Corrective action: Use the correct CVV value.

ERROR_CARD_INFORMATION_NOT_VALID

The request attempted an operation that requires a card, and the card information submitted was correctly formatted, but the card information was not valid. The request was rejected. Corrective action: Use correct card information.

ERROR_CARD_NOT_SUPPORTED_FOR_ECOMMERCE

The request attempted a card transaction, but the transaction is not supported for eCommerce. The request was rejected. Corrective action: None. Advise the customer to contact the card issuer.

ERROR_CARD_NOT_VALID

The request tried to use a card ID, but the card is not valid. The request was rejected. Corrective action: None. Create a new card ID using 'Create Payment', 'Add Payment Method to Customer' or 'Create Card Token - Hosted Page'.

ERROR_CARD_TYPE_DISABLED

The request attempted an operation that requires a card, but the card type is disabled. The request was rejected. Corrective action: Advise the marketplace to enable the card type.

ERROR_TRANSACTION_FAILED

The request attempted a card transaction, but the transaction failed. The request was rejected. Corrective action: None. Advise the customer to contact the card issuer.

ERROR_TRANSACTION_REJECTED_BY_CARD_PROCESSOR

The request attempted a card transaction, but the transaction failed. The request was rejected. Corrective action: The error code includes a numeric code that is standard to the Visa and Mastercard industry. Correct the error condition and submit the request again.

ERROR_TRANSACTION_TYPE_NOT_ALLOWED_BY_SELLER

The request attempted a card transaction, but the transaction is not allowed by the seller. The request was rejected. Corrective action: None. Advise the customer to contact the seller.

ERROR_TRANSACTION_TYPE_NOT_SUPPORTED

The request attempted a card transaction, but the transaction is not supported by the card network. The request was rejected. Corrective action: None. Advise the customer to contact the card issuer.

INVALID_CARD_CVV

The request attempted an operation that requires a card verification value, but the number was not recognized. The request was rejected. Corrective action: Set 'cvv' to a valid value.

INVALID_CARD_NUMBER

The request attempted an operation that requires a card number, but the number was not recognized. The request was rejected. Corrective action: Use the card number of a valid card.

ERROR_CONVERT_CURRENCY_DAILY_LIMIT_REACHED

The request tried to convert currency in a wallet, but the daily limit for currency conversions has been reached. The request was rejected. Corrective action: Wait one day and resubmit the request.

ERROR_CURRENCY_PAIR_NOT_VALID

The request tried to request the daily rate for a currency exchange, but the buy currency cannot be converted into the selected sell currency. The request was rejected. Corrective action: Contact customer support.

ERROR_DIFFERENT_CURRENCY_REQUIRED

The request tried to get a quote for converting currency, but the same currency was specified for the sell currency and the buy currency. The request was rejected. Corrective action: Set 'sell_currency' and 'buy_currency' to different values.

ERROR_GET_FX_RATE

The request attempted an operation that requires currency exchange, but the rate for one or both of the currencies could not be found. The request was rejected. Corrective action: Try the request at a later time.

ERROR_GET_RATE

The request attempted an operation that requires currency exchange, but the rate for one or both of the currencies could not be found. The request was rejected. Corrective action: Try the request at a later time.

ERROR_HOSTED_PAGE_FX_FEE_ONLY_ALLOWED_FOR_FX_TRANSACTIONS

The request tried to set a foreign exchange fee but the requested payment was not a foreign exchange transaction. The request was rejected. Corrective action: For a payment that does not require foreign exchange, leave 'fx_fee' unset.

ERROR_INVALID_QUOTE_ID

The request tried to convert currency in a wallet, but the quote was not found. The request was rejected. Corrective action: For 'quote_id', use the ID of a valid quote.

ERROR_PROCESSING_CONVERSION

The request tried to convert currency in a wallet, but the quote has already been used. The request was rejected. Corrective action: Get a new quote.

INVALID_EXPIRATION

The request attempted an operation that requires a forward date, but the date was not found or was not valid. The request was rejected. Corrective action: Provide a forward date that is a valid Unix time, not past, and not more than 1 year in the future.

INVALID_SOURCE_CURRENCY

The request attempted an operation that requires a currency code for the result of an FX operation, but the sell currency was not recognized. The request was rejected. Corrective action: Use the correct 3-letter ISO 4217 code for the currency in uppercase letters.

ERROR_GET_HOSTED_PAGE_PAYMENT

The request tried to retrieve a hosted page, but the page was not found. The request was rejected. Corrective action: Use the ID of a valid hosted page.

ERROR_HOSTED_PAGE_COLLECT_CARD_CUSTOMER_NOT_FOUND

The request attempted a hosted page operation, but the customer was not found. The request was rejected. Corrective action: For 'customer', provide a valid customer ID, a string starting with 'cus_'.

ERROR_HOSTED_PAGE_COUNTRY_CURRENCY_MISMATCH

The request tried to create a checkout page, but there is no payment method that is supported in the country for the currency provided. The request was rejected. Corrective action: Use a different currency or country.

ERROR_HOSTED_PAGE_CURRENCY_MISSING_WHEN_AMOUNT_IS_NOT_EDITABLE

The request tried to create a hosted page without specifying a currency, but the amount is not editable. The request was rejected. Corrective action: Set 'amount_is_editable' to true or set 'currency' to a valid value.

ERROR_HOSTED_PAGE_FIXED_AMOUNT_NOT_FOUND

The request tried to create a hosted page with a fixed amount, but the amount was not provided. The request was rejected. Corrective action: Set 'amount' to a positive decimal number.

ERROR_HOSTED_PAGE_GET_PAYMENT_METHOD

The request attempted an operation that requires a payment method, but the payment method was not found. The request was rejected. Corrective action: Use the ID of a valid payment method, a string starting with 'card_' or '_other'.

ERROR_HOSTED_PAGE_INVALID_CURRENCY

The request tried to create a checkout page, but the currency was not recognized. The request was rejected. Corrective action: For the 'currency' field, use the 3-letter ISO 4217 code in uppercase letters.

ERROR_HOSTED_PAGE_INVALID_CUSTOM_ELEMENTS

The request tried to create a hosted checkout page, but there was an error in the custom elements. The request was rejected. Corrective action: Set each field in the 'custom_elements' object to a correct value.

ERROR_HOSTED_PAGE_INVALID_PAGE_EXPIRATION

The request tried to create a hosted page, but the date it expires could not be determined. The request was rejected. Corrective action: In 'page_expiration', provide a Unix time that is between 1 minute and 30 days after the request itself.

ERROR_HOSTED_PAGE_MISSING_CUSTOMER

The request attempted a hosted page operation, but the customer was not found. The request was rejected. Corrective action: For 'customer', provide a valid customer ID, a string starting with 'cus_'.

ERROR_HOSTED_PAGE_NO_SUPPORTED_PAYOUT_METHOD_TYPES

The request attempted a hosted page operation, but there are no supported payout method types for the combination of the attributes that has been specified. The request was rejected. Corrective action: Run 'List Payout Method Types'. Use only supported countries and entity types, and use only currencies that are supported for each country.

ERROR_HOSTED_PAGE_UNREADABLE_PAYOUT_METHOD_TYPES_INCLUDE_LIST

The request tried to create a hosted page with a list of payout method types to include, but the data was not recognized. The request was rejected. Corrective action: In 'payout_method_types_include', specify a list of strings, each of which is a payout method type.

ERROR_HOSTED_PAGE_UNRECOGNIZED_CARD

The request attempted a hosted page operation, but the card was not recognized or not valid. The request was rejected. Corrective action: For 'card', provide the card token or the issued card ID. The card token starts with 'card' and the issued card ID starts with 'ci'.

4000-4009

The gateway is not responding.

2000-2009

The sandbox detected a simulated error, where the payment could not be processed because settlement was declined.

2020-2029

Settlement is pending on the gateway.

2080-2089

The processor is unavailable.

2120-2129

Insufficient funds in the account.

2180-2189

Payment expired.

ERROR_CREATE_PAYMENT_GATEWAY_NOT_RESPONDING

This is a simulated error because the amount was set between 4000 and 4009. The simulated error is INTERNAL_ERROR.

ERROR_PROCESS_PAYMENT_EXPIRED

The sandbox detected a simulated error, where the payment could not be processed because of expiration of the payment.

ERROR_PROCESS_PAYMENT_INSUFFICIENT_FUNDS

The sandbox detected a simulated error, where the payment could not be processed because of insufficient funds in the source of funds.

ERROR_PROCESS_PAYMENT_PROCESSOR_UNAVAILABLE

The sandbox detected a simulated error, where the payment could not be processed because the payment processor was unavailable.

ERROR_PROCESS_PAYMENT_SETTLEMENT_DECLINED

The sandbox detected a simulated error, where the payment could not be processed because settlement was declined.

ERROR_PROCESS_PAYMENT_SETTLEMENT_PENDING_ON_GATEWAY

The sandbox detected a simulated error, where the payment could not be processed because settlement remained pending on the gateway.