This article covers:
Mass payment form field definitions
When submitting a mass payment, you will need to upload a mass payment standard file. Please refer to the table below for a description of each Mass Payment form field.
| Mass Payment form field definitions | ||||
| ID | Name | Format | Required | Notes |
| 01 | Settlement Currency | 3!a | Optional | The ISO currency code of the required settlement currency. |
| 02 | Client's Unique Reference | Alphanumeric (max 35 characters) | Optional | A unique reference to be stored against a payment Please note: This reference cannot be duplicated. |
| 03 | Target Payment Date | Alphanumeric (8 characters) |
Mandatory | The date that the payment should reach the recipient, expressed as YYYYMMDD |
| 04 | Payment Currency | Alphanumeric (3 characters) |
Mandatory | The ISO currency code of the required settlement currency. |
| 05 | Amount | Numeric (max 15 characters) |
Mandatory | The required amount. If decimal places are included, the correct number must be present. Please note: If no amount is included, or the amount is zero, the related payment row will be ignored. |
| 06 | Recipient Bank Country Code | Alphanumeric (2 characters) |
Mandatory | The ISO currency code of the required settlement currency. |
| 07 | Recipient Name | Alphanumeric (max 70 characters) |
Mandatory | The name of the recipient as it is on their bank account. |
| 08 | Recipient Email Address | Alphanumeric (max 70 characters) |
Optional | The email address of the recipient. A payment confirmation email will be sent to this address if provided. |
| 09 | Recipient Address (Line 1) |
Alphanumeric (max 35 characters) |
Optional | The first line of the recipient’s address |
| 10 | Recipient Address (Line 2) |
Alphanumeric (max 35 characters) |
Optional | The second line of the recipient’s address |
| 11 | Recipient Address (Country Code) |
Alphanumeric (2 characters) |
Optional | The ISO country code relating to the recipient’s country of residence |
| 12 | Recipient Account Number/IBAN |
Number/IBAN Alphanumeric (max 34 characters) |
Mandatory | The account number or IBAN of the recipient’s bank account |
| 13 | Recipient BIC | Alphanumeric (8 or 11 characters) |
Conditional (dependent on data entered in other fields) | The BIC (formerly SWIFT code) of the recipient bank |
| 14 | Recipient National Clearing Code |
Alphanumeric (Max 13 characters) |
Conditional (dependent on data entered in other fields) | The National Clearing Code (also known as a Routing Code) of the recipient’s bank account |
| 15 | Recipient Bank Name |
Alphanumeric (Max 35 characters) |
Conditional (dependent on data entered in other fields) | The name of the recipient’s bank |
| 16 | Recipient Bank Address (Line 1) |
Alphanumeric (Max 35 characters) |
Conditional (dependent on data entered in other fields) | The first line of the recipient’s bank account address |
| 17 | Recipient Bank Address (Line 2) |
Alphanumeric (Max 35 characters) |
Conditional (dependent on data entered in other fields) | The second line of the recipient’s bank account address |
| 18 | Recipient Bank Address (Line 3) |
Alphanumeric (Max 35 characters) |
Conditional (dependent on data entered in other fields) | The third line of the recipient’s bank account address |
| 19 | Client’s Payment Reference |
Alphanumeric (Max 70 characters) |
Conditional (dependent on data entered in other fields) | An additional reference that is included in the payment details sent to the bank |
| 20 | Intermediary Bank Name |
Alphanumeric (Max 35 characters) |
Optional | The name of any intermediary bank |
| 21 | Intermediary Bank Address (Line 1) |
Alphanumeric (Max 35 characters) |
Optional | The first line of any intermediary bank account address |
| 22 | Intermediary Bank Address (Line 2) |
Alphanumeric (Max 35 characters) |
Optional | The second line of any intermediary bank account address |
| 23 | Intermediary Bank Address (Line 3) |
Alphanumeric (Max 35 characters) |
Optional | The third line of any intermediary bank account address |
| 24 | Intermediary Bank Country Code | Alphanumeric (Max 2 characters) |
Optional | The ISO country code relating to any intermediary bank the payment is being sent to |
| 25 | Intermediary Account Number/IBAN |
Alphanumeric (max 34 characters) |
Optional | The account number or IBAN of any intermediary bank account |
| 26 | Intermediary BIC | Alphanumeric (8 or 11 characters) | Optional | The BIC (formerly SWIFT code) of any intermediary bank |
| 27 | Intermediary National Clearing Code |
Alphanumeric (Max 13 characters) |
Optional | The National Clearing Code (also known as a Routing Code) of any intermediary bank account |
| 28 | Reason For Payment | Alphanumeric (max 35 characters) |
Mandatory | The reason for making the payment (refer to the Payment File Field Definitions section) |
| 29 | Amount Type | Numeric (1 character) | Mandatory | Enter 1 for a fixed payment amount (i.e. an amount you need us to send) Enter 2 for a fixed settlement amount (i.e. an amount you have, and need us to convert) |
| 30 | Recipient Address City | Alphanumeric (Max 50 characters) |
Optional | The recipient’s city |
| 31 | Recipient Address State | Alphanumeric (Max 3 characters) |
Optional | ISO 3166-2 alpha/numeric – 2 or 3 State / Province area codes (i.e. TX, BC or NSW) of the recipient’s state |
| 32 | Recipient Address Postcode |
Alphanumeric (Max 20 characters) |
Optional | The recipient’s postcode |
|
Please note: The allowed SWIFT payment character set is
|
Mass payment data transformations
When the payment file is uploaded the data will go through a set of basic transformations that will
correct common formatting errors and ensure the data we validate meets international payment best
practices.
Examples of the transformations include:
- Change all text characters in payment data to be UPPERCASE.
- Remove empty spaces at either end of payment data.
- Remove non-SWIFT characters from payment data.
- Remove spaces and symbols from within bank account data fields (i.e. Account Number/IBAN,
National Clearing Code, BIC). - Replace ampersands (&) in payment data (that can’t be included in SWIFT payments) with plus
symbols (+), that can. - Cut long recipient and bank names to the maximum available length, to prevent failed uploads.