Creates a order embedded payment

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
Request
path Parameters
orderId
required
string

The unique identifier of the current in progress order base for which the payment is starting

header Parameters
Connect-Region-Code
string

Region Code

Request Body schema:
required

Values needed to start the embedded payment

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, or payment method does not exist.

404

Order does not exist.

post/ocapi/v1/orders/{orderId}/payments/embedded
Request samples
{}
Response samples
application/json
{
  • "embeddedPayment": {
    },
  • "clientData": {
    },
  • "updatedOrderExpiresAt": "2019-08-24T14:15:22Z"
}