GRgreendot
Enrollments

Adds Linked Account Enrollment

Changed on

Enrolls a linked user into a product, creates the account and card, and links the account with a parent account.

post/programs/{programCode}/enrollments/linkedaccount

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The Program code for the enrollment flow.

Headers

X-GD-RequestIdstring required

The Unique request identifier for tracking and logging.

X-GD-Sourcestring

The Source system or channel identifier.

X-Gd-Bos-IgnoreMFAstring

The Flag to ignore multi-factor authentication.

Request body

accountIdentifierstring nullable

The unique identifier (UID or GUID) of the account to which a new account will be linked.

linkedProductCodestring nullable

The product code for the linked account (e.g., card program, account type).

productMaterialTypestring nullable

The material type for the linked product (e.g., "plastic", "virtual").

requestPhysicalCardboolean

Indicates whether a physical card should be requested for the linked account. Defaults to true.

currencystring nullable

The currency code (e.g., "USD") for the linked account.

Response

Created

accountIdentifierstring nullable

The unique identifier (UID or GUID) for the linked account.

statusstring nullable

The current status of the linked account (e.g., "Active", "Pending", "Closed").

Changes