Enroll Card

Link an additional Visa card PAN to an already-enrolled user. Each user can have multiple cards linked to their offer account.

When to Use

▾

Use this endpoint when:

• A user wants to add a second or subsequent card to the program
• Linking a replacement card after losing one

How to Use

▾

Endpoint

POST/v3/vop/enroll-card

Step 1: Get the User ID

▾

Use the RM-issued userId returned by Enroll User.

Step 2: Send the Card Details

▾

POST the user ID, card PAN, and card name to /v3/vop/enroll-card.

Step 3: Store the Card ID

▾

The response returns the new card.id. Use it for Unenroll Card.

---

Request Parameters

▾

userIdSTRINGrequired

RM-issued user ID returned by [Enroll User](./enroll-user).

Example: "1699331101742889953"

cardPanSTRINGrequired

Visa card PAN (full card number).

Example: "4364484100392451"

nameSTRINGrequired

Display name of the card.

Example: "Ambank Visa Infinite"

---

Response Parameters

▾

itemOBJECT

Created card record.

idSTRING

RM-issued card ID.

Example: "1699331146943520156"

userIdSTRING

RM-issued user ID.

Example: "1699331101742889953"

nameSTRING

Card display name.

Example: "Ambank Visa Infinite"

panLastFourSTRING

Last four digits of the card PAN.

Example: "2451"

typeSTRING

Card type (`"CREDIT"`, `"DEBIT"`).

Example: "CREDIT"

createdAtDATETIME

Enrollment timestamp.

Example: "2023-11-07T04:25:46Z"

updatedAtDATETIME

Last update timestamp.

Example: "2023-11-07T04:25:46Z"

codeSTRING

`"SUCCESS"` if enrollment succeeded. Otherwise returns an error code. See [Error Codes](../error-codes).

Example: "SUCCESS"