Cashout Creation Endpoint

Learn how to generate cashouts request by using our Cashout API v3 directly from your website

Cashout Request

Generate cashout request

This endpoint allows generating cash withdrawal requests (cashout)

post

/cashout

Header parameters

Content-Typestring · default: application/jsonrequired

Request content type

Payload-Signaturestringrequired

Control signature to verify the authenticity of the request

Example: HmacSHA256-encoded signature

Body

loginstringrequired

Your access key for the D24 CASHOUTS API

passstringrequired

Your password key for the D24 CASHOUTS API

external_idstringrequired

Unique cashout ID on the merchant side

countrystringrequired

Country of the cashout

amountnumberrequired

Cashout amount

currencystring

Currency in which the amount is specified

document_idstringrequired

Beneficiary's document ID

document_typestring

Specified identity document type

beneficiary_idstring

Beneficiary ID (for anonymous)

beneficiary_namestringrequired

Beneficiary's name

beneficiary_lastnamestring

Beneficiary's last name

emailstring

Beneficiary's email address

phonestring

Beneficiary's phone number

bank_codenumber

Beneficiary's bank code

bank_accountstring

Beneficiary's bank account

bank_branchstring

Bank branch of the beneficiary's account

account_typestring

Beneficiary's account type

addressstring

Beneficiary's address

citystring

Beneficiary's city

postal_codestring

Beneficiary's postal code

beneficiary_birthdatestring

Beneficiary's date of birth

notification_urlstringrequired

URL where notifications will be sent

commentsstring

Comments about the cashout

on_holdboolean

Marks a cashout as on hold and does not process it until manually changed to pending

typestring

Response format type

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api-stg.directa24.com/v3/cashout' \
  --header 'Content-Type: application/json' \
  --header 'Payload-Signature: text' \
  --data '{
    "login": "xxxxxxx",
    "pass": "xxxxxxx",
    "external_id": "30000000001",
    "country": "BR",
    "currency": "BRL",
    "amount": 100,
    "document_id": "01716001340",
    "beneficiary_name": "User",
    "bank_account": "3423422-7",
    "bank_code": "001",
    "bank_branch": "1234",
    "account_type": "C",
    "notification_url": "https://webhook.site/url",
    "type": "json"
  }'

200

400

401

412

200

{
  "cashout_id": "8405147"
}

Cashout request successfully created

Request Fields Description

Field	Format	Description	Validations
login	string (max length: 32)	Your D24 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 D24 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
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
document_id	string (max length: 40)	Beneficiary’s personal identification number	See document validations
document_type	string (maxLength: 15)	Beneficiary’s personal identification number type	See document types validations
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
phone	string (maxLength: 20)	Beneficiary's phone number	See phone number validations
bank_code	Integer (max length: 6)	Beneficiary's bank code	See bank codes API
bank_account	string (max length: 30)	Beneficiary's bank account number	See bank_account validations
bank_branch	string (max length: 15)	Beneficiary's bank branch number	See bank_branch validations
account_type	string (max length: 1)	Type of account	See bank_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
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]

Error response

Error response fields

Field Name	Format	Description
code	Number	Error code. See the list of error codes
message	String	Description of the error
reason	String	Reason description for KYC check failure. See the list of reasons. *Only shown in case of code 504
reason_code	Number	Reason code for KYC check failure. See the list of reason codes. *Only shown in case of code 504

Error response examples

{
  "code": 300,
  "message": "bankAccount: Invalid or missing Bank account"
}

{
  "code": 303,
  "message": "Invalid bank code"
}

{
  "code": 504,
  "message": "User unauthorized due to cadastral situation."
  "reason": "Underage user detected",
  "reason_code": 105
}

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 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 [e-mail] 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 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 if it is a valid card number and/or with a regex for each brand, like the example below.

public static final String SENSIBLE_DATA_PATTERN = new StringBuilder("(?:(?<visa>4[0-9]{12}(?:[0-9]{3})?)")
      .append("|(?<mastercard>5[1-5][0-9]{14})")
      .append("|(?<discover>6(?:011|5[0-9]{2})[0-9]{12})")
      .append("|(?<amex>3[47][0-9]{13})")
      .append("|(?<diners>3(?:0[0-5]|[68][0-9])?[0-9]{11})")
      .append("|(?<jcb>(?: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.

Sending a debit card number through the non-cc endpoint will make the request to fail with the following error:

{
    "code": 300,
    "message": "bank_account: Invalid bank account, it shouldn't be a credit card"
}

Invalid bank_account error on the cc-api endpoint:

{
    "code": 300,
    "message": "bankAccount: invalid credit card number"
}