Confirm payment session

post

https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/payment-sessions/{id}/confirm

Reports the resulting state of the payment session with the given id, along with the gateway's transaction id, a display name and icon for the payment method used, confirmation instructions, refund links, and an error message for a failed state. Returns the URL to redirect the customer to.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Note that properties can differ based on the state of the payment.

Path Params

site_name

string

required

The site's unique name (its ID), returned when the site is created.

string

required

Body Params

state

string

enum

required

State of the payment session

Allowed:

transaction_id

string | null

System identifier of the transaction given by the payment gateway

icon

string | null

Icon URL to display in the confirmation checkout

name

string | null

Display name of the method used for the transaction

instructions

string | null

Display instructions to the customers when they will return to the confirmation page.
HTML is sanitized server-side.

links

object | null

Links that will be used to refund a payment or any other actions that might happen
on this payment from the merchant dashboard

error

object | null

Error message to display to the customer

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Content

429Too many requests. The rate limit was exceeded.