Sign in

v1

latestOpenAPI 3.0.02026-07-14106203730.9 KB
Bank Accounts

Create Bank Account

Create a bank account. A US bank account is created by setting bankCountryCode to US and providing accountNumber and routingNumber. A canadian bank account can be created by specifying bankCountryCode as CA and setting accountNumber, routeNumber, and transitNumber accordingly.

You must specify either signatureImage or signatureText. The image can be supplied as either a URL or a multipart file upload.

post/print-mail/v1/bank_accounts

Request body

OR
OR

Response

The request has succeeded and a new resource has been created as a result.

object'bank_account' required

Always bank_account.

bankNamestring required

The name of the bank.

bankPrimaryLinestring

The primary address line of the bank.

bankSecondaryLinestring

The secondary address line of the bank.

bankCountryCode'CA' | 'US' required

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

accountNumberstring required

The account number of the bank account.

routingNumberstring

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

transitNumberstring

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

routeNumberstring

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

caDesignationNumberstring

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

idstring required

A unique ID prefixed with bank_account_

descriptionstring

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

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.

signatureTextstring

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

signatureImagestring uri

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