Input fields

accountHolder : String

The name of the account holder. Required by nearly all vendors.
accountNumber : String

The domestic bank account number. Used together with branchCode for GBR, AUS, NZL and CAN bank details. Not needed when iban is provided.
accountType : String

The account type. For NZL this is the account suffix (sent together with bankCode). For USA it is CHQ (checking) or SAV (savings). Not used for IBAN, GBR, AUS or CAN details.
bankCode : String

The bank identifier. Used for NZL (together with accountType) and CAN bank details. Not used for IBAN, GBR or AUS details.
branchCode : String

The branch identifier: the sort code (GBR), BSB (AUS) or branch code (NZL/CAN). Used together with accountNumber. Not needed when iban is provided.
iban : String

The International Bank Account Number. Used by SEPA vendors. Not used by vendors that take local account details (GBR, AUS, NZL).
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "accountHolder": "hold-none-raise-executive-local", "accountNumber": "A-B46AAE08", "accountType": "relate-life-family-any-any", "bankCode": "too-those-civil-receive-total", "branchCode": "at-eight-blood-science-computer", "iban": "show-spring-cause-trade-have" }