Bank transfer batch

📘
This page relates to fileds required for bank transfer payments batches. For cheques, refer to Issuing cheques

Transaction Fields

These fields are associated with the transaction itself, and do not have a prefix. The transaction is considered to the the "container" for recipient data, as the recipient is in effect a sub-object of the transaction.

📘
Parameters with an * (asterisk) are mandatory. Bracketed asterisks (*) are for mandatory parameters with exceptions.

Name	Datatype	Comments
CorrelationId	String (64)	This could be the unique ID in your system, or a unique request ID. We only store this value, nothing is done with it.
SendAccountId*	Integer	Select which account to debit funds from.
SendCurrency*	String (3)	ISO 4217 such as such as 'GBP', 'EUR' and 'USD'.
SendValue(*)	Decimal	The amount you wish to send to the recipient, in the SendCurrency. See notes below.
ReceiveValue(*)	Decimal	The amount you wish the recipient to receive. See the notes below.
ExternalReference1	String (128)	Optional but highly reccommended. Typically the payment reference in your system. First characters are visible to the Recipient on their bank statement.
ExternalReference2	String (128)	Optional data provided by your system.
ExternalReference3	String (128)	Optional data provided by your sysem.
Extra	String (4000)	An optional string that your system can send to ours which allows you to store additional data alongside the transaction. This is typically used to store structred data as JSON.
RouteType	String	If omitted, 'BankAccount' is the default. See the documenttation on Rules for further details here.

📘
(*) When posting a transaction, you need to either specify how much you want to send, with a value in the SendValue column, or how much you want the recipient to receive, in which case you use the ReceiveValue field. Use one of these values, not both.

Recipient fields

There are two types of recipient in our system - regular recipients (i.e. recipients you are only likely to pay once), and stored recipients, which you may wish to pay multiple times.

Recipient

The following are the fields to specify for a recipient.

📘
Parameters with an * (asterisk) are mandatory.

Name	Datatype	Comments
RecipientAddressStreetName *	String (128)	For structured addresses: Street name of the recipient’s residential address.
RecipientAddressBuildingNumber *	String (16)	For structured addresses: Building number of the recipient’s residential address.
RecipientAddressTownName *	String (128)	For structured addresses: City or town of the recipient’s residential address.
RecipientAddressPostCode *	String (128)	For structured addresses: Postal/ZIP code of the recipient’s residential address.
RecipientAddressCountrySubDivision *	String (128)	For structured addresses: State, province, OR region of the recipient’s residential address
RecipientAddressCountry *	String (2)	For structured addresses: Two-letter country code of the recipient’s residential address, in the ISO 3166 Alpha 2 format, such as 'GB'.
RecipientAddressLine1	String (128)	For structured addresses: Additional area, suite, flat floor... information.
RecipientAddressLine2	String (128)	For structured addresses: More address information.
RecipientAddress	String (256)	Full unstructured address of the recipient’s residence. Will be overwritten by the structured address, if both are supplied. Please read Important updates that require action to verify if unstructured address can be used instead of the structured address.
RecipientBirthdate	Date
RecipientCountry*	String (2)	ISO 3166 Alpha 2 format, such as 'GB'
RecipientCurrency*	String (3)	ISO 4217 format, such as 'GBP'
RecipientEmail	String (128)
RecipientName*	String (256)
RecipientNationality	String (2)	ISO 3166 Alpha 2 format, such as 'GB'
RecipientPhoneNumber	String (32)
RecipientReference*	String (128)*	This is the reference that typically shows on the recipients bank statement. May be much shorter depending on the route, cf. Rules.
RecipientType	`Person`or `Business`	Defines the type of recipient, individual or company. `Person` if not supplied.

Stored Recipient

The following fields are those that are used when selecting an existing recipient.

📘
Parameters with an * (asterisk) are mandatory.

Name	Datatype	Comments
RecipientEmail	String (128)
RecipientReference*	String (128)*	This is the reference that typically shows on the recipients bank statement
StoredRecipientId*	String (64)	This defines the unique ID of the stored recipient, and is typically the primary key in your system for the stored recipient. When you create stored recipients in our system, you can supply this value at that point. For more information please see the documentation on Recipients. This value is the ExternalStoredRecipientId from the stored recipient API.

Name

Datatype

Comments

RecipientEmail

String (128)

RecipientReference*

String (128)*

This is the reference that typically shows on the recipients bank statement

StoredRecipientId*

String (64)

This defines the unique ID of the stored recipient, and is typically the primary key in your system for the stored recipient.

When you create stored recipients in our system, you can supply this value at that point.

For more information please see the documentation on Recipients.

This value is the ExternalStoredRecipientId from the stored recipient API.

As for regular recipients, the length of the RecipientReference field is dependant on the destination country.

Account Fields

There are a large number of fields associated with a recipient account, depending on the destination country and currency. You only need column headers in the batch file for the fields you're using. For example, if your batch only contains payments to Europe, you can specify the IBAN and SWIFT codes and omit all other fields.

Property	Type	Description
AccountAbaCode	String	ABA code
AccountNumber	String	Account number
AccountBankAccountType	String	Bank account type. Values will vary by country. For US/USD, you can use "Checking" or "Savings", if omitted then the deafult is "Checking".
AccountBankAddress	String	Bank address
AccountBankCity	String	Bank city
AccountBankMfo	String	Payee's bank MFO
AccountBankName	String	Bank name
AccountBban	String	BBAN
AccountBIK	String	BIK Code
AccountBinOrIin	String	BIN or IIN
AccountBranchAgencyCode	String	Branch agency code
AccountBranchCode	String	Branch code
AccountBranchName	String	Branch name
AccountBsbCode	String	Bank State Branch code
AccountChineseId	String	Chinese Id
AccountClabe	String	CLABE
AccountIban	String	IBAN
AccountIdCardOrPassportNumber	String	ID card or passport number
AccountIfscCode	String	IFSC code
AccountKnpOrUpdc	String	KNP or UPDC
AccountKonstant Symbol	String	Konstant symbol
AccountNibCode	String	NIB code
AccountNuban	String	NUBAN
AccountPaymentCode	String	Payment code
AccountPaymentPurpose	String	Purpose of payment
AccountProvince	String	Province
AccountRegistrationNumber	String	Registration number
AccountRoutingNumber	String	Routing number
AccountSortCode	String	Sort code
AccountSpecificSymbol	String	Specific symbol
AccountSwift	String	Swift code
AccountTaxId	String	Tax Id
AccountVariableSymbol	String	Variable symbol
AccountVoCode	String	VO code
AccountBankGiro	String	Swedish BankGiro Number
AccountPlusGiro	String	Swedish PlusGiro Number
AccountOcrReferenceNumber	String	OCR Reference Number
AccountBankCode	String	Bank Code
AccountKidReferenceNumber	String	Swedish KID Reference Number

All of the Account fields have associated validation rules. Please refer to Rules for information.

Originator Fields (optional)

Some of our merchants send in tranasctions for which they are not the originator - this might be the case if you are an aggregator and receive transactions from your customers which are passed on to us.

In this case we'll have set you up as requiring to send originator details to us. These fields identify the originator of the funds. The fields are as follows and are all mandatory, should you wish to add originator data to the batch line.

Name	Datatype	Comments
OriginatorAddress	String (256)
OriginatorIdentifier	String (256)	Commonly the primary key in your system for the originator, but could also be details such as a National Insurance number in the UK, or a Social Security number in the US.
OriginatorName	String (256)