Create account holder group

Action: POST
Endpoint: /accountholdergroups

Use this endpoint to create an account holder group.

Body fields detail

Name Type Required? Description Allowable Values
token string No The unique identifier of the account holder group.

If you do not include a token, the system will generate one automatically. This token is necessary for use in other calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated.
36 char max
name string No Descriptive name for the account holder group. 40 char max
config object No Contains configuration fields for the account holder group.

The config object

Name Type Required? Description Allowable Values
kyc_required string No Set to ALWAYS, new account holders are created in an UNVERIFIED status and must pass identity verification (KYC) before they can be active; set to CONDITIONAL, new account holders begin in a LIMITED status and have limited actions available before passing identity verification; set to NEVER, new account holders are created in an active state. ALWAYS | CONDITIONAL | NEVER

Default: NEVER
pre_kyc_controls object No Contains configuration fields for a number of controls. These controls are in effect only if kyc_required= CONDITIONAL and the account holder has not yet passed KYC.
is_reloadable boolean No Set to false, this control prohibits an account holder's account from being reloaded with funds after the initial load.

This restrictiction applies to GPA orders, MSA orders, offer orders, peer transfers, direct deposits, but does not apply to operator adjustments.
true | false

Default: true
real_time_fee_group_token string No Associates the specified real-time fee group with the members of the account holder group. Existing real_time_fee_group_token.

Issue a GET to /realtimefeegroups to retrieve real time fee group tokens.

The config.pre_kyc_controls object

Name Type Required? Description Allowable Values
cash_access_enabled boolean No Set to false, this control prohibits an account holder's cards from being used at an ATM.

Note: If a card product's config.poi.atm field is set to false, associated cards are prohibited from being used at an ATM regardless of this control's setting.
true | false

Default: false
international_enabled boolean No Set to false, this control prohibits an account holder from conducting transactions with a non-domestic country code.

Note: If a card product is configured to prohibit non-domestic transactions, its associated cards are prohibited from such transactions regardless of this control's setting.
true | false

Default: false
balance_max integer No Specifies the maximum ledger balance allowed for members of the account holder group. Any positive integer.

Default: 1000
is_reloadable_pre_kyc boolean No Set to false, this control prohibits an account holder's account from being reloaded with funds after an initial load.

This restrictiction applies to GPA orders, MSA orders, offer orders, peer transfers, direct deposits, but does not apply to operator adjustments.
true | false

Default: false
enable_non_program_loads boolean No Set to true, funds can only be loaded from a program funding source.

This restrictiction applies to GPA orders, MSA orders, offer orders, peer transfers, direct deposits, but does not apply to operator adjustments.
true | false

Default: false

Sample request

{
"token": "account_holder_group_01",
"name": "Account Holder Group 01"
}

Sample response

{
"token": "account_holder_group_01",
"name": "Account Holder Group 01",
"config": {
"kyc_required": ALWAYS,
"is_reloadable": true,
"pre_kyc_controls": {
"cash_access_enabled": false,
"international_enabled": false,
"balance_max": 1000,
"enable_non_program_loads": false,
"is_reloadable_pre_kyc": false
}
}
}


Retrieve account holder group

Action: GET
Endpoint: /accountholdergroups/{token}

Use this endpoint to retrieve a specific account holder group.

URL path parameters

Name Type Required? Description Allowable Values
token string Yes Identifies the account holder group you want to retrieve. Existing account holder group token.

Issue a GET to /accountholdergroups to retrieve account holder group tokens.

Sample response

{
"token": "account_holder_group_01",
"name": "Account Holder Group 01",
"config": {
"kyc_required": ALWAYS,
"is_reloadable": true,
"pre_kyc_controls": {
"cash_access_enabled": false,
"international_enabled": false,
"balance_max": 1000,
"enable_non_program_loads": false,
"is_reloadable_pre_kyc": false
}
}
}


Update account holder group

Action: PUT
Endpoint: /accountholdergroups/{token}

Use this endpoint to update a specific account holder group. Only values of parameters in the request are modified; all others are left unchanged.

To update a specific account holder group, issue a PUT request to the /accountholdergroups/{token} endpoint.
Use the token path parameter to specify the account holder group to update. Include the account holder group details to update in JSON format in the body of the request. Only values of parameters in the request are modified; all others are left unchanged.

Note: While you can update account holder groups that you create, the default group is restricted and requires special permissions to update.

URL path parameters

Name Type Required? Description Allowable Values
token string Yes Identifies the account holder group you want to retrieve. Existing account holder group token.

Issue a GET to /accountholdergroups to retrieve account holder group tokens.

Body fields detail

Name Type Required? Description Allowable Values
name string No Descriptive name for the account holder group. 40 char max
config object No Contains configuration fields for the account holder group.

The config object

Name Type Required? Description Allowable Values
kyc_required string No Set to ALWAYS, new account holders are created in an UNVERIFIED status and must pass identity verification (KYC) before they can be active; set to CONDITIONAL, new account holders begin in a LIMITED status and have limited actions available before passing identity verification; set to NEVER, new account holders are created in an active state. ALWAYS | CONDITIONAL | NEVER

Default: NEVER
pre_kyc_controls object No Contains configuration fields for a number of controls. These controls are in effect only if kyc_required= CONDITIONAL and the account holder has not yet passed KYC.
is_reloadable boolean No Set to false, this control prohibits an account holder's account from being reloaded with funds after the initial load.

This restrictiction applies to GPA orders, MSA orders, offer orders, peer transfers, direct deposits, but does not apply to operator adjustments.
true | false

Default: true
real_time_fee_group_token string No Associates the specified real-time fee group with the members of the acount holder group. Existing real_time_fee_group_token.

Issue a GET to /realtimefeegroups to retrieve real time fee group tokens.

The config.pre_kyc_controls object

Name Type Required? Description Allowable Values
cash_access_enabled boolean No Set to false, this control prohibits an account holder's cards from being used at an ATM.

Note: If a card product's config.poi.atm field is set to false, associated cards are prohibited from being used at an ATM regardless of this control's setting.
true | false

Default: false
international_enabled boolean No Set to false, this control prohibits an account holder from conducting transactions with a non-domestic country code.

Note: If a card product is configured to prohibit non-domestic transactions, its associated cards are prohibited from such transactions regardless of this control's setting.
true | false

Default: false
balance_max integer No Specifies the maximum ledger balance allowed for members of the account holder group. Any positive integer.
is_reloadable_pre_kyc boolean No Set to false, this control prohibits an account holder's account from being reloaded with funds after an initial load.

This restrictiction applies to GPA orders, MSA orders, offer orders, peer transfers, direct deposits, but does not apply to operator adjustments.
true | false

Default: false
enable_non_program_loads boolean No Set to true, funds can only be loaded from a program funding source.

This restrictiction applies to GPA orders, MSA orders, offer orders, peer transfers, direct deposits, but does not apply to operator adjustments.
true | false

Default: false

Sample request

{
"config": {
"pre_kyc_controls": {
"balance_max": 500
}
}
}

Sample response

{
"token": "account_holder_group_01",
"name": "Account Holder Group 01",
"config": {
"kyc_required": ALWAYS,
"is_reloadable": true,
"pre_kyc_controls": {
"cash_access_enabled": false,
"international_enabled": false,
"balance_max": 500,
"enable_non_program_loads": false,
"is_reloadable_pre_kyc": false
}
}
}


List account holder groups

Action: GET
Endpoint: /accountholdergroups

Use this endpoint to return an array of all account holder groups.

Sample response

{
"count": 1,
"start_index": 0,
"end_index": 0,
"is_more": false,
"data": [
{
"token": "account_holder_group_01",
"name": "Account Holder Group 01",
"config": {
"kyc_required": ALWAYS,
"is_reloadable": true,
"pre_kyc_controls": {
"cash_access_enabled": false,
"international_enabled": false,
"balance_max": 500,
"enable_non_program_loads": false,
"is_reloadable_pre_kyc": false
}
}
}
]
}