API Reference

Print Mail

Bank Accounts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Bank Account

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

Retrieve a bank account by ID.

Path ParametersExpand Collapse

id: string

ReturnsExpand Collapse

BankAccount = object { 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: optional string

The primary address line of the bank.

bankSecondaryLine: optional string

The secondary address line of the bank.

caDesignationNumber: optional string

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

description: optional string

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

metadata: optional map[unknown]

See the section on Metadata.

routeNumber: optional string

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

routingNumber: optional string

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

signatureImage: optional string

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

formaturi

signatureText: optional 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: optional string

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

Get Bank Account

HTTP

HTTP

TypeScript

Python

curl https://api.postgrid.com/print-mail/v1/bank_accounts/$ID \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY"

200 example

{
  "id": "bank_account_12345",
  "object": "bank_account",
  "live": false,
  "bankName": "Test Bank",
  "bankPrimaryLine": "145 mulberry st",
  "bankSecondaryLine": "new york ny 10013",
  "bankCountryCode": "US",
  "accountNumber": "1234567",
  "routingNumber": "123456789",
  "signatureText": "Signature",
  "createdAt": "2020-11-12T23:23:47.974Z",
  "updatedAt": "2020-11-12T23:23:47.974Z"
}

Returns Examples

200 example

{
  "id": "bank_account_12345",
  "object": "bank_account",
  "live": false,
  "bankName": "Test Bank",
  "bankPrimaryLine": "145 mulberry st",
  "bankSecondaryLine": "new york ny 10013",
  "bankCountryCode": "US",
  "accountNumber": "1234567",
  "routingNumber": "123456789",
  "signatureText": "Signature",
  "createdAt": "2020-11-12T23:23:47.974Z",
  "updatedAt": "2020-11-12T23:23:47.974Z"
}