Payout Batch

The Upload Payout Batch page allows you to make outgoing bank transfer payments. Unlike the Single Payout option, Upload Payout Batch allows multiple payments to be submitted in a single file.

Payout files must be submitted as CSV (Comma Separated Value) files.

Important points to note:

If you create CSV files using Microsoft Excel, ensure all cells are of type 'Text'. Failure to do this may result in leading zeros within fields such as 'accountNumber' being removed.
You should use a different filename for each CSV file you upload. The Worldpay AP MAS will reject filenames that have already been used to create successful batches.

Standard format

They must be formatted with the following fields (in order):

countryCode, payee, sourceCurrency, sourceAmount, targetCurrency, targetAmount, sourceOrTarget, merchantReference, paymentReference, accountNumber, bankName, bankCode, branchCode, accountType, checkDigits, iban, swift, branchAddress, additionalInfo1, additionalInfo2, additionalInfo3, fastPayment, email, mobile, FFC, accountCurrency

You can find field specific information here.

Extended format

Used for outgoing bank transfer payments whereby additional information about the parties sending (remitter) and receiving (beneficiary) the funds are required.

Fields starting with "B_" denote beneficiary information, "R_" denotes remitter information. Click here to download a sample CSV file containing all the column names, numbers and comma positions for the extended file format.

countryCode, payee, sourceCurrency, sourceAmount, targetCurrency, targetAmount, sourceOrTarget, merchantReference, paymentReference, fastPayment, accountHolder, accountNumber, iban, swift, account currency, bankName, bankCode, branchCode, branchManager, branchAddress1, branchAddress2, branchAddress3, branchCity, branchLocation, branchState, branchCountryCode, branchPostCode, ffc, checkDigits, accountType, accountpassword, additionalInfo1, additionalInfo2, additionalInfo3, B_Title, B_FirstName, B_MiddleName, B_LastName, B_HouseNumber, B_AddressLine1, B_AddressLine2, B_AddressLine3, B_City, B_State, B_CountryCode, B_Postcode, B_District, B_PhoneNumber, B_PhoneCountryCode, B_Email, B_Mobile, B_IdType, B_IdValue, B_IdIssueInstitution, B_IdIssueDate, B_IdExpiryDate, R_AccountHolders, R_AccountNumber, R_iban, R_swift, R_accountCurrency, R_bankname, R_bankCode, R_branchCode, R_branchManager, R_BranchAddressLine1, R_BranchAddressLine2, R_BranchAddressLine3, R_BranchCity, R_BranchLocation, R_BranchState, R_BranchCountryCode, R_BranchPostCode, R_ffc, R_checkDigits, R_AccountType, R_AccountPassword, R_additionalInfo1, R_additionalInfo2, R_additionalInfo3, R_Title, R_FirstName, R_MiddleName, R_LastName, R_HouseNumber, R_AddressLine1, R_AddressLIne2, R_AddressLine3, R_City, R_State, R_CountryCode, R_PostCode, R_District, R_PhoneNumber, R_PhoneCountryCode, R_email, R_mobile, R_IdType, R_IdValue, R_IdIssueInstitution, R_IdIssueDate, R_IdExpiryDate

You can find field specific information here.

File requirements

Standard format

Field Name	Description	M/O	Length	Format	Additional Information
countryCode	Country code of where payment is to be sent	M	2	Alpha	ISO 3166-1 standard should be applied
payee	Full name of beneficiary	M	1-50	Alpha Numeric	If the beneficiary (payee) is an individual, this should be their full name including both their first and last name (no initials) with a space in-between. If the beneficiary (payee) is a company, this should be the full company name. Failure to provide the full name could result in delays and potential rejection of your payment. This must consist of 2 words, separated by a space.
sourceCurrency	The currency of the customer’s WPAP account being debited	M*	3	Alpha	ISO 4127 standard should be applied. Merchant needs to hold a WPAP account in sourceCurrency
sourceAmount	The amount of the funds to be debited from the customer’s WPAP account	M*		Numeric	Up to 2dp. This field must contain a value. 0 can be used as a default
targetCurrency	If the currency to be sent is different to the source currency, this should specify the currency to be sent	M*	3	Alpha	ISO 4127 standard should be applied.
targetAmount	The amount of Target Currency that the beneficiary should receive	M*		Numeric	Up to 2dp. This field must contain a value. 0 can be used as a default
sourceOrTarget	Whether the receiver should be paid the source amount or the target amount	M*	1	Alpha	S (source) or T (target)
merchantReference	This is where you can place their own reference relating to the transaction. Typically merchants might use this to store the username of their customer	O	1-50	Alpha Numeric
paymentReference	This field allows merchants to supply a unique identifier for this transaction. Typically, customers might use their internal unique transaction ID	O	1-50	Alpha Numeric	Must be unique
Beneficiary Bank Details
accountNumber	Account number of beneficiary where funds are to be sent	CR	Variable by country	Numeric	Country/currency specific
bankName	Name of the beneficiary bank	M	1-50	Alpha Numeric
bankCode	Bank code (sometimes known as Sort Code or Routing Code) of the beneficiary bank	CR	Variable by country	Alpha Numeric	Country/currency specific
branchCode	Branch code of the beneficiary bank	O	Variable by country	Alpha Numeric	Country/currency specific
accountType	The type of account held by the beneficiary	O	Variable by country	Alpha Numeric	Country/currency specific
checkDigits	Legacy field that is no longer used	O	N/A	N/A	N/A
iban	International Bank Account Number (IBAN)	CR	Variable by country	Alpha Numeric	Country/currency specific
swift	SWIFT BIC	CR	8 or 11	Alpha Numeric	Country/currency specific
branchAddress	The address of the beneficiary bank	O	1-50	Alpha Numeric	Country/currency specific
additionalInfo1	Any additional information that might be required	CR	1-50	Alpha Numeric	Country/currency specific
additionalInfo2	Any additional information that might be required	CR	1-50	Alpha Numeric	Country/currency specific
additionalInfo3	Any additional information that might be required	CR	1-50	Alpha Numeric	Country/currency specific
fast	This allows for same day transfers. Only available for domestic GBP Push to Account in the UK	O	1	Alpha	‘Y’ for UK Faster Payment
email	Email address for payment notification	O	1-50	Alpha Numeric	Only if set up to receive in system

Extended format

Field Name	Description	M/O	Length	Format	Additional Information
countryCode	Country code of where payment is to be sent	M	2	Alpha	ISO 3166-1 standard should be applied
payee	Full name of beneficiary	M	1-50	Alpha Numeric	If the beneficiary (payee) is an individual, this should be their full name including both their first and last name (no initials) with a space in-between. If the beneficiary (payee) is a company, this should be the full company name. Failure to provide the full name could result in delays and potential rejection of your payment. This must consist of 2 words, separated by a space.
sourceCurrency	The currency of the customers WPAP account being debited	M*	3	Alpha	ISO 4127 standard should be applied. Merchant needs to hold a WPAP account in sourceCurrency
sourceAmount	The amount of the funds to be debited from the customers WPAP account	M*	9	Numeric	Up to 2dp. This field must contain a value. 0 can be used as a default
targetCurrency	If the currency to be sent is different to the source currency, this should specify the currency to be sent	M*	3	Alpha	ISO 4127 standard should be applied.
targetAmount	The amount of Target Currency that the beneficiary should receive	M*	9	Numeric	Up to 2dp. This field must contain a value. 0 can be used as a default
sourceOrTarget	Whether the receiver should be paid the source amount or the target amount	M*	1	Alpha	S (source) or T (target)
merchantReference	This is where merchants can place their own reference relating to the transaction. Typically, customers might place their company name here	O	1-50	Alpha Numeric
paymentReference	This field allows merchants to supply a unique identifier for this transaction. Typically merchants might use their internal transaction ID for this transaction.	O	1-50	Alpha Numeric	Must be unique
fast	This allows for same day transfers. Available for UK only	O	1	Alpha	‘Y’ for UK faster payment
Beneficiary Bank Details
accountholder	Name associated to the bank account	O	1-100	Alpha Numeric
accountNumber	Account number of beneficiary where funds are to be sent	CR	Variable by country	Numeric	Country/currency specific
iban	International Bank Account Number (IBAN)	CR	Variable by country	Alpha Numeric	Country/currency specific
swift	SWIFT BIC	CR	8 or 11	Alpha Numeric	Country/currency specific
accountCurrency	Currency of the bank account	O	3	Alpha	ISO 4127 standard should be applied.
bankName	Name of the beneficiary bank	M	1-50	Alpha Numeric
bankCode	Bank code (sometimes known as Sort Code or Routing Code) of the beneficiary bank	CR	Variable by country	Alpha Numeric	Country/currency specific
branchCode	Branch code of the beneficiary bank	CR	Variable by country	Alpha Numeric	Country/currency specific
branchManager	Name of the branch manager	O	1-50	Alpha Numeric
branchAddress1	Address of the beneficiary bank	O	1-100	Alpha Numeric	Country/currency specific
branchAddress2	Address of the beneficiary bank	O	1-100	Alpha Numeric	Country/currency specific
branchAddress3	Address of the beneficiary bank	O	1-100	Alpha Numeric	Country/currency specific
branchCity	City of the beneficiary bank	O	1-50	Alpha Numeric
branchLocation	Location of the beneficiary bank	O
branchState	State of the beneficiary bank	O	1-50	Alpha Numeric
branchCountryCode		O	3	Alpha
branchPostCode	Post code of the beneficiary bank	O	1-20	Alpha Numeric
FFC		O	1-255	Alpha Numeric
checkDigits	Legacy field that is no longer used	O	N/A	N/A	N/A
accountType	The type of account held by the beneficiary	CO	Variable by country	Alpha Numeric	Country/currency specific
Account Password	Legacy field that is no longer used	O	1-255	N/A	N/A
additionalInfo1	Any additional information that might be required	CR	1-50	Alpha Numeric	Country/currency specific
additionalInfo2	Any additional information that might be required	CR	1-50	Alpha Numeric	Country/currency specific
additionalInfo3	Any additional information that might be required	CR	1-50	Alpha Numeric	Country/currency specific
Beneficiary Name and Address Information
B_Title	Beneficiary title	O	1-15	Alpha Numeric	Miss/Mrs/Ms/Mr/Dr
B_FirstName	Beneficiary first name	CR	1-50	Alpha Numeric	If the beneficiary (payee) is an individual, this should be their full name including both their first and last name (no initials) with a space in-between. If the beneficiary (payee) is a company, this should be the full company name. Should be the same as the Payee name field
B_MiddleName	Beneficiary middle name	O	1-50	Alpha Numeric
B_LastName	Beneficiary last name	O	1-50	Alpha Numeric
B_HouseNumber	Beneficiary house number or house name	O	1-30	Alpha Numeric
B_AddressLine1	Beneficiary address	CR	1-100	Alpha Numeric	Variable by Country
B_AddressLine2	Beneficiary address	O	1-100	Alpha Numeric
B_AddressLine3	Beneficiary address	O	1-100	Alpha Numeric
B_City	Beneficiary city	CR	1-50	Alpha Numeric	Variable by Country
B_State	Beneficiary state	O	1-50	Alpha Numeric
B_CountryCode	Beneficiary country code	CR	2	Alpha	Variable by Country ISO 3166-1 standard should be applied
B_Postcode	Beneficiary post code or zip code	CR	1-20	Alpha Numeric	Variable by Country
B_District	Beneficiary district	O	1-50	Alpha Numeric
Beneficiary Contact Information
B_PhoneNumber	Beneficiary phone number	O	1-20	Numeric
B_PhoneCountryCode	Beneficiary phone country code	O	2	Alpha	E.g. 44 for UK
B_Email	Beneficiary email	O	1-255	Alpha Numeric
B_Mobile	Beneficiary mobile/cell phone number	O	1-50	Numeric
Beneficiary Identification Information
B_IdType	Type of Beneficiary Identification	O	4	Numeric	One of these: 1 - Passport 2 - National ID 3 - Drivers Licence 4 - Work Permit 5 - Employment Pass 6 - Student Pass 7 - Permanent Resident Card 8 - Singapore Citizenship Card 9 - Company Registration Number 10 - Company VAT Number
B_IdValue	Value of Beneficiary Identification	O	1-50	Alpha Numeric	For example, passport number
B_IdIssueInstitution	Institution of Beneficiary Identification	O	1-100	Alpha Numeric
B_IdIssueDate	Issue date of Beneficiary Identification	O	8	Date	DDMMYYYY
B_IdExpiryDate	Expiry date of Beneficiary Identification	O	8	Date	DDMMYYYY
Remitter Bank Information
R_AccountHolders	Name(s) associated to the bank account	O	1-100	Alpha Numeric
R_AccountNumber	Account number of beneficiary where funds are to be sent	O	1-255	Alpha Numeric
R_iban	IBAN	O	1-50	Alpha Numeric
R_swift	SWIFT BIC	O	8 or 11	Alpha Numeric
R_accountCurrency	Remitter Account Currency	O	3	Alpha	ISO 4127 standard should be applied.
R_bankname	Remitter Bank Name	O	1-50	Alpha Numeric
R_bankCode	Remitter bank code	O	1-50	Alpha Numeric
R_branchCode	Remitter branch code	O	1-50	Alpha Numeric
R_branchManager	For compatibility with older integrations - can be ignored	O	1-50	Alpha Numeric
R_BranchAddressLine1	Location of the remitter bank	O	1-100	Alpha Numeric
R_BranchAddressLine2	For compatibility with older integrations - can be ignored	O	1-100	Alpha Numeric
R_BranchAddressLine3	For compatibility with older integrations - can be ignored	O	1-100	Alpha Numeric
R_BranchCity	For compatibility with older integrations - can be ignored	O	1-50	Alpha Numeric
R_BranchLocation	For compatibility with older integrations - can be ignored	O	1-255	Alpha Numeric
R_BranchState	For compatibility with older integrations - can be ignored	O	1-50	Alpha Numeric
R_BranchCountryCode	For compatibility with older integrations - can be ignored	O	3	Alpha
R_BranchPostCode	For compatibility with older integrations - can be ignored	O	1-20	Alpha Numeric
R_ffc	For compatibility with older integrations - can be ignored	O	1-255	Alpha Numeric
R_checkDigits	For compatibility with older integrations - can be ignored	O	4	Number
R_AccountType	The type of the remitter account	O	1-50	Alpha Numeric
R_AccountPassword	For compatibility with older integrations - can be ignored	O	1-255	Alpha Numeric
R_additionalInfo1	Any additional information that might be required	O	1-50	Alpha Numeric
R_additionalInfo2	Any additional information that might be required	O	1-50	Alpha Numeric
R_additionalInfo3	Any additional information that might be required	O	1-50	Alpha Numeric
Remitter Name and Address Information
R_Title	Remitter title	O	1-15	Alpha Numeric	Miss/Mrs/Ms/Mr/Dr
R_FirstName	Remitter first name	CR	1-50	Alpha Numeric	If the Remitter (Payer) is an individual, this should be their full name including both their first and last name (no initials) with a space in-between. If the Remitter (Payer) is a company, this should be the full company name. Must be provided if R_Countrycode is provided Mandatory for PSP Customers
R_MiddleName	Remitter middle name	O	1-50	Alpha Numeric
R_LastName	Remitter last name	O	1-50	Alpha Numeric
R_HouseNumber	Remitter house number or house name	O	1-30	Alpha Numeric
R_AddressLine1	Remitter address	CR	1-100	Alpha Numeric	Must be provided if R_Countrycode is provided Mandatory for PSP Customers
R_AddressLine2	Remitter address	O	1-100	Alpha Numeric
R_AddressLine3	Remitter address	O	1-100	Alpha Numeric
R_City	Remitter city	CR	1-50	Alpha Numeric	Must be provided if R_Countrycode is provided Mandatory for PSP Customers
R_State	Remitter state	O	1-50	Alpha Numeric
R_CountryCode	Remitter country code	CR	2	Alpha	Must be provided if R_Countrycode is provided Mandatory for PSP Customers ISO 3166-1 standard should be applied
R_PostCode	Remitter post code or zip code	O	1-20	Alpha Numeric
R_District	Remitter district	O	1-50	Alpha Numeric
Remitter Contact Information
R_PhoneNumber	Remitter phone number	O	1-20	Numeric
R_PhoneCountryCode	Remitter phone country code	O	2	Alpha	ISO 3166-1 standard should be applied
R_email	Remitter email	O	1-255	Alpha Numeric
R_mobile	Remitter mobile/cell phone number	O	1-50	Alpha Numeric
Remitter Identification Information
R_IdType	Type of Remitter Identification	O	4	Numeric	Please see B_IdType field for more information
R_IdValue	Value of Remitter Identification	O	1-50	Alpha Numeric	For example, passport number
R_IdIssueInstitution	Institution who issued Remitter Identification	O	1-100	Alpha Numeric
R_IdIssueDate	Issue date of Remitter Identification	O	8	Date	DDMMYYYY
R_IdExpiryDate	Expiry date of Remitter Identification	O	8	Date	DDMMYYYY

Customers have two methods of making a payment. The customer specifies which method they wish to use by specifying 'S' (Source) or 'T' (Target) in the Source or Target field. The two methods are described below:
- 'Source': This is where the customer wishes to specify a currency and amount to debit their WPAP account to pay the beneficiary
- 'Target': This is where the customer wishes to specify a currency and amount to pay the beneficiary

To send a like for like payment, you need to populate the source currency and amount, and specify the source (S). The target amount field needs a value, which will be overwritten by the source amount, and the target currency should be left blank.

To specify how much to debit the WPAP account and send in a different currency, source (S) should be specified and the source currency and amount need to be populated. The target currency should contain the currency to pay the beneficiary in, and while the target amount field needs a value, this will be overwritten once the FX conversion has been applied.

To specify how much to pay to a beneficiary, debiting from a WPAP account in a different currency, target (T) should be specified and the target currency and amount need to be populated. The source currency should contain the currency of the WPAP account to debit, and while the source amount field needs a value, this will be overwritten once the FX conversion has been applied.