GRgreendot
Enrollments

Recovers Retail Card (Encrypted)

Changed on

Recovers a retail card for a customer. The request payload is encrypted.

post/programs/{programCode}/enrollments/retailcard/recover

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.

Request body

accountIdentifierstring required

The unique identifier (UID or GUID) for the account associated with the retail card enrollment recovery.

fraudDataobject nullable

Optional. Additional fraud-related data as key-value pairs for further analysis or processing.

requestTempCardOnlyboolean

Indicates whether the recovery request is for a temporary card only.

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.

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