Create a PaymentPush

post https://api.sandbox.mozaic.io/api/payment-pushes

Creates a PaymentPush which sends a payment to the specified recipient. In order to create PaymentPushes on behalf of someone other than the logged in account the sender must be registered as a Tenant and have PaymentPush create scope.

Create scope permissions for the sending user. The PaymentPush workflow is high-level payment api abstracting many details about how The funds are flowing. For more information see Understanding Payments in Mozaic

Body Params

PaymentPush_CreateDeets

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)

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

accounting_from

date-time | null

accounting_to

date-time | null

object

string | null

Responses

Response body

object

acceptance_status

string | null

Flag: An indicator representing the payment acceptance status, distinct from the overall payment status.

transaction_id

string | null

Transaction IDs are used internally to group payment objects

from

object

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

handle

string | null

The Mozaic handle for a contact

string | null

The email address of the contact

phone

string | null

The fully qualified phone number of the contact

name

string

required

Loosely, the name of the contact. May be changed during registration

persona_id

string | null

Specifies the persona associated with this contact record

user_id

string | null

Specifies the user associated with this contact record

user_account_id

string | null

Specifies the user account id associated with this contact record

is_accepted_contact

boolean

Specifies whether this contact is in network or out of network

short_id

string | null

created_at

date-time

object

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

handle

string | null

The Mozaic handle for a contact

string | null

The email address of the contact

phone

string | null

The fully qualified phone number of the contact

name

string

required

Loosely, the name of the contact. May be changed during registration

persona_id

string | null

Specifies the persona associated with this contact record

user_id

string | null

Specifies the user associated with this contact record

user_account_id

string | null

Specifies the user account id associated with this contact record

is_accepted_contact

boolean

Specifies whether this contact is in network or out of network

short_id

string | null

created_at

date-time

memo

string | null

A memo to include with the payment

amount

object

currency

string | null

The currency of the amount

wallet_id

string | null

The id of the wallet to use.
If an Wallet id is not specified the platform balance is used if
the amount is less than or equal to the balance, otherwise the default
Wallet for the currency will be charged

quantity

double

The quantity of Currency to send
Note that quantity is either base units or fractional depending on the currency and wallet type

formatted_quantity

string | null

original_amount

object

currency

string | null

The currency of the amount

wallet_id

string | null

quantity

double

The quantity of Currency to send
Note that quantity is either base units or fractional depending on the currency and wallet type

formatted_quantity

string | null

fee_direction

string

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

direction

string

push

request

smartContract

paymentCycle

transfer

push request smartContract paymentCycle transfer

status

string | null

The status of the payment

payment_display_status

string

pending

posted

processing

adjusted

returned

completed

failed

pending posted processing adjusted returned completed failed

status_description

string | null

User Display Status

user_id

string | null

Id of the initiating user

tenant_id

string | null

Id of the account authorized to send payments

wallet_transaction_id

string | null

The transaction identifier from the wallet provider (external id)

Fees

array of objects | null

Fees

object

order

int32

type

string | null

amount

object

memo

string | null

external_id

string | null

funding_id

string | null

funding_type

string

invoice

wallet

balance

tipLink

invoice wallet balance tipLink

messsage

string | null

To store various payment-related information

payment_processing_details

object

amount_submitted

object

payee_transaction_fee

object

net_amount

object

amount_paid

object

Last4CardDigits

string | null

Last 4 card digits in case of PaymentMethod = card

account_number

string | null

Account number

account_routing

string | null

Account Routing

payment_provider_ref_code

string | null

Payment provider ref code

debit_date

date-time | null

Debit date

clearing_date

date-time | null

Clearing Date

value_date

date-time | null

Value date

payment_method

string | null

Payment method

direction

string

out

in out

provider_account

string | null

Provider account

internal_number

string | null

Internal Number

external_id

string | null

External ID

payee_internal_id

string | null

Payee Internal ID

status

string | null

Processing Details Status

card_brand

string | null

accounting_from

date-time | null

accounting_to

date-time | null

short_id

string | null

created_at

date-time

transfer_id

string | null

Payment transfer id

payment_cycle_id

string | null

Payment Cycle identifier.

payment_source

object

string | null

payment_source

string | null

invoice_id

string | null

Invoice External ID for Payment Cycle Invoice Funding Source

total_fees

object

currency

string | null

The currency of the amount

wallet_id

string | null

quantity

double

The quantity of Currency to send
Note that quantity is either base units or fractional depending on the currency and wallet type

formatted_quantity

string | null

payment_direction

string

out

in out

wallet_key

string | null

Wallet id

payout_id

string | null

Payment payout id

ledger_type

string

Shows the type of the ledger entry that a Payment document in cosmos represents.

active (Active: The payment was created and sent by the system (money moved between accounts).)

journal (Journal: The payment was done off-platform and no money was moved between accounts.)

active journal

short_id

string | null

created_at

date-time

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.sandbox.mozaic.io/api/payment-pushes \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/*+json' \
5
     --data '
6
{
7
  "fee_direction": "default"
8
}
9
'

Choose an example:

application/json

200Success

404Not Found

500Server Error