Bank Accounts

Manage bank accounts that will be used for mailing cheques.

Create Bank Account

client.printMail.bankAccounts.create(, ?): BankAccount { id, accountNumber, bankCountryCode, 15 more }

POST/print-mail/v1/bank_accounts

List Bank Accounts

client.printMail.bankAccounts.list(?, ?): SkipLimit<BankAccount { id, accountNumber, bankCountryCode, 15 more } >

GET/print-mail/v1/bank_accounts

Get Bank Account

client.printMail.bankAccounts.retrieve(, ?): BankAccount { id, accountNumber, bankCountryCode, 15 more }

GET/print-mail/v1/bank_accounts/{id}

Delete Bank Account

client.printMail.bankAccounts.delete(, ?): BankAccountDeleteResponse { id, deleted, object }

DELETE/print-mail/v1/bank_accounts/{id}

ModelsExpand Collapse

BankAccount { id, accountNumber, bankCountryCode, 15 more }

id: string

A unique ID prefixed with bank_account_

accountNumber: string

The account number of the bank account.

bankCountryCode: BankAccountCountryCode

Countries typically have different bank account formats and standards. These are the countries which PostGrid’s bank accounts API supports.

One of the following:

"CA"

"US"

bankName: string

The name of the bank.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "bank_account"

Always bank_account.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

bankPrimaryLine?: string

The primary address line of the bank.

bankSecondaryLine?: string

The secondary address line of the bank.

caDesignationNumber?: string

The designation number of the bank account (for CA).

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

metadata?: Record<string, unknown>

See the section on Metadata.

routeNumber?: string

The route number of the bank account (for CA).

routingNumber?: string

The routing number of the bank account (for US).

signatureImage?: string

A signed link to the signature image uploaded when this bank account was created. This is omitted if signatureText is present.

formaturi

signatureText?: string

The signature text PostGrid uses to generate a signature for cheques created using this bank account. This is omitted if signatureImage is present.

transitNumber?: string

The transit number of the bank account (for CA).

BankAccountCountryCode = "CA" | "US"