Authorisation for a recurring payment

Mandatory sub-lines

The PaymentDetails, Recurring, and ShopperInteraction sub-lines described below are mandatory when submitting a recurring payment authorization request.

PaymentDetails

  • 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

(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: PaymentDetails

(tick)

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

4

Numeric

(tick)

Amount.

5

Numeric

(tick)

6

Alphabetic

(tick)

The three-character ISO currency code.

7

Alphanumeric

(error)

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

Required element for recurring payments and to create recurring contracts.

8

Email address

(error)

The shopper's email address.

Required element for recurring payments and to create recurring contracts.

9

Alphanumeric

(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

Numeric

(error)

Fraud offset.
The value to be applied to offset the calculated risk score.
It can be either a positive or a negative value.

Recurring

Field #

Format

Required

Description

1

Fixed value: SL
(tick)

Record type identifier

2

Numeric

(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: RECURRING

(tick)

The type of a recurring contract.

5

Allowed values:
  • Adyen's 16-character unique token, or
  • LATEST

(tick)

  • The 16-digit unique token corresponds to the selectedRecurringDetailReference field value.
    It targets a specific stored recurring data set.
  • If you specify LATEST, the latest/more recent data set is fetched for usage.

ShopperInteraction

  • This sub-line holds information about payments requests involving shopper interaction.
  • Include a ShopperInteraction sub-line when you are submitting these transaction types:
    • ContAuth
    • Moto

You can add a ShopperInteraction sub-line to any sub-line option that supports a shopper interaction other than Ecommerce:

  • Authorisation
  • Recurring
  • StoreToken

Field #

Format

Required

Description

1

Fixed value: SL
(tick)

Record type identifier

2

Numeric

(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: ShopperInteraction

(tick)

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

4

Allowed values:

  • ContAuth

  • Ecommerce

  • Moto

  • POS


(tick)

The type of shopper interaction transaction to carry out.

Unless you need to perform a MOTO transaction, set this field value to ContAuth.

Example
FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,Ref123,s.hopper@gmail.com,,,
SL,2,Recurring,RECURRING,LATEST
SL,3,ShopperInteraction,ContAuth
BT,1
FT,1

Optional sub-lines

The Address and MerchantOrderReference sub-lines described below can be optionally included in the payment request. 

Address

You can use the Address sub-line to include information about the shopper's billing and delivery addresses.
You need to specify billing and deliver addresses on separate Address sub-lines:

  • One Address sub-line containing the billing address information;
  • One Address sub-line containing the delivery address information.

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric

(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: Address

(tick)

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

4

Allowed values:

  • Billing
  • Delivery

(tick)

The type of address that is being submitted: either a billing or a delivery address.

5

Alphanumeric

(tick)

Street address.

6

Alphanumeric

(tick)

House number or name.

7

Alphanumeric

(tick)

City.

8

Alphanumeric

(tick)

ZIP/Post code.

9

Alphanumeric

(tick)

State/Province/Region.

10

Alphabetic

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

Example
FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,,,,,
SL,2,Recurring,RECURRING,LATEST
SL,3,ShopperInteraction,ContAuth
SL,4,Address,Billing,South Buena Vista Street,500,Burbank,91521,CA,US
SL,5,Address,Delivery,Some Street,123,Some Town,90102,CA,US
BT,1
FT,1

MerchantOrderReference

Field #

Format

Required

Description

1

Fixed value: SL

(tick)

Record type identifier

2

Numeric

(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: MerchantOrderReference

(tick)

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

4

Alphanumeric

(tick)

Value of your order reference.

Example
FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,Authorisation,Test Product 6,
SL,1,PaymentDetails,100,2,SEK,,,,,
SL,2,Card,4111111111111111,08,2018,737,CardHolderName,,,
SL,3,MerchantOrderReference,XY66AB
BT,1
FT,1