Sign in
Account Programs

List account programs

List account programs

get/account_programs

Query parameters

enabledboolean
is_cash_debit_enabledboolean
is_synctera_pay_enabledboolean
not_contains_all_spend_control_idsstring[]
is_cash_credit_enabledboolean
is_fednow_debit_enabledboolean
max_accountsinteger[]
not_contains_all_reward_product_idsstring[]
spend_control_idsstring[]
contains_all_spend_control_idsstring[]
is_external_card_debit_enabledboolean
not_contains_all_fee_product_idsstring[]
fee_product_ids_is_nullboolean

Filters by whether fee_product_ids is null. true matches null values, false matches non-null values.

is_eft_ca_debit_enabledboolean
is_synctera_pay_debit_enabledboolean
namestring[]
from_max_accountsinteger
account_typestring[]
is_synctera_pay_credit_enabledboolean
is_fednow_credit_enabledboolean
from_creation_timestring date-time
is_eft_ca_enabledboolean
name_likestring

Case insensitive wildcard search for name, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

is_check_enabledboolean
is_card_enabledboolean
is_ach_enabledboolean
fee_product_idsstring[]
is_wire_enabledboolean
is_ach_credit_enabledboolean
from_last_updated_timestring date-time
to_max_accountsinteger
is_external_card_enabledboolean
is_card_debit_enabledboolean
max_accounts_is_nullboolean

Filters by whether max_accounts is null. true matches null values, false matches non-null values.

is_check_debit_enabledboolean
to_last_updated_timestring date-time
ignore_kycboolean
tenantTenantId[] 
[
  "abcdef_ghijkl"
]
is_fednow_enabledboolean
not_contains_any_spend_control_idsstring[]
page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d
is_ach_debit_enabledboolean
is_external_card_credit_enabledboolean
not_contains_any_reward_product_idsstring[]
is_wire_debit_enabledboolean
is_wire_credit_enabledboolean
reward_product_idsstring[]
reward_product_ids_is_nullboolean

Filters by whether reward_product_ids is null. true matches null values, false matches non-null values.

is_eft_ca_credit_enabledboolean
is_cash_enabledboolean
contains_all_reward_product_idsstring[]
sort_bystring[]
limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100
contains_all_fee_product_idsstring[]
account_type_likestring

Case insensitive wildcard search for account_type, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

to_creation_timestring date-time
is_card_credit_enabledboolean
idstring[]
is_check_credit_enabledboolean
not_contains_any_fee_product_idsstring[]

Response

List of account programs

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "account_programs": [
    {
      "creation_time": "2010-05-06T12:23:34.321Z",
      "enabled": true,
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "name": "Standard Checking Program",
      "tenant": "abcdef_ghijkl"
    }
  ],
  "next_page_token": "a8937a0d"
}

Changes