GRgreendot
Enrollments

Add Samples Enrollment (Encrypted)

Changed on

Enrolls a user for DM/WB activation using encrypted request data. Requires request ID, source, enrollment request identifier, program code, and encrypted enrollment payload.

post/programs/{programCode}/enrollments/samples

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-EnrollmentRequestIdentifierstring

The Unique identifier for the enrollment request.

Request body

prospectIdentifierstring nullable

The unique identifier for the prospect being enrolled.

upgradeToEMVboolean nullable

Indicates whether the account should be upgraded to EMV (chip card) during enrollment.

contactVerificationIdentifierstring nullable

The identifier (such as email or phone) used to verify the contact information for the enrollment.

Response

OK

accountIdentifierstring nullable

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

accountReferenceNumberstring nullable

The reference number associated with the account, used for partner or customer reference.

statusstring nullable

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

accountStatusChangedDateTimestring nullable

The date and time when the account status was last changed.

statusReasonsstring[] nullable

A list of reasons describing the current status of the account.

statusCurestring nullable

The cure or remediation action associated with the current account status, if applicable.

accountCycleDayinteger nullable

The account cycle day, typically used for billing or statement cycles.

paymentInstrumentIdentifierstring nullable

The identifier for the primary payment instrument associated with the account.

activationStatusstring nullable

The activation status of the account.

Changes