Bank Accounts

Bank Account object

{
    "id": "bank_account_Aa1ABb2BCc3CDd4DEe5EFf6FGg7GHhH",
    "account_number": "*****0101",
    "account_type": "personal_checking",
    "bank_name": "Dag Site",
    "credentialing_indicator": "manual",
    "routing_number": "021000018"
}

data	data type	description
`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`.
`bank_name`	string	Bank account's provider name.
`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

Field	Restrictions	Min Size	Max Size
`account_number`	Digits	2	17
`routing_number`	Digits	9	9

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": {
        "id": "bank_account_Aa1ABb2BCc3CDd4DEe5EFf6FGg7GHh8H",
        "account_number": "*****4321",
        "account_type": "personal_checking",
        "bank_name": "Dag Site",
        "credentialing_indicator": "manual",
        "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"
}

List Bank Accounts

Success

Request

GET /api/consumers/{consumer_id}/bank-accounts?type=bnpl
Authorization: Bearer {SECRET_KEY}

Params

data	data type	description
`type` (optional)	string	The type of product. One of either `bnpl` (Buy now pay later) or `bankpay` (BankPay).

Example curl request

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

Response

HTTP/1.1 200 OK

The data property is a Bank Account object.

{
    "data": [
        {
            "id": "bank_account_Aa1ABb2BCc3CDd4DEe5EFf6FGg7GHh8H",
            "account_number": "*****4321",
            "account_type": "personal_checking",
            "bank_name": "Dag Site",
            "credentialing_indicator": "online",
            "routing_number": "123456789"
        },
        {

            "id": "bank_account_Aa1ABb2BCc3CDd4DEe5EFf6FGg7GHh9H",
            "account_number": "*****4522",
            "account_type": "personal_checking",
            "bank_name": "Dag Site",
            "credentialing_indicator": "manual",
            "routing_number": "123456789"
        },
    ],
    "meta": {
        "type": "bank_account"
    }
}

Empty Response (Consumer’s bank account needs to be enrolled via allowed path)

HTTP/1.1 200 OK

{
    "data": [],
    "meta": {
        "type": "bank_account"
    }
}

Example Errors

Consumer ID not found

Request

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

Response

HTTP/1.1 404 Not Found

{
    "message": "not_found"
}