Create an `Orchestration`

Orchestrations greatly simplify payment routines and facilitate split payments. Orchestrations can import sales data, distill catalog information, requests payments, send payouts, and automatically reconcile funding with just a few API calls.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details for creating a new payment cycle

string
enum

The payment cycle mode defines how a payment cycle behaves.

continuous (Orchestrations can remain continuously listening for funding until deliberately closed. Useful for open ended payment scenarios like tip links where funding trickles in based on exposure and engagement. In this scenario, the funding step will process income, calculate contracts, and attach sent payments to the orchestration for later reporting.)

batched (Batched orchestrations are for data imports. They're likely created as part of a backend process and are initiated via data feeds.)

immediate (Orchestrations can be interactively built up and immediately executed and closed. This is useful for explicit payment grouping scenarios where you want to prepare a set of payments and explicitly define funding up front. These can be funded via invoice or instant card payment still, but they are immediately executed)

Allowed:
string | null
Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json