---
title: "Creates a order embedded payment"
method: POST
path: "/ocapi/v1/orders/{orderId}/payments/embedded"
tags: ["Payments"]
---

# Creates a order embedded payment

`POST /ocapi/v1/orders/{orderId}/payments/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}/payments/embedded`
- Auth: none declared

Initiates an order embedded payment with the connector so that the client can render a UI based on the returned order embedded payment client data
#### Licenses Required


- Vista.Ocapi
- Vista.Ocapi.EmbeddedPayment

## Path parameters

- `orderId` string, required

## Headers

- `Connect-Region-Code` string

## Request body

- OcapiV1OrdersPaymentsEmbeddedOrderEmbeddedPaymentCreate: Represents the values required to create an order embedded payment
  - `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

- OcapiV1OrdersPaymentsEmbeddedCreatedOrderEmbeddedPayment: Represents an order embedded payment that has just been created, and the order embedded payment client data required to initialise the UI
  - `embeddedPayment` OcapiV1OrdersPaymentsEmbeddedOrderEmbeddedPayment, required: Gets the order embedded payment entity
    - `id` string, required: Gets the identifier that can be used to uniquely identify the payment within the order base
    - `type` 'CinemaProcessed' | 'Embedded' | 'GiftCard' | 'Redirect' | 'MemberBalance' | 'ExternallyProcessed' | 'PaymentCard', required: Gets the type
    - `value` number, double, required: Gets the monetary value
    - `status` 'NotStarted' | 'Pending' | 'Declined' | 'Completed', required: Gets the status
  - `clientData` OcapiV1OrdersPaymentsCinemaProcessedOrderEmbeddedPaymentClientData, required: Gets the order embedded payment client data entity
    - `connectorParametersJson` string, required: Gets the JSON blob of parameters required by the connector
    - `completePaymentUrl` string, uri, required: Gets the URL that needs to be called after the payment has been accepted
    - `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
    - `isPaymentButtonIncluded` boolean, required: Gets a value indicating whether or not the payment connector UI includes a payment button
  - `updatedOrderExpiresAt` string, date-time, required: Gets the updated date and time that the in progress order base expires

## Other responses

- `400`: Request property is invalid or missing, or payment method does not exist.
- `404`: Order does not exist.

## Changes

- **2026-10-09** `41415d239083`: 1 warning
  - added the new `PaymentCard` enum value to the `embeddedPayment/allOf[subschema #1: OrderEmbeddedPayment]/type/allOf[subschema #1: OrderPaymentType]/` response property for the response status `200`

[Operation history](https://skmtc.dev/vista/apis/vista-digital-platform/changes/ocapi/v1/orders/:orderId/payments/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)
