Documentation

ERROR_CREATE_SENDER_COUNTRY_NOT_VALID

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

Explanation: The country code was invalid or missing. Use a valid code like GB or FR.

Error Example: post /v1/payouts/sender {"country":"UK"}

Correct Example:

post /v1/payouts/sender
{
    "country": "GB",
    "entity_type": "company"
}

ERROR_CREATE_SENDER_CURRENCY_NOT_VALID

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

Explanation: The currency code for the sender was missing or invalid. Use a valid code like GBP or EUR.

Error Example: {"currency":"$"}

Correct Example:

{
    "currency": "USD"
}

ERROR_GET_PAYER

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

Explanation: The sender ID provided does not correspond to an active sender object. Verify the ID or create a new sender.

Correct Example:

get /v1/payouts/sender/sender_87a87cfef195f2e9418b7c582de653bc

ERROR_INVALID_PAYOUT_SENDER_ENTITY_TYPE

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

Explanation: You provided an invalid value for the sender's entity type. Set entity_type to company or individual.

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

Correct Example:

{
    "entity_type": "company"
}