GRgreendot
PaymentInstrument

Complete Payment Instrument Registration

Create a New Payment Instrument This endpoint may be called after an enrollment is cured using the kycGates/IDV endpoint.

If the parameter "upgradeFlag" is true,it will be upgrade flow.It should insert new product terms, update the history data, send webhook and return upgrade success when upgrade success.

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

Request

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

Path parameters

programCodestring required

The program code associated with the account.

accountIdentifierstring required

Unique identifier (UID or GUID) for the account.

Headers

X-GD-RequestIdstring required

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

Request body

accountIdentifierstring nullable

Unique identifier for the account to which the payment instrument will be registered.

userIdentifierstring nullable

Unique identifier for the user associated with the payment instrument.

productMaterialTypestring nullable

The material type of the product to be issued (e.g., "plastic", "virtual").

requestPhysicalCardFlagboolean nullable

Indicates whether a physical card should be issued as part of the registration process.

upgradeFlagboolean nullable

Indicates whether the registration is an upgrade flow.

requestTempCardOnlyboolean

For retail card, when RequestTempCardOnly=true, then only order temp card

Response

OK

Changes

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