Loads and initiates the creation of a member payment card using an embedded UI for the currently authenticated member

Licenses Required

  • Vista.Ocapi
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

Request property is invalid or missing.

401

No member authenticated.

post/ocapi/v1/members/current/payment-cards/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": [
    ]
}