Documentación

ERROR_CANCEL_PAYOUT

Message: 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.

Explanation: You attempted to void a payout that has already reached a finalized state or used a payout method type that does not support reversal. Before sending a cancel request, use List Payout Method Types to verify payout method capabilities and Retrieve Payout to check the status of the payout.

ERROR_CONFIRM_PAYOUT

Message: 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.

Explanation: You sent an FX confirmation request for a payout that was already processed or was a single-currency transaction. Ensure that the payout requires FX confirmation before calling this endpoint.

ERROR_CREATE_PAYOUT

Message: 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.

Explanation: General failure during payout creation due to missing or invalid parameters. Use Get Payout Required Fields to determine the specific schema required for your selected payout_method_type.

Error Example:post /v1/payouts {"payout_method_type":"us_general_bank","payout_amount":100}

Correct Example:

post /v1/payouts
{
    "payout_method_type": "us_general_bank",
    "beneficiary": "beneficiary_81fdb04df9cc01c0488dcbbf02c76edd",
    "sender": "sender_94e84ba869e20da70be5b0c0027c889d",
    "payout_amount": 100,
    "payout_currency": "USD"
}

ERROR_CREATE_PAYOUT_ABA_CONTAINS_NON_NUMERIC_CHARACTERS

Message: The request tried to create a payout with anABA routing number, but the value contained non-numeric characters. The request was rejected. Corrective action: Use only digits for the aba field.

Explanation: The aba routing number provided contains letters or special characters. Ensure the aba field contains only digits.

Error Example:{"aba":"123A45678"}

Correct Example:

{
    "aba": "123456789"
}

ERROR_CREATE_PAYOUT_ABA_LENGTH_NOT_VALID

Message: 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.

Explanation: The provided ABA routing number does not have the required 9-digit length. Correct the aba value to exactly 9 digits.

Error Example:{"aba":"12345"}

Correct Example:

{
    "aba": "123456789"
}

ERROR_CREATE_PAYOUT_AMOUNT_UNKNOWN

Message: 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.

Explanation: The system is unable to calculate the FX conversion because you provided conflicting amount fields or no amount at all. Use exactly one parameter for the amount.

Error Example:{"sender_amount":100,"payout_amount":100}

Correct Example:

{
    "payout_amount": 100
}

ERROR_CREATE_PAYOUT_BENEFICIARY_COUNTRY_AND_BANK_COUNTRY_MISMATCH

Message: 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.

Explanation: You attempted to send a local payout to a bank in a different country than the beneficiary's registered residence. Align the beneficiary_country with the bank's location.

Error Example: {"beneficiary_country":"US"} for a GB bank account.

Correct Example:

{
    "beneficiary_country": "GB"
}

ERROR_CREATE_PAYOUT_COUNTRY_NOT_SUPPORTED

Message: 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.

Explanation: The chosen payout_method_type is not available for the specified country pair. Run List Payout Method Types for payout methods that support the relevant sender and beneficiary countries.

ERROR_CREATE_PAYOUT_CURRENCY_NOT_SUPPORTED

Message: 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.

Explanation: The payout method you are using does not support the payout currency or the sender currency. Run List Payout Method Types for payout methods that support the currencies that you want to use in this payout.

ERROR_CREATE_PAYOUT_PURPOSE_CODE_NOT_VALID

Message: 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.

Explanation: The payout method you selected requires you to select a purpose code. Run Get Payout Required Fields to determine the valid values for the purpose_code field.

Error Example:{"purpose_code":"InvalidCode"}

Correct Example:

{
    "purpose_code": "Family Support"
}

ERROR_CREATE_PAYOUT_TO_CARD_BANK_NOT_SUPPORTED

Message: 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.

Explanation: The beneficiary's bank does not participate in the card network's payout program (e.g., Visa Direct or Mastercard Send). Use a different payout method.

ERROR_CREATE_PAYOUT_TO_CARD_CONTACT_ISSUER

Message: 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.

Explanation: A general card decline occurred. The cardholder must verify their account status with their bank.

ERROR_CREATE_PAYOUT_TO_CARD_EXPIRED_CARD

Message: 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.

Explanation: The transaction failed because the destination card's expiration date has passed. The user must provide a valid card. Use a different payout method.

ERROR_CREATE_PAYOUT_TO_CARD_NUMBER_NOT_VALID

Message: 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.

Explanation: The destination card number is malformed or is not related to the payout method you selected. Ensure that the card number is entered correctly.

ERROR_CREATE_PAYOUT_TO_CARD_SERVICE_NOT_SUPPORTED

Message: 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.

Explanation: The card issuer has not authorized inbound transfers. Use a different payout method.

ERROR_EXPIRATION_SENT_FOR_NON_CASH_PAYOUT

Message: 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.

Explanation: You included an expiration timestamp for a non-cash method (like bank or card). Remove the expiration field.

Error Example:{"payout_method_type":"us_general_bank","expiration":1712345678}

Correct Example:

{
    "payout_method_type": "us_general_bank"
}

ERROR_FEE_CURRENCY_IS_INVALID_OR_NOT_SUPPORTED

Message: The request tried to create a payout, but the fee currency was invalid or not supported. Corrective action: In the payout_fees.fee_currency field, enter a 3-letter ISO 4217 code of a supported currency (USD, EUR, GBP, SGD, HKD, AUD).

Explanation: You are trying to charge fees on a payout to a stablecoin currency, but the fiat currency you specified for the fees is not supported or not recognized. Change the value to a supported currency.

Error Example:{"payout_fees":{"fee_currency":"USDT"}}

Correct Example:

{
    "payout_fees": {
        "fee_currency": "USD"
    }
}

ERROR_GET_PAYOUT

Message: 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.

Explanation: The payout_id in the URL path is incorrect or refers to a payout in a different environment. Check the payout prefix and alphanumeric string.

Error Example:get /v1/payouts/payout_1234

Correct Example:

get /v1/payouts/payout_60dca835ac0b2c822f76c48641d8bae0

ERROR_LOCATION_PROVIDED_FOR_PAYOUT_THAT_IS_NOT_LOCATION_SPECIFIC

Message: 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.

Explanation: You included a location for a payout method (like bank transfer) that does not use it. Only use the location field for cash-out methods.

Error Example:post /v1/payouts {"payout_method_type":"us_general_bank","location":"location_12345aaaabbb"}

Correct Example:

post /v1/payouts
{
    "payout_method_type": "us_general_bank"
}

ERROR_MISSING_FEE_CURRENCY

Message: The request tried to create a payout with a stablecoin as the payout currency, but the fee_currency was missing. Corrective action: In the payout_fees.fee_currency field, enter a 3-letter ISO 4217 code.

Explanation: When paying out in stablecoins, you must explicitly define which fiat currency will be used to pay the transaction fees. Add the fee_currency parameter and set it to one of the valid values specified in Create Payout.

Error Example:{"fee_currency": "USDC"}

Correct Example:

{
    "fee_currency": "USD"
}

ERROR_MISSING_MERCHANT_EWALLET

Message: The request tried to create a payout, but the merchant_ewallet was missing. The request was rejected. Corrective action: Enter a valid value for the merchant_ewallet parameter.

Explanation: You did not specify the source wallet ID from which funds should be deducted. Provide your Rapyd wallet ID starting with ewallet_.

Error Example:{"merchant_ewallet":null}

Correct Example:

{
    "merchant_ewallet": "ewallet_12345abcd"
}

ERROR_MISSING_OR_INVALID_PAYOUT_AMOUNT

Message: The request attempted an operation that requires the amount of the payout, but the value was not recognized. The request was rejected. Corrective action: Set payout_amount to the amount of the payout.

Explanation: The payout_amount field is missing or contains non-numeric data. Provide a positive decimal value.

Error Example:{"payout_amount":"100,50"}

Correct Example:

{
    "payout_amount": 100.50
}

ERROR_MISSING_PAYOUT_AMOUNT

Message: The request attempted an operation that requires the payout amount, but the value was not set. The request was rejected. Corrective action: Use a positive decimal number for payout_amount.

Explanation: The transaction cannot proceed because the amount is missing. Specify the funds to be transferred using the payout_amount field.

Error Example:{"payout_amount":""}

Correct Example:

{
    "payout_amount": 100.00
}

ERROR_MISSING_PAYOUT_BENEFICIARY_COUNTRY

Message: The request attempted an operation that requires the country of the beneficiary, but the value was not found. The request was rejected. Corrective action: In the beneficiary_country field, use the correct 2-letter ISO 3166-1 ALPHA-2 code.

Explanation: The mandatory beneficiary_country parameter is missing from the request. Add the country code to the payout body.

Error Example:{"beneficiary_country":null}

Correct Example:

{
    "beneficiary_country": "US"
}

ERROR_MISSING_PAYOUT_BENEFICIARY_ENTITY_TYPE

Message: The request attempted an operation that requires the entity type of the beneficiary, but the value was not found. The request was rejected. Corrective action: Set the beneficiary entity type to individual or company.

Explanation: You failed to specify whether the beneficiary is an individual or a company. Include the correct value in the beneficiary_entity_type field.

Error Example:{"beneficiary_entity_type":null}

Correct Example:

{
    "beneficiary_entity_type": "individual"
}

ERROR_MISSING_PAYOUT_CURRENCY

Message: 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.

Explanation: The currency received by the beneficiary is not defined. Specify the payout_currency.

Error Example:{"payout_currency":null}

Correct Example:

{
    "payout_currency": "PHP"
}

ERROR_MISSING_PAYOUT_LOCATION

Message: 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.

Explanation: For cash pickup payouts, the destination branch is required. Provide a location_id.

Error Example:{"payout_method_type":"ph_cebuana_cash_payout","location_id":null}

Correct Example:

{
    "payout_method_type": "ph_cebuana_cash_payout",
    "location_id": "location_12345abcd"
}

ERROR_MISSING_PAYOUT_METHOD_TYPE

Message: 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.

Explanation: You did not specify how the funds should be delivered. Include a valid value for the payout_method_type field.

Error Example:{"payout_method_type":null}

Correct Example:

{
    "payout_method_type": "au_bankfirst_bank"
}

ERROR_MISSING_PAYOUT_SENDER_COUNTRY

Message: 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.

Explanation: The sender's country must be defined. Add sender_country.

Error Example:{"sender_country":null}

Correct Example:

{
    "sender_country": "US"
}

ERROR_MISSING_PAYOUT_SENDER_CURRENCY

Message: 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.

Explanation: The currency paid by the sender is undefined. Specify the sender_currency.

Error Example:{"sender_currency":null}

Correct Example:

{
    "sender_currency": "EUR"
}

ERROR_MISSING_PAYOUT_SENDER_ENTITY_TYPE

Message: The request attempted an operation that requires the entity type of the sender, but the value was not found. The request was rejected. Corrective action: Set the entity type for the sender to individual or company.

Explanation: The originator's legal type is required. Include the correct value for the sender_entity_type field.

Error Example:{"sender_entity_type":null}

Correct Example:

{
    "sender_entity_type": "company"
}

ERROR_MISSING_PAYOUT_UPDATE_FIELDS

Message: 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.

Explanation: You sent an update request but didn't provide any new values to change. Include at least the description or metadata field.

Error Example:post /v1/payouts/payout_b5f468ba37f451d846eddcdc9b2d5bcb {}

Correct Example:

post /v1/payouts/payout_b5f468ba37f451d846eddcdc9b2d5bcb
{
    "description": "Transfer to sender's relative"
}

ERROR_PAYER_DETAILS_IN_REQUEST_AND_SAVED_PAYER_DETAILS_MISMATCH

Message: 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.

Explanation: The explicit sender_country or sender_currency fields in your request conflict with the values saved in the sender object. Align the request parameters with the sender's original profile.

Error Example: {"sender_country":"DE","sender_currency":"EUR"}, where the sender's country is actually US.

Correct Example:

{
    "sender_country": "US"
    "sender_currency": "USD"
}

ERROR_PAYOUT_AMOUNT_EXCEEDED_ORIGINAL_AMOUNT

Message: 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.

Explanation: You are attempting to simulate completion for a payout that is already finished. Start a new payout to test again.

ERROR_PAYOUT_AMOUNT_EXCEEDS_BENEFICIARY_ACCOUNT_LIMIT

Message: The request tried to create a payout, but the amount exceeds the beneficiary’s account transfer limit. The request was rejected. Corrective action: Advise the beneficiary to contact their bank in order to increase the transfer amount that their account may receive.

Explanation: The recipient's bank account has a regulatory or internal cap on inbound transfers that this payout would exceed. Reduce the amount or ask the beneficiary to have their bank update the limit. To determine the maximum, run Get Payout Required Fields.

ERROR_PAYOUT_AMOUNT_LESS_THAN_MINIMUM

Message: 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.

Explanation: Your payout_amount is too small for the chosen payout method. Use a different payout method.

ERROR_PAYOUT_AMOUNT_MORE_THAN_MAXIMUM

Message: 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.

Explanation: The payout_amount exceeds the network or partner limits for a single transaction. Split the payout or reduce the amount.

ERROR_PAYOUT_AMOUNT_NOT_WITHIN_RANGE_OF_PAYOUT_METHOD_TYPE

Message: 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.

Explanation: The amount violates the minimum or maximum limit of the payout method. Use Get Payout Required Fields to see the valid range.

Error Example:{"payout_amount": 1.24}

Correct Example:

{
    "payout_amount": 1.25
}

ERROR_PAYOUT_BENEFICIARY_ACCOUNT_UNAVAILABLE

Message: 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.

Explanation: The destination bank account is closed, frozen, or restricted from receiving external transfers. Use a different payout method.

ERROR_PAYOUT_BENEFICIARY_BANK_REJECT

Message: The payout failed because the beneficiary bank rejected the transaction. Corrective action: Ask the beneficiary to contact the beneficiary bank.

Explanation: The receiving bank manually or automatically blocked the inbound funds. The recipient must resolve the block with their bank. Use a different payout method.

ERROR_PAYOUT_BENEFICIARY_BANK_REJECTION

Message: The payout failed because the beneficiary bank rejected the transaction. Corrective action: Ask the beneficiary to contact the beneficiary bank.

Explanation: The receiving bank manually or automatically blocked the inbound funds. The recipient must resolve the block with their bank. Use a different payout method.

ERROR_PAYOUT_BENEFICIARY_FIELDS_NOT_FOUND

Message: 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.

Explanation: You provided data for the beneficiary, but the information was not correct.

ERROR_PAYOUT_BENEFICIARY_FIELDS_NOT_VALID

Message: 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.

Explanation: One or more beneficiary parameters (like account number or address) do not match the required format or could not be verified. Correct the values indicated at the end of the error code.

ERROR_PAYOUT_BENEFICIARY_IDENTIFICATION_AND_ACCOUNT_MISMATCH

Message: 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.

Explanation: The ID provided in beneficiary.identification_value does not correspond to the information on file with Rapyd or the bank. Verify the identity details.

ERROR_PAYOUT_BENEFICIARY_IDENTIFICATION_AND_NAME_MISMATCH

Message: 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.

Explanation: The name information provided in beneficiary.name, beneficiary.first_name and beneficiary.last_name does not correspond to the information on file with Rapyd or the bank. Verify the identity details.

ERROR_PAYOUT_BENEFICIARY_NAME_AND_ACCOUNT_MISMATCH

Message: 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.

Explanation: The name information provided in beneficiary.name, beneficiary.first_name and beneficiary.last_name does not correspond to the information on file with Rapyd or the bank. Verify the identity details.

ERROR_PAYOUT_BENEFICIARY_NOT_REACHABLE_BY_METHOD

Message: 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.

Explanation: There was an issue with the beneficiary's bank or the network. Use a different payout method.

ERROR_PAYOUT_COUNTRY_NOT_VALID

Message: 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.

Explanation: A country parameter is missing or incorrect. Update the codes to the ISO standard.

Error Example:{"beneficiary_country":"UK","sender_country": "USA"}

Correct Example:

{
    "beneficiary_country": "GB",
    "sender_country": "US"
}

ERROR_PAYOUT_CURRENCY_NOT_SUPPORTED

Message: 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.

Explanation: You selected a currency that is not supported for the payout method. Choose a supported payout currency or use a different payout method

Error Example:{"payout_currency":"SGD","payout_method_type":"ad_sepa_bank"}

Correct Example:

{
    "payout_currency": "EUR",
    "payout_method_type": "ad_sepa_bank"
}

ERROR_PAYOUT_CURRENCY_NOT_VALID

Message: 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.

Explanation: One of the currency identifiers is malformed or not a recognized 3-letter code. Use the correct ISO codes.

Error Example:{"sender_currency": "$"}

Correct Example:

{
    "sender_currency": "USD"
}

ERROR_PAYOUT_IBAN_NOT_SUPPORTED_FOR_LOCAL_GBP

Message: The request tried to create a payout, but the IBAN does not support receiving a local payout in pounds sterling (GBP). Corrective action: Advise the sender either to contact the relevant account holding institution to obtain a valid IBAN, or to use an online service to find the correct IBAN (requires the sender's sort code and account number).

Explanation: The IBAN supports only international transfers of GBP. Use a different payout method.

ERROR_PAYOUT_NAME_NOT_VALID

Message: 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.

Explanation: A name field contains an incorrect value or is empty. Ensure that the names are correct.

Error Example:{"beneficiary":{"first_name":"","last_name":"Doe"}}

Correct Example:

{
    "beneficiary": {
        "first_name": "Jane",
        "last_name": "Doe"
    }
}

ERROR_PAYOUT_NOT_CANCELABLE

Message: 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.

Explanation: The selected method (e.g., real-time transfer) is irreversible by nature. You must initiate a new payment to recover the funds.

ERROR_PAYOUT_SENDER_FIELDS_NOT_VALID

Message: 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 sender fields with incorrect data appear at the end of the error code.

Explanation: One or more sender parameters (like address or date_of_birth) are formatted incorrectly. Review the regex patterns in Get Payout Required Fields.

ERROR_UNSUPPORTED_PAYOUT_CURRENCY_OR_COUNTRY

Message: 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.

Explanation: You used an unsupported region or currency, or the entity type did not match the entity type on file. Use correct values.

Correct Example:

{
    "beneficiary": "beneficiary_df640a0444fb9a397e541643392f36f3",
    "beneficiary_entity_type":"company"
}

ERROR_UPDATE_NON_ACTIVE_PAYOUT

Message: 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.

Explanation: You cannot edit metadata or descriptions on a payout that is no longer in a pending state. Payouts must be in created status for updates.

ERROR_UPDATE_PAYOUT

Message: 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_.

Explanation: The payout ID in your update request is invalid. Check for typos in the path parameter.

ERROR_VOID_PAYOUT_INVOICE

Message: 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.

Explanation: You cannot void an invoice generated for a payout. This operation is restricted to standard payment invoices.

ERROR_WALLET_FX_PAYOUT_NOT_SUPPORTED

Message: The request tried to create a payout to a wallet, but the sender currency and the payout currency are not the same. The request was rejected. Corrective action: Set the sender currency and the payout currency to the same currency code and rerun the request for the payout to a Rapyd wallet.

Explanation: Payouts directly into a Rapyd Wallet do not support FX conversion. The sender and payout currencies must be identical.

Error Example: {"sender_currency":"USD","payout_currency":"EUR"}, where the payout_type is rapyd_ewallet.

Correct Example:

{
    "sender_currency": "USD",
    "payout_currency": "USD"
}

INVALID_BENEFICIARY_PAYOUT_ENTITY_TYPE

Message: 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 entity_type field to one of the following values: individual, company.

Explanation: You omitted or misspelled the entity_type field for the beneficiary.

Error Example:{"entity_type": "person"}

Correct Example:

{
    "entity_type": "individual"
}

INVALID_DESTINATION_CURRENCY

Message: 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.

Explanation: The payout_currency cannot be words or symbols. Use the ISO code.

Error Example:{"payout_currency": "$"}

Correct Example:

{
    "payout_currency": "USD"
}

INVALID_PAYER_FIELDS

Message: 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.

Explanation: Validation failed for a parameter inside the sender object. Correct the field indicated in the error.

INVALID_PAYER_PAYOUT_ENTITY_TYPE

Message: 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.

Explanation: The sender's entity_type is missing or invalid.

Error Example:{"entity_type": "business"}

Correct Example:

{
    "entity_type": "company"
}

INVALID_PAYOUT

Message: 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.

Explanation: You failed to provide the required payout categorization. Specify a valid payout_method_type.

Error Example:{"payout_method_type": ""}

Correct Example:

{
    "payout_method_type": "sg_ocbc_bank"
}

INVALID_PAYOUT_CURRENCIES

Message: 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.

Explanation: The currency combination you selected is not enabled for your account or the specific payout method type.

Error Example:{"payout_method_type":"ad_sepa_bank","payout_currency":"EUR","sender_currency":"USD"}

Correct Example:

{
    "payout_method_type": "ad_sepa_bank",
    "payout_currency": "EUR",
    "sender_currency": "EUR"
}

INVALID_PAYOUT_ID

Message: 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_.

Explanation: The identifier provided to generate a tracking URL is malformed. Verify the payout ID.

INVALID_PAYOUT_METHOD_TYPE

Message: 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.

Explanation: The payout_method_type string is incorrect. Refer to List Payout Method Types for the exact string required.

Error Example:{"payout_method_type": "uae_ach_bank"}

Correct Example:

{
    "payout_method_type": "ae_ach_bank"
}

INVALID_PAYOUT_TYPE

Message: The request tried to create a payout, but the category was invalid. The request was rejected. Corrective action: Set the category field to a valid value.

Explanation: The category field is missing or contains an invalid value.

INVALID_REQUIRED_FIELD

Message: 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.

Explanation: A specific parameter failed validation against the required regex pattern. Check the Get Payout Required Fields response for that field's regex.

MISSING_PAYOUT_BENEFICIARY_COUNTRY

Message: 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.

Explanation: The recipient's country is missing. Add a valid beneficiary_country to the request.

Error Example:{"beneficiary_country": ""}

Correct Example:

{
    "beneficiary_country": "US"
}

MISSING_PAYOUT_METHOD_REQUIRED_FIELDS

Message: 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.

Explanation: The body of your request is incomplete. Identify the missing fields mentioned in the error and include them in your JSON.

Error Example:post /v1/payouts {"payout_method_type":"us_general_bank"}

Correct Example:

post /v1/payouts
{
    "payout_method_type": "us_general_bank",
    "beneficiary": "beneficiary_df640a0444fb9a397e541643392f36f3",
    "sender": "sender_71af042431a867fd72816bf9a32bd5d8"
}

PAYOUT_METHOD_TYPE_BENEFICIARY_COUNTRY_MISMATCH

Message: 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 Payout Method Types for the country of the beneficiary. The response lists the supported payout method types.

Explanation: The payout_method_type you selected is not available in the recipient's beneficiary_country.

Error Example:{"beneficiary_country":"SG","payout_method_type":"ng_paga_ewallet"}

Correct Example:

{
    "beneficiary_country": "NG",
    "payout_method_type": "ng_paga_ewallet"
}