Sign in

v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Confirm Payment

post/sites/multiscreen/{site_name}/ecommerce/payment-sessions/{session_id}/confirm

Path parameters

site_namestring required

The unique identifier for the target Site.

session_idstring required

The unique identifier for the payment

Request body

iconstring

Optionally define if state is PROCESSED. Image url to display in the checkout confirmation screen

instructionsstring

Optionally define if state is PROCESSED. Information text diplayed in the checkout confirmation screen

state'PROCESSED' | 'PENDING' | 'FAILED' required
transaction_idstring

Required only if state is PROCESSED . Unique identifier from your payment gateway to assign to the order

Response

200

return_urlstring

Example response

{
  "return_url": "string"
}