Payout request

Mandatory sub-lines

The PayoutDetails and Recurring sub-lines described below are mandatory when submitting a payout authorisation request. You also need to include either a Card, BankAccount, or IBAN sub-line on your payout request.

PayoutDetails

  • This sub-line specifies transaction amount and customer details.
  • Optional fields: if you do not populate one or more non-mandatory fields and leave them blank, you need in any case to insert delimiting commas because the Adyen payments platform expects a preset, fixed number of fields per line/sub-line. 

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: PayoutDetails

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

Amount.

5

Numeric [0-9]+

(tick)

6

Alphabetic data [A-Z, a-z]

(tick)

The three-character ISO currency code.

7

Alphabetic data [A-Z, a-z]

(tick)

A shopper's reference, which is the unique identifier for a shopper.

8

Email address

(tick)

The shopper's email address.

9

Alphabetic data [A-Z, a-z]

(error)

Shopper statement.
The soft descriptor for the transaction.

10

IP address

(error)

The IP address the shopper used to carry out the transaction.

11 YYYY-MM-DD (tick) The shopper's birth date.
12

Numeric [0-9]+

(error) The shopper's social security number.
13

Alphabetic data [A-Z, a-z]

(tick)

The type of the entity the payout is processed for.

Allowed values:

  • NaturalPerson
  • Company
14

Alphabetic data [A-Z, a-z]

(tick)

The shopper's nationality.

A valid value is an ISO 2-character country code (e.g. 'NL').

Recurring

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: Recurring

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Fixed value: PAYOUT

(tick)

The type of recurring payment.

5

Fixed value: Latest

(tick)

Fixed value.

Card

Besides the required PayoutDetails and Recurring sub-lines described above, a payout request needs to include either a CardBankAccount, or IBAN payment method.

For this payout, you need a user role with permission to store payout details.

  • This sub-line holds information about card payments.
  • In an authorization request for card payments, the Card sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)
SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: Card

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Numeric [0-9]+

(tick)

Card number.

5

Numeric [0-9]+

(tick)

Expiry month.

  • Format: MM, zero-padded (eg: 03)

6

Numeric [0-9]+

(tick)

Expiry year.

  • Format: YYYY (eg: 2016)
7

Numeric [0-9]+

(tick)

CVC code.

  • Three-digit CVC/CVV code (Visa, Mastercard, Discover)
  • Four-digit CVC/CVV code (American Express)

8

Alphabetic data [A-Z, a-z]

(tick)

Cardholder name.

9

Numeric [0-9]+

(error)

Start month.

  • Format: MM, zero-padded (eg: 03)

Maestro UK only.

10

Numeric [0-9]+

(error)

Start year.

  • Format: YYYY (eg: 2016)

Maestro UK only.

11

Numeric [0-9]+

(error)

One-digit card issue number.

Maestro UK only.

Example Payout request with Card sub-line
FH,1.0,TEST,Company,TestCompany,Default,1,storeToken@Company.TestCompany,Payout,FileHeaderEchoData 
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Payout,MerchantReference,
SL,1,PayoutDetails,1000,2,EUR,ShopperRef28411,test-payout@test.com,TESTING TX01234156XT,10.0.0.1,2017-01-11,123456789,NaturalPerson,NL
SL,2,Card,4444333322221111,12,2012,J. de Tester,,,
SL,3,Recurring,PAYOUT,LATEST
BT,1 
FT,1

BankAccount

Besides the required PayoutDetails and Recurring sub-lines described above, a payout request needs to include either a CardBankAccount, or IBAN payment methods.

For this payout, you need a user role with permission to store payout details.

  • This sub-line holds information about bank transfer payments carried out using the shopper's bank account details.
  • In an authorisation request for bank account payments, the BankAccount sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: BankAccount

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphabetic data [A-Z, a-z]

(tick)

Bank account owner name.

5

Alphabetic data [A-Z, a-z]

(tick)

Two-letter country code.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO web site.

6

Numeric [0-9]+

(tick)

Bank account number.

7

Alphabetic data [A-Z, a-z]

(tick)

Two-letter bank location.

  • Format: AA

8

Alphabetic data [A-Z, a-z]

(tick)

Two-letter bank name.

  • Format: AA

9

Numeric [0-9]+

(tick)

Bank code.

10

Alphabetic data [A-Z, a-z]

(error)

Two-letter check code.

  • Format: AA

Example Payout request with BankAccount sub-line
FH,1.0,TEST,Company,TestCompany,Default,1,storeToken@Company.TestCompany,Payout,FileHeaderEchoData 
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Payout,MerchantReference,
SL,1,PayoutDetails,1000,2,EUR,ShopperRef28411,test-payout@test.com,TESTING TX01234156XT,10.0.0.1,2017-01-11,123456789,NaturalPerson,NL
SL,2,BankAccount,Simon Hopper,SE,123456789,20010020,Postbank Stockholm,3125876,Hameln
SL,3,Recurring,PAYOUT,LATEST
BT,1 
FT,1

IBAN

Besides the required PayoutDetails and Recurring sub-lines described above, a payout request needs to include either a CardBankAccount, or IBAN payment methods.

For this payout, you need a user role with permission to store payout details.

  • This sub-line holds information about bank transfer or SEPA Direct Debit (DD) payments carried out using the shopper's IBAN details.
  • In an authorization request for IBAN payments, the IBAN sub-line needs to be submitted as sub-line 2.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric [0-9]+

(tick)

SL sub-line record number reference within its parent line.

The counter starts at 1, and it increments sequentially by one unit.

3

Fixed value: IBAN

(tick)

Transaction type.
Defines the required field types for the specific sub-line.

4

Alphanumeric (A-Z, a-z, 0-9), cannot be only numbers. Minimum 3 characters.

(tick)

Bank account owner name.

If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'.

5

Alphabetic data [A-Z, a-z]

(tick)

Two-letter country code.

The country value format needs to adhere to the ISO 3166-1 alpha-2 standard. An invalid country code results in a transaction/request rejection. You can look up country codes on the ISO web site.

6

Alphabetic data [A-Z, a-z]

(tick)

IBAN code.

7

Alphabetic data [A-Z, a-z]

(error)

BIC code.

Example Payout request with IBAN sub-line
FH,1.0,TEST,Company,TestCompany,Default,1,storeToken@Company.TestCompany,Payout,FileHeaderEchoData 
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Payout,MerchantReference,
SL,1,PayoutDetails,1000,2,EUR,ShopperRef28411,test-payout@test.com,TESTING TX01234156XT,10.0.0.1,2017-01-11,123456789,NaturalPerson,NL
SL,2,IBAN,A. Klaassen,NL,NL13TEST0123456789,
SL,3,Recurring,PAYOUT,LATEST
BT,1 
FT,1