---
title: "Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order"
method: POST
path: "/ocapi/v1/orders/{orderId}/payment-card/embedded"
tags: ["Orders", "Tabs", "Payments"]
---

# 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)
- URL: `https://developer.vista.co/ocapi/v1/orders/{orderId}/payment-card/embedded`
- 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)

#### Licenses Required


- Vista.Ocapi

## Path parameters

- `orderId` string, required

## Headers

- `Connect-Region-Code` string

## Request body

- OcapiV1OrdersPaymentsPaymentCardOrderEmbeddedPaymentCardCreate: Represents the values needed to create an embedded order payment card
  - `webPaymentMethodId` integer, required: Gets the unique identifier of the web payment method
  - `redirectReturnUrl` string, 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
  - `languageTag` string, nullable: Gets the IETF (RFC 4646) language tag

## Response `200`

Success

- OcapiV1OrdersPaymentsPaymentCardOrderEmbeddedPaymentCardClientData: Represents the details required to initialise the embedded payment UI for creating an order payment card
  - `webPaymentMethodId` integer, required: Gets the unique identifier of the web payment method
  - `createCardTokenUrl` string, uri, required: Gets the create card token URL
  - `isButtonIncluded` boolean, required: Gets a value indicating whether the payment connector UI includes a submit button
  - `connectorParametersJson` string, required: Gets the JSON blob of parameters required by the connector
  - `sdkScriptUrls` string[], required: Gets the list of SDK script URLs that need to be loaded
  - `connectorScriptUrls` string[], required: Gets the list of connector script URLs that need to be loaded
  - `connectorFunctionName` string, required: Gets the name of the connector function that needs to be called

## Other responses

- `400`: Request property is invalid/missing or Customer Details have not been set.
- `404`: Order does not exist.

## Changes

- **2026-10-09** `41415d239083`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vista/apis/vista-digital-platform/changes/ocapi/v1/orders/:orderId/payment-card/embedded/post.md)

---

[API](https://skmtc.dev/vista/apis/vista-digital-platform.md) - [All operations](https://skmtc.dev/vista/apis/vista-digital-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/vista/apis/vista-digital-platform/revisions/c46f30854000?raw)