/api/payment-pushes/fees

Body Params
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
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)

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

push

request

smartContract

paymentCycle

transfer

date-time | null
date-time | null
string | null
Response

Language
Credentials
Choose an example:
application/json