VIvista
Payments

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

Changed on

Licenses Required

  • Vista.Ocapi
post/ocapi/v1/members/current/payment-cards/embedded

Request

Headers

loyaltySessionTokenstring

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

Connect-Region-Codestring

Region Code

Request body

webPaymentMethodIdinteger required

Gets the unique identifier of the web payment method

redirectReturnUrlstring uri nullable

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

languageTagstring nullable

Gets the IETF (RFC 4646) language tag

Response

Success

memberPaymentCardIdstring required

Gets the unique identifier of the member payment card

webPaymentMethodIdinteger required

Gets the unique identifier of the web payment method

connectorFunctionNamestring required

Gets the name of the connector function that needs to be called

connectorParametersJsonstring required

Gets the JSON blob of parameters required by the connector

createCardTokenUrlstring uri required

Gets the create card token URL

sdkScriptUrlsstring[] required

Gets the list of SDK script URLs that need to be loaded

isButtonIncludedboolean required

Gets a value indicating whether the payment connector UI includes a submit button

isPrimaryCardOptionIncludedboolean required

Gets a value indicating whether the primary card option is included

connectorScriptUrlsstring[] required

Gets the list of connector script URLs that need to be loaded

Changes

  • 41415d239083Revision changes
    • info

      api operation id OcapiMemberPaymentCards_CreateEmbeddedMemberPaymentCard removed and replaced with OcapiMemberPaymentCards_CreateMemberEmbeddedPaymentCard