No momento, esta página não está disponível em português
Tools-2 icon

StoreToken request for payout

Mandatory sub-lines

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

  • StoreToken enables tokenising payment details.
  • Only payment requests submitted after sending the StoreToken request are tokenised.

ShopperDetails

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 -white_check_mark- Record type identifier
2 Numeric -white_check_mark- 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: ShopperDetails -white_check_mark- Transaction type.
Defines the required field types for the specific sub-line.
4 Alphanumeric -white_check_mark- A shopper's reference, which is the unique identifier for a shopper.
5 Email address -white_check_mark- The shopper's email address.

Recurring

If you include this subline in your batch file, a recurring payment request is created with the provided payment details.

Field # Format Required Description
1 Fixed value: SL -white_check_mark- Record type identifier
2 Numeric -white_check_mark- 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 -white_check_mark- Transaction type.
Defines the required field types for the specific sub-line.
4 Fixed value: PAYOUT -white_check_mark- The type of recurring payment.
5 Fixed value: Latest -white_check_mark- Fixed value.

Card

Besides the required  ShopperDetails and Recurring  sub-lines described above, a StoreToken request needs to include either a  Card ,  BankAccount , or  IBAN  payment method.

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

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

Field #

Format

Required

Description

1

Fixed value: SL

-white_check_mark-

Record type identifier

2

Numeric

-white_check_mark-

`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

-white_check_mark-

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

4

Numeric

-white_check_mark-

Card number.

5

Numeric

-white_check_mark-

Expiry month.

  • Format: MM, zero-padded (ex.: 03)

6

Numeric

-white_check_mark-

Expiry year.

    • Format: YYYY (ex.: 2016)

7

Numeric

-x-

CVC code.
Leave this field blank.

8

Alphanumeric

-white_check_mark-

Card holder name.

9

Numeric

-x-

Start month.

  • Format: MM, zero-padded (ex.: 03)

Maestro UK only.

10

Numeric

-x-

Start year.

  • Format: YYYY (ex.: 2016)

Maestro UK only.

11

Numeric

-x-

One-digit card issue number.

Maestro UK only.

FH,1.0,TEST,Company,TestCompany,Default,1,storeToken@Company.TestCompany,Payout,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,StoreToken,MerchantReference,
SL,1,ShopperDetails,test@adyen.com,test@adyen.com
SL,2,Card,4444333322221111,12,2012,,J. de Tester,,,
SL,3,Recurring,PAYOUT,Latest
BT,1
FT,1

BankAccount

Besides the required  ShopperDetails and Recurring  sub-lines described above, a StoreToken request needs to include either a  Card ,  BankAccount , or  IBAN  payment method.

For this StoreToken, 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

-white_check_mark-

Record type identifier

2

Numeric

-white_check_mark-

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

-white_check_mark-

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

4

Alphanumeric

-white_check_mark-

Bank account owner name.

5

Alphabetic

-white_check_mark-

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 website.

6

Numeric

-white_check_mark-

Bank account number.

7

Alphabetic

-white_check_mark-

Two-letter bank location.

  • Format: AA

8

Alphabetic

-white_check_mark-

Two-letter bank name.

  • Format: AA

9

Numeric

-white_check_mark-

Bank code.

10

Alphabetic

-x-

Two-letter check code.

  • Format: AA

FH,1.0,TEST,Company,TestCompany,Default,1,storeToken@Company.TestCompany,Payout,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,StoreToken,MerchantReference,
SL,1,ShopperDetails,test@adyen.com,test@adyen.com
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  ShopperDetails and Recurring  sub-lines described above, a StoreToken request needs to include either a  Card ,  BankAccount , or  IBAN  payment method.

For this StoreToken, 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 -white_check_mark- Record type identifier
2 Numeric -white_check_mark- 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 -white_check_mark- Transaction type.
Defines the required field types for the specific sub-line.
4 Alphanumeric
Cannot be only numbers. Minimum three characters.		 -white_check_mark- Bank account owner name.
If provided details do not match the required format, the response returns the error message: 203 'Invalid bank account holder name'.
5 Alphabetic -white_check_mark- 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 website.
6 Alphanumeric -white_check_mark- IBAN code.
7 Alphanumeric -x- BIC code. 
FH,1.0,TEST,Company,TestCompany,Default,1,storeToken@Company.TestCompany,Payout,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,StoreToken,MerchantReference,
SL,1,ShopperDetails,test@adyen.com,test@adyen.com
SL,2,IBAN,A. Klaassen,NL,NL13TEST0123456789,
SL,3,Recurring,PAYOUT,Latest
BT,1
FT,1