Create subaccount

Creates a new subaccount, allowing you to set network and regional configurations.

Each network's countries can be set to either an array of specific ISO 3166 alpha-3 country codes, or the string "*" to inherit all countries from the parent account's capabilities for that network.

When using "*", the subaccount will automatically reflect the parent account's current country list. If the parent account's capabilities change, subaccounts configured with "*" will inherit the updated countries.

The single and bulk enrollment configurations are not required when creating a subaccount, but if not provided they will default to the same country list as the main countries property for that network. The supported card types for single and bulk enrollment is CONSUMER, while the supported funding card types is DEBIT. If not provided, the block rules for both card types will default to the parent account's default block rule for that network and enrollment level.

To set the default rule on the parent account, please reach out to your account manager or support.

Body Params
string
required

The name of the subaccount

configurations
object
required

Subaccount network and regional configurations which determine the available networks and geographies during card enrollment.

The countries property for each network accepts either:

  • An array of ISO 3166 alpha-3 country codes (e.g. ["USA", "CAN"])
  • The string "*" to inherit all countries from the parent account's capabilities for that network

When "*" is used, the subaccount automatically reflects the parent account's current country list. If the parent account's capabilities change, subaccounts using "*" will inherit the updated countries. API responses always return the resolved country list, never the "*" literal.

The single and bulk enrollment configurations are not required when creating a subaccount, but if not provided they will default to the same country list as the main countries property for that network. The supported card types for single and bulk enrollment is CONSUMER, while the supported funding card types is DEBIT. If not provided, the block rules for both card types will default to the parent account's default block rule for that network and enrollment level.

To set the default rule on the parent account, please reach out to your account manager or support.

Headers
string
enum
Defaults to application/hal+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/problem+json