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

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: PayoutDetails		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.
8	Email address		The shopper's email address.
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	YYYY-MM-DD		The shopper's birth date.
12	Numeric		The shopper's social security number.
13	Allowed values: NaturalPerson Company		The type of the entity the payout is processed for.
14	Alphabetic		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		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: Recurring		Transaction type. Defines the required field types for the specific sub-line.
4	Fixed value: PAYOUT		The type of recurring payment.
5	Fixed value: Latest		Fixed value.

Card

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

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,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 Card, BankAccount, or IBAN payment methods.

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: BankAccount		Transaction type. Defines the required field types for the specific sub-line.
4	Alphanumeric		Bank account owner 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	Numeric		Bank account number.
7	Alphabetic		Two-letter bank location. Format: AA
8	Alphabetic		Two-letter bank name. Format: AA
9	Numeric		Bank code.
10	Alphabetic		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,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 Card, BankAccount, or IBAN payment methods.