Member payment cards

Loyalty members can save payment cards (credit or debit cards) to their payment card wallet for future one-off payments.

Get member payment cards

Use the GetMemberPaymentCards to get the list of the available payment cards for the authenticated member.

Copy
Copied
{
  "cards": [
    {
      "id": "string",
      "cardDetails": {
        "maskedCardNumber": "string",
        "type": "string",
        "expiryMonth": 0,
        "expiryYear": 0
      },
      "isUsedForRecurringSubscriptionBilling": false
    }
  ]
}

Subscription payment card

A member with a recurring subscription will have a recurring subscription payment card, indicated by the isUsedForRecurringSubscriptionBilling property. For example:

Copy
Copied
{
  "cards": [
    {
      "id": "string",
      "cardDetails": {
        "maskedCardNumber": "string",
        "type": "string",
        "expiryMonth": 0,
        "expiryYear": 0
      },
      "isUsedForRecurringSubscriptionBilling": true
    }
  ]
}

To change a recurring subscription payment card, follow the update subscription payment card flow.

NOTE

Members using a third-party payment provider will not have a subscription payment card. Switch to Vista recurring billing to add a subscription payment card.

Get member payment card

Use the GetMemberPaymentCard to get a particular payment card belonging to the authenticated member by its unique identifier.

Remove member payment card

Use the RemoveMemberPaymentCard endpoint to remove a particular payment card from the authenticated member's payment card wallet.

IMPORTANT

A subscription payment card cannot be directly removed. Update the subscription payment card to assign a new card for recurring subscription billing, then remove the original card.

Add member payment card

Adding a member payment card is a multi-step process that involves rendering of a payment user interface (UI) from within the client application. This process is initiated by the CreateEmbeddedMemberPaymentCard endpoint.

NOTE

For access to embedded payment card UI reference code, talk to your local Vista representative.