Instantiate Order Template

Create a real order from a template. The new order is prefilled from the template and assigned a freshly generated ID.
Any pay schedule is copied as inert configuration — start it separately via the pay schedule start endpoint.
Provide an optional order body to override the template's prefilled values (e.g. customers, amount, description) for this order.

Path Params
string
required

The merchant ID

string
required

The string identifier for the template.

Body Params
string | null

Unique identifier for the order

string | null

Short label for the order, e.g. the product, service, or membership name

string | null

Description of the order

number | null

Total amount of the order

string

Currency of the order amount in ISO 4217 format

string

List of customers associated with this order

paySchedule
object | null

Payment schedule for the order

Headers
string
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json