v1

latestOpenAPI 3.0.12026-07-243407211.3 MB

Account

Add Account Holder

This endpoint allows an account holder to be added to an existing account.Account must have the ability to be a joint account and not be a corp account.Account holder must first pass a validation check if validation check is successful, the account holder will be created and the request will returned the account holders linked to the account.

post/programs/{programCode}/accounts/{accountIdentifier}/AccountHolder

Path parameters

programCodestring required

Partner program code for the account.

accountIdentifierstring required

Unique account identifier (UID or GUID).

Headers

X-GD-RequestIdstring required

Unique request tracking identifier (X-GD-RequestId header).

Request body

productMaterialTypestring nullable

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

requestPhysicalCardboolean

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

currencystring nullable

The currency code (e.g., "USD") for the account holder's account.

Response

accountIdentifierstring nullable

The unique identifier of the account to which the holder(s) were added.

statusstring nullable

The status of the add account holder operation (e.g., "Success", "Failed").

accountStatusReasonsstring[] nullable

The list of reasons describing the current status of the account, if applicable.