Sign in

v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
Payments

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
post/ocapi/v1/orders/{orderId}/payments/embedded

Path parameters

orderIdstring required

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

Headers

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

updatedOrderExpiresAtstring date-time required

Gets the updated date and time that the in progress order base expires