DUduda
Payment Gateways Runtime

Confirm payment session

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.

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

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/payment-sessions/{id}/confirm
  • Auth
    HTTP basic

Path parameters

site_namestring required

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

idstring required

Request body

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

System identifier of the transaction given by the payment gateway

iconstring nullable

Icon URL to display in the confirmation checkout

namestring nullable

Display name of the method used for the transaction

instructionsstring nullable

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

Response

OK

return_urlstring

URL to redirect the customer to

Changes

No recorded changes to this operation across all 1 revision of this API.