becsDirectDebit

Contains the information required to process an ECP/ACH transaction

Request

Property NameTypeRequiredDescription
bsbNumberstringRequired6-digit code that represents the bank, state, and branch location
accountNumberstringRequiredAccount number. 4–17 digits.
accountNamestringRequiredName on bank account.
financialInstitutionstringRequiredName of issuing bank.
branchNamestringRequiredBranch at which the shopper carries out their banking needs.
agreementIdintegerRequiredIdentifier assigned to a mandate that the shopper has signed.

Response

Property NameTypeDescription
bsbNumberstring6-digit code that represents the bank, state, and branch location
publicAccountNumberstringLast 5 digits of the account number.
Note: In API v3.0, this replaces accountNumber.
accountNamestringName on bank account.
financialInstitutionstringName of issuing bank.
branchNamestringBranch at which the shopper carries out their banking needs.
agreementIdintegerIdentifier assigned to a mandate that the shopper has signed.
preNotificationRefstringThis includes the mandate email text and selected attributes related to the transaction that should be sent to the shopper.