Gets the current order embedded payment for the order

The payment considered current is the most recently created order embedded payment for the order.

This endpoint may be polled to determine the status of the payment after embedded payment process has completed on client. This is required currently due to limitations in the current Web Payment Module payment process around returning payment status as part of the UI interaction requiring the client to make this extra call before leaving the payment UI.

Licenses Required

  • Vista.Ocapi
  • Vista.Ocapi.EmbeddedPayment
Request
path Parameters
orderId
required
string

The unique identifier of the in progress order base

header Parameters
Connect-Region-Code
string

Region Code

Responses
200

Success

404

Order does not exist, or embedded payment has not been created.

get/ocapi/v1/orders/{orderId}/payments/embedded/current
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "type": "CinemaProcessed",
  • "value": 0.1,
  • "status": "NotStarted"
}