POpostgrid
Bank Accounts

Get Bank Account

Retrieve a bank account by ID.

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

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/bank_accounts/{id}
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

The ID of the bank account to retrieve.

Response

the BankAccount.

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.

Changes

No recorded changes to this operation across all 1 revision of this API.