# Cashout Creation Endpoint ## Cashout Request `POST` `https://api-stg.directa24.com/v3/cashout` This endpoint allows you to generate cashout requests #### Headers | Name | Type | Description | | --------------------------------------------------- | ------ | ------------------ | | Content-Type\* | string | `application/json` | | Payload-Signature\* | string | Control signature | #### Request Body | Name | Type | Description | | --------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------- | | login\* | string | Your Pandablue CASHOUTS API login key | | pass\* | string | Your Pandablue CASHOUTS API pass key | | external\_id\* | string | Unique cashout ID on the merchant end | | country\* | string | Country of the cashout | | amount\* | number | Amount of the cashout | | currency | string | Currency in which the amount was specified | | document\_id\* | string | Document ID of the beneficiary | | document\_type | string | Document type of the ID specified | | beneficiary\_name\* | string | Beneficiary's name | | beneficiary\_lastname | string | Beneficiary's last name | | email | string | Beneficiary's email address | | phone | string | Beneficiary's phone number | | bank\_code | number | Beneficiary's bank code | | bank\_account | string | Beneficiary's bank account | | bank\_branch | string | Beneficiary's branch of their bank account | | account\_type | string | Beneficiary's account type | | address | string | Beneficiary's address | | city | string | Beneficiary's city | | postal\_code | string | Beneficiary's postal code | | beneficiary\_birthdate | string | Beneficiary's birthdate | | notification\_url\* | string | URL where the notifications will be sent | | comments | string | Commentaries about the cashout | | on\_hold | boolean | Used to mark a cashout as on hold and not process it until manually changed to pending by you | {% tabs %} {% tab title="200 Cashout request successfully created." %} ```bash { "cashout_id": "8405147" } ``` {% endtab %} {% tab title="401 The credentials specified are incorrect." %} ```bash { "code": 401, "message": "Invalid credentials." } ``` {% endtab %} {% tab title="412 Error in the data validation." %} ```bash { "code": 303, "message": "Invalid bank code" } { "code": 300, "message": "bank_account: must not be null; Invalid Bank account" } ``` {% endtab %} {% endtabs %} ## Request Fields Description | Field | Format | Description | Validations | | ---------------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------: | | login | string (max length: 32) | Your Pandablue **CASHOUTS** API Key, found on the Merchant Panel by going to: Settings -> API Access. Notice there are specific Cashout credentials | | | pass | string (max length: 32) | Your Pandablue **CASHOUTS** API Passphrase, found on the Merchant Panel by going to: Settings -> API Access. Notice there are specific Cashout credentials | | | external\_id | string (max length: 100) | Unique cashout ID on the merchant end | | | country | string (length: 2) | Country code for the cashout in *ISO 3166-1 alpha-2 code* format | [See country codes](https://docs.pandablue.com/specifications/countries-specifications#currencies) | | amount | Big Decimal (up to 2 decimals) | Cashout amount on the currency specified | Valid number | | currency | string (length: 3) | Currency code of the amount in *ISO 4217* format | [See valid currencies](https://docs.pandablue.com/specifications/countries-specifications#currencies) | | document\_id | string (max length: 40) | Beneficiary’s personal identification number | [See document validations](https://docs.pandablue.com/specifications/countries-specifications#documents) | | document\_type | string (maxLength: 15) | Beneficiary’s personal identification number type | [See document types validations](https://docs.pandablue.com/specifications/countries-specifications#documents) | | beneficiary\_name | string (max length: 100) | Beneficiary's name | String of up to 100 characters | | beneficiary\_lastname | string (max length: 100) | Beneficiary's last name | String of up to 100 characters | | email | string (maxLength: 100) | Beneficiary's valid email address | [Valid email address](https://docs.pandablue.com/specifications/countries-specifications#emails-validations) | | phone | string (maxLength: 20) | Beneficiary's phone number | [See phone number validations](https://docs.pandablue.com/specifications/countries-specifications#mobile-numbers-validations) | | bank\_code | Integer (max length: 6) | Beneficiary's bank code | [See bank codes API](https://docs.pandablue.com/api-documentation/cashouts-api/endpoints/cashout-bank-codes) | | bank\_account | string (max length: 30) | Beneficiary's bank account number | [See bank\_account validations](https://docs.pandablue.com/api-documentation/countries-validations#bank-account) | | bank\_branch | string (max length: 15) | Beneficiary's bank branch number | [See bank\_branch validations](https://docs.pandablue.com/api-documentation/countries-validations#bank-branch) | | account\_type | string (max length: 1) | Type of account | [See bank\_account types](https://docs.pandablue.com/api-documentation/countries-validations#account-types) | | address | string (max length: 255) | Beneficiary's address | String of up to 200 characters | | city | string (max length: 100) | Beneficiary's city | String of up to 100 characters | | postal\_code | string (max length: 20) | Beneficiary's postal code | [See postal\_code validations](https://docs.pandablue.com/specifications/countries-specifications#postal-code-validations) | | beneficiary\_birthdate | string (pattern: 'YYYYMMDD') | Beneficiary's birthdate | | | notification\_url | string (max length: 300) | To be provided if the notification URL is different from the notification URL defined on the Merchant Panel | Valid URL over HTTPS | | comments | string (max length: 200) | A commentary for this cashout | String of up to 200 characters | | on\_hold | boolean | If the merchant wants to hold the cashout and set it to process later through the merchants panel. Default: false | `[true, false]` | ## Fields required Each country has different requirements and therefore we ask for different fields you need to send on the requests. Go to the[ Countries Validations ](https://docs.pandablue.com/api-documentation/cashouts-api/countries-validations)page to check each country requirements and validations. ## Cashouts to debit cards In Mexico, we accept cashouts sent directly to debit cards. When that happens, you need to send the request through a different endpoint, otherwise your request will be declined with `Invalid bank account, it shouldn't be a credit card`. **PROD endpoint for Debit Cards:** Email with your cashout API Key **STG endpoint for Debit Cards:** `https://cc-api-stg.directa24.com/v3/cashout` The bank accounts in Mexico are in [CLABE](https://en.wikipedia.org/wiki/CLABE) format (numeric) and have 18 digits (without dashes). Therefore one way to detect that a bank account specified by the customer is a debit card is by checking with the[ luhn algorithm ](https://www.geeksforgeeks.org/luhn-algorithm/)if it is a valid card number and/or with a regex for each brand, like the example below. ```java public static final String SENSIBLE_DATA_PATTERN = new StringBuilder("(?:(?4[0-9]{12}(?:[0-9]{3})?)") .append("|(?5[1-5][0-9]{14})") .append("|(?6(?:011|5[0-9]{2})[0-9]{12})") .append("|(?3[47][0-9]{13})") .append("|(?3(?:0[0-5]|[68][0-9])?[0-9]{11})") .append("|(?(?:2131|1800|35[0-9]{3})[0-9]{11}))") .toString(); private boolean validateCreditCard(CashoutRequestDto request) { final String bankAccount = request.getBank_account(); if (StringUtils.isEmpty(bankAccount) || !LuhnCheckDigit.LUHN_CHECK_DIGIT.isValid(bankAccount) || bankAccount.matches(Constants.SENSIBLE_DATA_PATTERN)) { return false; } return true; } ``` If true, send the request through the `cc-api` endpoint, if false send it through the normal endpoint. The integration and requirements remains exactly the same, only changing the error message returned in case of invalid bank account and that we validate the `bank_account` sent to be a valid credit card number using the [Luhn Algorithm](https://en.wikipedia.org/wiki/Luhn_algorithm). Sending a debit card number through the non-cc endpoint will make the request to fail with the following error: ```java { "code": 300, "message": "bank_account: Invalid bank account, it shouldn't be a credit card" } ``` Invalid bank\_account error on the cc-api endpoint: ```java { "code": 300, "message": "bankAccount: invalid credit card number" } ```