{"title":"Payout request","category":"default","creationDate":1779620072,"content":"

Mandatory sub-lines<\/h2>\n

The \n PayoutDetails<\/code>\n<\/a> and \n Recurring<\/code>\n<\/a> sub-lines described below are mandatory when submitting a payout authorisation request.\u00a0You also need to include either a\u00a0\n Card<\/code>\n<\/a>,\u00a0\n BankAccount<\/code>\n<\/a>, or\u00a0\n IBAN<\/code>\n<\/a>\u00a0sub-line on your\u00a0payout request.<\/p>\n

PayoutDetails<\/h3>\n

Field #<\/strong><\/p><\/th>

Format<\/strong><\/p><\/th>

Required<\/strong><\/p><\/th>

Description<\/strong><\/p><\/th><\/tr><\/thead>

\n

1<\/p>\n<\/td>

\n

Fixed value: SL<\/code><\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

Record type identifier<\/p>\n<\/td><\/tr>

\n

2<\/p>\n<\/td>

\n

Numeric<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

SL<\/code> sub-line record number reference within its parent line.
The counter starts at 1, and it increments sequentially by one unit.<\/p>\n<\/td><\/tr>

\n

3<\/p>\n<\/td>

\n

Fixed value: PayoutDetails<\/code><\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

Transaction type.
Defines the required field types for the specific sub-line.<\/p>\n<\/td><\/tr>

\n

4<\/p>\n<\/td>

\n

Numeric<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

Amount.<\/p>\n<\/td><\/tr>

\n

5<\/p>\n<\/td>

\n

Numeric<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

The currency exponent<\/a>.<\/p>\n<\/td><\/tr>

\n

6<\/p>\n<\/td>

\n

Alphabetic<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

The three-character ISO currency code<\/a>.<\/p>\n<\/td><\/tr>

\n

7<\/p>\n<\/td>

\n

Alphanumeric<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

A shopper's reference, which is the unique identifier for a shopper.<\/p>\n<\/td><\/tr>

\n

8<\/p>\n<\/td>

\n

Email address<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

The shopper's email address.<\/p>\n<\/td><\/tr>

\n

9<\/p>\n<\/td>

\n

Alphanumeric<\/p>\n<\/td>

\n

\"-x-\"<\/p>\n<\/td>

\n

Shopper statement.
\nThe soft descriptor<\/a> for the transaction.<\/p>\n<\/td><\/tr>

\n

10<\/p>\n<\/td>

\n

IP address<\/p>\n<\/td>

\n

\"-x-\"<\/p>\n<\/td>

\n

The IP address the shopper used to carry out the transaction.<\/p>\n<\/td><\/tr>

\n

11<\/p>\n<\/td>

\n

YYYY-MM-DD<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

The shopper's birth date.<\/p>\n<\/td><\/tr>

\n

12<\/p>\n<\/td>

\n

Numeric<\/p>\n<\/td>

\n

\"-x-\"<\/p>\n<\/td>

\n

The shopper's social security number.<\/p>\n<\/td><\/tr>

\n

13<\/p>\n<\/td>

\n

Allowed values:

  • NaturalPerson<\/code><\/li>
  • Company<\/code><\/li><\/ul><\/p>\n<\/td>
\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

The type of the entity the payout is processed for.\u00a0<\/p>\n<\/td><\/tr>

\n

14<\/p>\n<\/td>

\n

Alphabetic<\/p>\n<\/td>

\n

\"-white_check_mark-\"<\/p>\n<\/td>

\n

The shopper's nationality.A valid value is an ISO 2-character country code (e.g. 'NL').<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

Recurring<\/h3>\n\n\n\n\n\n\n\n\n\n
Field #<\/th>\nFormat<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
1<\/td>\nFixed value: SL<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nRecord type identifier<\/td>\n<\/tr>\n
2<\/td>\nNumeric<\/td>\n\"-white_check_mark-\"<\/td>\nSL<\/code> sub-line record number reference within its parent line.The counter starts at 1, and it increments sequentially by one unit.<\/td>\n<\/tr>\n
3<\/td>\nFixed value:\u00a0Recurring<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nTransaction type.
Defines the required field types for the specific sub-line.<\/td>\n<\/tr>\n
4<\/td>\nFixed value:\u00a0PAYOUT<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nThe type of recurring payment.<\/td>\n<\/tr>\n
5<\/td>\nFixed value: Latest<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nFixed value.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Card<\/h3>\n

Besides the required PayoutDetails<\/code>\u00a0and\u00a0Recurring<\/code>\u00a0sub-lines described above, a payout request needs to include\u00a0either a\u00a0Card<\/code>,\u00a0BankAccount<\/code>, or\u00a0IBAN<\/code>\u00a0payment method.<\/p>\n

\n

For this payout, you need a user role with permission to store payout details.<\/p>\n<\/div><\/div>\n

\n