Retrieve a list of `Orchestrations`

get https://api.sandbox.mozaic.io/api/orchestrations

An Orchestration represents the lifecycle of moving funds from start to finish. Once an Orchestration completes, it provides the resulting invoices and payment ledgers for double-entry accounting.

Responses

Response body

array of objects

object

user_id

string | null

payment_pushes

array of objects | null

payment_pushes

object

from

object

A lightweight object for specifying 'to' and 'from' addresses
and other forms of general contact

object

required

A lightweight object for specifying 'to' and 'from' addresses
and other forms of general contact

memo

string | null

A memo to include with the payment

amount

object

required

fee_direction

string

required

Defines the direction in which fees are charged.

default (Use the platform default fee direction which is to the Payee)

payer (Fees are charged to the Payer)

payee (Fees are charged to the Payee)

split (Fees are split equally between Payer and Payee.
Any remaineder is paid by the Payee)

default payer payee split

ignore_contracts

boolean

Setting to true will ignore contracts for this tenant tied to the payee or payer. If unspecified or false, contracts, such as recoupables, will be applied by default

funding_source

object

Funding sources can be user/tenant wallet payment sources
or ACH Direct Debit, or Debit Credit via Wire or Deposits

payment_source

object

invoice_id

string | null

Invoice External ID for Payment Cycle Invoice Funding Source

payment_direction

string

push

request

smartContract

paymentCycle

transfer

push request smartContract paymentCycle transfer

accounting_from

date-time | null

accounting_to

date-time | null

object

string | null

funding_source

object

Funding sources can be user/tenant wallet payment sources
or ACH Direct Debit, or Debit Credit via Wire or Deposits

mode

string

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)

continuous batched immediate

status

string

Defines a state for the general workflow of a payment cycle

draft

pending

funding

completed

canceled

draft pending funding completed canceled

account_id

string | null

short_id

string | null

created_at

date-time

Response body

array of objects

object

user_id

string | null

payment_pushes

array of objects | null

payment_pushes

object

from

object

A lightweight object for specifying 'to' and 'from' addresses
and other forms of general contact

object

required

A lightweight object for specifying 'to' and 'from' addresses
and other forms of general contact

memo

string | null

A memo to include with the payment

amount

object

required

fee_direction

string

required

Defines the direction in which fees are charged.

default (Use the platform default fee direction which is to the Payee)

payer (Fees are charged to the Payer)

payee (Fees are charged to the Payee)

split (Fees are split equally between Payer and Payee.
Any remaineder is paid by the Payee)

default payer payee split

ignore_contracts

boolean

Setting to true will ignore contracts for this tenant tied to the payee or payer. If unspecified or false, contracts, such as recoupables, will be applied by default

funding_source

object

Funding sources can be user/tenant wallet payment sources
or ACH Direct Debit, or Debit Credit via Wire or Deposits

payment_source

object

invoice_id

string | null

Invoice External ID for Payment Cycle Invoice Funding Source

payment_direction

string

push

request

smartContract

paymentCycle

transfer

push request smartContract paymentCycle transfer

accounting_from

date-time | null

accounting_to

date-time | null

object

string | null

funding_source

object

Funding sources can be user/tenant wallet payment sources
or ACH Direct Debit, or Debit Credit via Wire or Deposits

mode

string

The payment cycle mode defines how a payment cycle behaves.

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

continuous batched immediate

status

string

Defines a state for the general workflow of a payment cycle

draft

pending

funding

completed

canceled

draft pending funding completed canceled

account_id

string | null

short_id

string | null

created_at

date-time

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.sandbox.mozaic.io/api/orchestrations \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Success

404Not Found

defaultError