API Reference

Attaches a payment push to an `Orchestration` in a pending state.

put
https://api.sandbox.mozaic.io/api/orchestrations//payment-pushes/attach
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The Orchestration Identifier

Body Params

The payment push details

PaymentPush_CreateDeets used for creating PaymentPushes

from
object

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

to
object
required

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

string | null

A memo to include with the payment

amount
object
required
string
enum
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)

Allowed:
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
string | null

Invoice External ID for Payment Cycle Invoice Funding Source

string
enum

push

request

smartContract

paymentCycle

transfer

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

Generated from available request content types

Allowed:
Responses

Updated over 2 years ago

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

Updated over 2 years ago