GRgreendot
PaymentInstrument

Validate Card CVV

Validate Card CVV

post/programs/{programCode}/validateCard

Request

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

Path parameters

programCodestring required

The program code associated with the account.

Headers

X-GD-RequestIdstring required

A unique identifier for tracking the request, provided in the X-GD-RequestId header.

Request body

paymentInstrumentIdentifierstring nullable

The unique identifier for the payment instrument (e.g., card) to be validated.

last4Ssnstring nullable

The last four digits of the Social Security Number (SSN) for identity verification.

isExpirationDateOptionalboolean nullable

Indicates whether the expiration date is optional for this validation request.

includeClosedAccountAndCardboolean

Indicates whether to include closed accounts and cards in the validation process.

Response

OK

accountIdentifierstring nullable

Unique identifier for the account associated with the card being validated.

paymentInstrumentIdentifierstring nullable

Unique identifier for the payment instrument being validated.

activationStatusstring nullable

The activation status of the payment instrument.

isDOBMatchedboolean nullable

Indicates whether the date of birth (DOB) provided matches the record.

isDOBVerifiedboolean nullable

Indicates whether the date of birth (DOB) has been verified.

isProspectboolean nullable

Indicates whether the user is considered a prospect (not yet a full customer).

prospectTypestring nullable

The type of prospect, if the user is a prospect.

prospectIdentifierstring nullable

Unique identifier for the prospect, if applicable.

prospectStatusinteger nullable

The status code of the prospect, if applicable.

retailCardIdentifierstring nullable

Unique identifier for the retail card, if applicable.

isRetailCardboolean nullable

Indicates whether the card is a retail card.

retailCardStatusinteger nullable

The status code of the retail card, if applicable.

productCodestring nullable

The product code associated with the card.

isExpiredboolean nullable

Indicates whether the card is expired.

isInvalidCvvboolean nullable

Indicates whether the provided CVV is invalid.

isDirectSignUpboolean nullable

Indicates whether the cardholder is eligible for direct sign-up.

Changes

No recorded changes to this operation across all 2 revisions of this API.