Tools-2 icon

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

Field #

Format

Field Required

Value Required

Description

1

Fixed value: SL

Record type identifier

2

Numeric

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

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

4

Numeric

Amount.

5

Numeric

The currency exponent.

6

Alphabetic

The three-character ISO currency code.

7

Alphanumeric

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

The shopper's email address.

Required element for recurring payments and to create recurring contracts.

9

Alphanumeric

Shopper statement.
The soft descriptor for the transaction.

10

IP address

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

11

Numeric

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

The shopper's birth date.

13

Numeric

The shopper's social security number.

14

Allowed values:

  • NaturalPerson
  • Company

The type of the entity the payout is processed for.

15

Alphabetic

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

Example PaymentDetails sub-lines

The following example sub-line is valid:
SL,1,PaymentDetails,1000,2,USD,1991-01-11,NaturalPerson,US

  • It includes all the fields that are required (amount, currency exponent, ISO currency code, shopper's birth date, type of entity, shopper's nationality)
  • It contains a value for each required field (respectively: 1000, 2, USD, 1991-01-11, NaturalPerson, US)

The following example sub-line is also valid:
SL,1,PaymentDetails,1000,,USD,,,

  • It includes all the fields that are required (amount, currency exponent, ISO currency code, shopper's birth date, type of entity, shopper's nationality)
  • It contains an empty value for required fields that do not need a value (currency exponent, shopper's birth date, type of entity, shopper's nationality)

The following example sub-line is not valid:
SL,1,PaymentDetails,1000,USD

  • It doesn't include all the required fields and (empty) values.

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

Record type identifier

2

Numeric

`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

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

4

Numeric

Card number.

5

Numeric

Expiry month.

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

6

Numeric

Expiry year.

  • Format: YYYY (eg: 2016)

7

Numeric

CVC code.

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

8

Alphanumeric

Cardholder name.

9

Numeric

Start month.

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

Maestro UK only.

10

Numeric

Start year.

  • Format: YYYY (eg: 2016)

Maestro UK only.

11

Numeric

One-digit card issue number.

Maestro UK only.

FH,1.0,TEST,Company,TestCompany,TestRefundWithData,1,[email protected],RefundWithData,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,RefundWithData,40975
SL,1,PaymentDetails,1000,2,EUR,ShopperRef28411,[email protected],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 Record type identifier
2 Numeric 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 Transaction type.
Defines the required field types for the specific sub-line.
4 Alphanumeric
Cannot be only numbers. Minimum three characters.
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 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 IBAN code.
7 Alphanumeric BIC code.
FH,1.0,TEST,Company,TestCompany,TestRefundWithData,1,[email protected],RefundWithData,FileHeaderEchoData
BH,1,BlockHeaderEchoData
L,1,MerchantAccount,TestMerchant,RefundWithData,40975
SL,1,PaymentDetails,1000,2,EUR,ShopperRef28411,[email protected],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

Record type identifier

2

Numeric

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

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

4

Allowed values:

  • Billing
  • Delivery

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

5

Alphanumeric

Street address.

6

Alphanumeric

House number or name.

7

Alphanumeric

City.

8

Alphanumeric

ZIP/Post code.

9

Alphanumeric

State/Province/Region.

10

Alphabetic

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.