Documentation

BankPay

  1. Home
  2. Docs
  3. BankPay
  4. API
  5. Bank Accounts

Bank Accounts

Bank Account object

{
    "id": "bank_account_Aa1ABb2BCc3CDd4DEe5EFf6FGg7GHhH",
    "account_number": "*****0101",
    "account_type": "personal_checking",
    "credentialing_indicator": "manual",
    "routing_number": "021000018"
}
  • id string

Permanent unique identifier of the bank account.

  • account_number string

Bank account’s account number.

  • account_type string

The type of account. One of “business_checking”, “personal_checking”, or “personal_savings”.

  • credentialing_indicator string

Indicates how account was provided. One of either “manual” or “online”.

  • routing_number string

Bank account’s routing number.

Bank Account field restrictions

FieldRestrictionsMin SizeMax Size
account_numberDigits217

Read Bank Account

Success

Request

GET /api/consumers/{consumer_id}/bank-accounts/{bank_account_id}
Authorization: Bearer {SECRET_KEY}

Example curl request

curl https://bankpay.certegy.com/api/consumers/consumer_boFSdB9vmNhiQrD2tgZJ7cHJO39bjEYz/bank-accounts/bank_account_jilefFE9sQWqXADBCpd7IBAY4SeVPGhU \
-H 'Accept: application/json' \
-H 'Authorization: Bearer secret_UdhNaYbxs2I61F41Lem2DMyGqWcQQ67V'

Response

HTTP/1.1 200 OK

The data property is a Bank Account object.

{
    "data": {
        "account_number": "*****4321",
        "account_type": "personal_checking",
        "id": "bank_account_Aa1ABb2BCc3CDd4DEe5EFf6FGg7GHh8H",
        "routing_number": "123456789"
    },
    "meta": {
        "type": "bank_account"
    }
}

Example Errors

Consumer or Bank Account not found

Request

GET /api/consumers/{consumer_id}/bank-accounts/{bank_account_id}
Authorization: Bearer {SECRET_KEY}

Response

HTTP/1.1 404 Not Found
{
    "message": "not_found"
}

Back to Top

How can we help?