RefundWithData request

Mandatory sub-lines

The PaymentDetails sub-line along with either a Card or IBAN sub-line described below are mandatory when submitting a bank transfer authorisation 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 [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: PaymentDetails

(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]

(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

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

Numeric [0-9]+

(error)

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

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

Numeric [0-9]+

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

Alphabetic data [A-Z, a-z]

(tick)

The type of the entity the payout is processed for.

Allowed values:

  • NaturalPerson
  • Company
15

Alphabetic data [A-Z, a-z]

(tick)

The shopper's nationality.

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

Card

Besides the required PaymentDetails sub-line described above, a refund with data request needs to include either a Card or IBAN sub-line.

  • 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 RefundWithData request with Card sub-line
FH,1.0,TEST,Company,TestCompany,TestRefundWithData,1,ws@Company.TestCompany,RefundWithData,FileHeaderEchoData
BH,1,BlockHeaderEchoData 
L,1,MerchantAccount,TestMerchant,RefundWithData,40975 
SL,1,PaymentDetails,1000,2,EUR,ShopperRef28411,test-payout@adyen.com,TESTING TX01234156XT,,,2017-01-11,123456789,NaturalPerson,NL
SL,2,Card,4111111111111111,06,2016,CardHolderName,,, 
BT,1
FT,1

IBAN

Besides the required PaymentDetails sub-line described above, a refund with data request needs to include either a Card or IBAN sub-line.

  • 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 RefundWithData request with IBAN sub-line
FH,1.0,TEST,Company,TestCompany,TestRefundWithData,1,ws@Company.TestCompany,RefundWithData,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,RefundWithData,40975
SL,1,PaymentDetails,1000,2,EUR,ShopperRef28411,test-payout@adyen.com,TESTING TX01234156XT,,,2017-01-11,123456789,NaturalPerson,NL
SL,2,IBAN,Test Testing,NL,NL13TEST0123456789
BT,1
FT,1

Optional sub-lines

The Address sub-line 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 [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: 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

Alphabetic data [A-Z, a-z]

(tick)

Street address.

6

Alphabetic data [A-Z, a-z]

(tick)

House number or name.

7

Alphabetic data [A-Z, a-z]

(tick)

City.

8

Alphabetic data [A-Z, a-z]

(tick)

ZIP/Post code.

9

Alphabetic data [A-Z, a-z]

(tick)

State/Province/Region.

10

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.