Loads and initiates the creation or selection of a member payment card using an embedded UI for the current or future recurring member subscription of the currently authenticated member

The member payment card will be used for recurring subscription billing.

If the member has a future recurring member subscription, the member payment card will be authenticated for their future subscription.

Licenses Required

  • Vista.Ocapi
  • Vista.Subscriptions
Request
header Parameters
loyaltySessionToken
string

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Code
string

Region Code

Request Body schema:
required

The values needed to create an embedded member payment card

webPaymentMethodId
required
integer <int32>

Gets the unique identifier of the web payment method

redirectReturnUrl
string or null <uri>

Gets the URL that the browser will be directed to after the embedded payment has finished, if the requested web payment method requires redirect

languageTag
string or null

Gets the IETF (RFC 4646) language tag

Responses
200

Success

400

Member does not have a current or future recurring subscription.

401

No member authenticated.

post/ocapi/v1/members/current/subscriptions/recurring/payment-card/embedded
Request samples
{}
Response samples
application/json
{
  • "memberPaymentCardId": "string",
  • "webPaymentMethodId": 0,
  • "connectorFunctionName": "string",
  • "connectorParametersJson": "string",
  • "createCardTokenUrl": "http://example.com",
  • "sdkScriptUrls": [
    ],
  • "isButtonIncluded": true,
  • "isPrimaryCardOptionIncluded": true,
  • "connectorScriptUrls": [
    ]
}