Create a payment entry for a payment cycle

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

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

from
object

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

string | null
string | null
string
enum

draft

success

warning

error

processing

Allowed:
fees
array of objects | null
fees
amount
object
original_amount
object
string
enum

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:
funding_source
object

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

string | null

Invoice External ID for Payment Cycle Invoice Funding Source

string | null
Headers
string
enum
Defaults to application/json

Generated from available response content types

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

Generated from available request content types

Allowed:
Responses

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