The bank accounts of beneficiaries can have different relevant fields depending on their country and currency.
Get Beneficiary Bank Account Fields can tell you which fields are relevant and that Create pay run will accept.
See below for the full description of each possible field.
| Field Name | Description | Validation Regex |
|---|---|---|
iban | IBAN | Differs by country, see the official specification |
swiftBic | Swift BIC (ISO 9632) | ^[A-Z]{6}[A-Z0-9]{2}(?:[A-Z0-9]{3})?$ |
gbSortCode | UK Sort Code | ^(?!\\d{6}$)(?:\\d{2}-?){2}\\d{2}$ |
gbAccountNumber | UK Account Number | ^\d{8}$ |
auAccountNumber | Australian Account Number | ^[A-Z0-9]{5,20}$ |
auBsb | Australian BSB Number | ^\d{6}$ |
caAccountNumber | Canadian Account Number | ^[A-Z0-9]{7,35}$ |
caInstitutionNumber | Canadian Institution Number | ^\d{3}$ |
caTransitNumber | Canadian Transit Number | ^\d{5}$ |
dkAccountNumber | Danish Account Number | ^\d{4,10}$ |
dkBankCode | Danish Bank Code | ^d{4}$ |
hkAccountNumber | Hong Kong Account Number | ^\d{9,12}$ |
hkBankCode | Hong Kong Bank Code | ^\d{3}$ |
idAccountNumber | Indonesian Account Number | ^\d{5,16}$ |
inAccountNumber | Indian Account Number | ^[A-Z0-9]{1,20}$ |
mxClabe | Mexican CLABE | ^\d{18}$ |
myAccountNumber | Malaysian Account Number | ^\d{5,16}$ |
noAccountNumber | Norweigian Account Number | ^\d{7}$ |
noBankCode | Norweigian Bank Code | ^\d{4}$ |
nzAccountNumber | New Zealand Account Number | ^\d{2}-?\d{4}-?\d{7}-?\d{2,3}$ |
phAccountNumber | Phillipines Account Number | ^\d{1,17}$ |
seAccountNumber | Swedish Account Number | ^\d{1,15}$ |
seBankCode | Swedish Bank Code | ^\d{4,5}$ |
sgAccountNumber | Singapore Account Number | ^[A-Z0-9]{6,34}$ |
usAccountNumber | US Account Number | ^\d{4,17}$ |
usAchAba | US ACH ABA | ^\d{9}$ |
usFedwireAba | US Fedwire ABA | ^\d{9}$ |
xxAccountNumber * | Country Account Number | ^[A-Z0-9]{1,22}$ |
*Other countries not listed above may also have an Account Number as a required field, if returned this will always take the form of [ISO-2 Country Code]AccountNumber e.g. bbAccountNumber may be returned for the input ?country=BB. Such account numbers will be validated the same way as xxAccountNumber above.