Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order

post/ocapi/v1/orders/{orderId}/payment-card/embedded

Request

Base URL
https://developer.vista.co (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/vista/apis/vista-digital-platform/docs/ocapi/v1/orders/:orderId/payment-card/embedded/post.ts
A function with typed inputs. Its response is checked against the schema.

orderIdstring required

The unique identifier of the in progress tab order

Connect-Region-Codestring

Region Code

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

Success

webPaymentMethodIdinteger required

Gets the unique identifier of the web payment method

createCardTokenUrlstring uri required

Gets the create card token URL

isButtonIncludedboolean required

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

connectorParametersJsonstring required

Gets the JSON blob of parameters required by the connector

sdkScriptUrlsstring[] required

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

connectorScriptUrlsstring[] required

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

connectorFunctionNamestring required

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