Skip to main content
Vindicia Knowledge Center

DirectDebit Subobject

DirectDebit Subobject

DirectDebit Subobject

Lists details for a Direct Debit account.

Table 11-6: DirectDebit Object Data Members

Data Member

Data Type

Description

account

string

The number of the customer’s bank account from which to deduct payment. To use the associated PaymentMethod object for one-time or recurring transactions, you must specify the full account number. CashBox partially masks the account number (for example, 444444XXXXXX1111) when returning this object to you in response to an API call.

For security, if this object is associated with a Transaction object that is only reported to Vindicia (for example, if you are a ChargeGuard customer and report your transactions to Vindicia), you might choose to omit this value or mask it partially, such as by specifying an encrypted value of the account number in the accountHash field.

accountHash

string

A hash of the full account number, usually obtained through the Secure Hash Algorithm (SHA1). For numeric accounts, delete the nonnumeric characters before hashing. For calibration, the test number 1111111111111111 generates an SHA1 hash of 747417f2206148a3118d0f3adf20b5e4139baac.

Specify this string only if you are not specifying the full account number for security reasons when reporting transactions to Vindicia for ChargeGuard.

You need not specify this field when using the associated payment method in a Transaction processed through CashBox.

accountLength

int

The number of digits in the full account number.

Specify this attribute only if you are not specifying the full account number but are specifying the accountHash field only for security reasons when reporting transactions to Vindicia for ChargeGuard.

You need not specify this field for the associated payment method for a Transaction processed through CashBox.

bankSortCode

string

The European bank sort code that identifies the bank that houses the customer’s bank account whose number is specified in the account field. This code is similar to the bank routing number in the United States.

You must specify this field for the associated payment method for a Transaction processed through CashBox. However, you may leave this field blank for bank accounts in the Netherlands or Belgium, if the countryCode attribute is set to NL or BE.

countryCode

string

The ISO-3166-1 two-letter code for the country in which the related bank account is located. This code must match the country code specified in the PaymentMethod object’s billing address. Valid values are AT (Austria), DE (Germany), and NL (the Netherlands).

You must specify this field for the associated payment method for a Transaction processed through CashBox.

hashType

HashType

The type of hashing algorithm used if you specify a value for the accountHash field. The allowed values are sha1 and md5. Currently, only SHA1 hashing is supported on the server side.

You need not specify this field for the associated payment method for a Transaction processed through CashBox.

lastDigits

string

(This data member is not in use.)

ribCode

string

(This data member is not in use.)

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top