becsDirectDebit

Contains the information required to process an ECP/ACH transaction

Request

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

Response

Property Name

Type

Description

accountName

string

Name on bank account.

agreementId

integer

Identifier assigned to a mandate that the shopper has signed.

branchName

string

Branch at which the shopper carries out their banking needs.

bsbNumber

string

6-digit code that represents the bank, state, and branch location

financialInstitution

string

Name of issuing bank.

preNotificationRef

string

This includes the mandate email text and selected attributes related to the transaction that should be sent to the shopper.

publicAccountNumber

string

Last 4 digits of the account number.

  • *Note:** In API v3.0, this replaces accountNumber.