Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Account Programs

Get account program

Get account program by ID.

get/account_programs/{program_id}

Path parameters

program_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

The unique identifier for the account program.

Response

Account program representation.

account_type'CHARGE_SECURED' | 'CHARGE_UNSECURED' | 'CHECKING' | 'CREDIT_CARD' | 'GENERAL_LEDGER' | 'LINE_OF_CREDIT' | 'PREPAID' | 'REVOLVING_CREDIT_SECURED' | 'REVOLVING_CREDIT_UNSECURED' | 'SAVING' required

The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed. Below mentioned are the account types:

  • SAVING: Savings account
  • CHECKING: Checking account
  • PREPAID: Prepaid account
  • LINE_OF_CREDIT: Line of Credit account
  • CREDIT_CARD: Credit Card account
  • CHARGE_SECURED: Secured Charge account, e.g. for use in a Smart Charge Card offering
  • CHARGE_UNSECURED: (alpha) Unsecured Charge account
  • REVOLVING_CREDIT_SECURED: Secured Revolving Credit account
  • REVOLVING_CREDIT_UNSECURED: Unsecured Revolving Credit account
  • GENERAL_LEDGER: General Ledger account (alpha - cannot yet be created). In production, these can only be created or updated by a Synctera administrator.
billing_category'DEMAND_DEPOSIT' | 'PREPAID_NON_RELOADABLE' | 'PREPAID_RELOADABLE' | 'REVOLVING_UNSECURED_CREDIT' | 'SECURED_CREDIT' | 'UNSECURED_LINE_OF_CREDIT' required
creation_timestring date-time required

The date and time the resource was created.

enabledboolean required

Whether the account program is enabled.

fee_product_idsstring[] nullable

List of fee product IDs associated with this account program.

idstring uuid required

The unique identifier for the account program.

ignore_kycboolean required

Whether to ignore KYC verification for this program.

is_ach_credit_enabledboolean required

Whether ACH credits are enabled for this program. Both is_ach_enabled and is_ach_credit_enabled must be true for an ACH credit to be allowed.

is_ach_debit_enabledboolean required

Whether ACH debits are enabled for this program. Both is_ach_enabled and is_ach_debit_enabled must be true for an ACH debit to be allowed.

is_ach_enabledboolean required

Whether ACH transactions are enabled for this program.

is_card_credit_enabledboolean required

Whether card credits are enabled for this program. Both is_card_enabled and is_card_credit_enabled must be true for a card credit to be allowed.

is_card_debit_enabledboolean required

Whether card debits are enabled for this program. Both is_card_enabled and is_card_debit_enabled must be true for a card debit to be allowed.

is_card_enabledboolean required

Whether card transactions are enabled for this program.

is_cash_credit_enabledboolean required

Whether cash credits are enabled for this program. Both is_cash_enabled and is_cash_credit_enabled must be true for a cash credit to be allowed.

is_cash_debit_enabledboolean required

Whether cash debits are enabled for this program. Both is_cash_enabled and is_cash_debit_enabled must be true for a cash debit to be allowed.

is_cash_enabledboolean required

Whether cash transactions are enabled for this program.

is_check_credit_enabledboolean required

Whether check credits are enabled for this program. Both is_check_enabled and is_check_credit_enabled must be true for a check credit to be allowed.

is_check_debit_enabledboolean required

Whether check debits are enabled for this program. Both is_check_enabled and is_check_debit_enabled must be true for a check debit to be allowed.

is_check_enabledboolean required

Whether check transactions are enabled for this program.

is_eft_ca_credit_enabledboolean required

Whether EFT Canada credits are enabled for this program. Both is_eft_ca_enabled and is_eft_ca_credit_enabled must be true for an EFT Canada credit to be allowed.

is_eft_ca_debit_enabledboolean required

Whether EFT Canada debits are enabled for this program. Both is_eft_ca_enabled and is_eft_ca_debit_enabled must be true for an EFT Canada debit to be allowed.

is_eft_ca_enabledboolean required

Whether EFT Canada transactions are enabled for this program.

is_external_card_credit_enabledboolean required

Whether external card credits are enabled for this program. Both is_external_card_enabled and is_external_card_credit_enabled must be true for an external card credit to be allowed.

is_external_card_debit_enabledboolean required

Whether external card debits are enabled for this program. Both is_external_card_enabled and is_external_card_debit_enabled must be true for an external card debit to be allowed.

is_external_card_enabledboolean required

Whether external card transactions are enabled for this program.

is_fednow_credit_enabledboolean required

Whether FedNow credits are enabled for this program. Both is_fednow_enabled and is_fednow_credit_enabled must be true for a FedNow credit to be allowed.

is_fednow_debit_enabledboolean required

Whether FedNow debits are enabled for this program. Both is_fednow_enabled and is_fednow_debit_enabled must be true for a FedNow debit to be allowed.

is_fednow_enabledboolean required

Whether FedNow transactions are enabled for this program.

is_p2p_enabledboolean required

Whether peer-to-peer transactions are enabled for this program.

is_synctera_pay_credit_enabledboolean required

Whether Synctera Pay credits are enabled for this program. Both is_synctera_pay_enabled and is_synctera_pay_credit_enabled must be true for a Synctera Pay credit to be allowed.

is_synctera_pay_debit_enabledboolean required

Whether Synctera Pay debits are enabled for this program. Both is_synctera_pay_enabled and is_synctera_pay_debit_enabled must be true for a Synctera Pay debit to be allowed.

is_synctera_pay_enabledboolean required

Whether Synctera Pay is enabled for this program.

is_wire_credit_enabledboolean required

Whether wire credits are enabled for this program. Both is_wire_enabled and is_wire_credit_enabled must be true for a wire credit to be allowed.

is_wire_debit_enabledboolean required

Whether wire debits are enabled for this program. Both is_wire_enabled and is_wire_debit_enabled must be true for a wire debit to be allowed.

is_wire_enabledboolean required

Whether wire transactions are enabled for this program.

last_updated_timestring date-time required

The date and time the resource was last updated.

namestring required

The name of the account program.

number_of_related_accountsinteger required

A count of how many accounts are using this program

reward_product_idsstring[] nullable

List of reward product IDs associated with this account program.

spend_control_idsstring[] required

List of spend control IDs that will apply to all accounts using this account program.

tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example response

{
  "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"
}