API Reference

Complete Payment Instrument Registration

post
https://example.com/programs//accounts//paymentInstruments

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.

Path Params
string
required

The program code associated with the account.

string
required

Unique identifier (UID or GUID) for the account.

Body Params

The request object containing registration details.

string | null

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

string | null

Unique identifier for the user associated with the payment instrument.

string | null

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

boolean | null

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

boolean | null

Indicates whether the registration is an upgrade flow.

boolean

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

Headers
string
required

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago