Retrieve a list of payments

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

Responses

Response body

object

data

array of objects | null

data

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

object

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

original_amount

object

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

transfer_id

string | null

Payment transfer id

payment_cycle_id

string | null

Payment Cycle identifier.

payment_source

object

invoice_id

string | null

Invoice External ID for Payment Cycle Invoice Funding Source

total_fees

object

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

count

int32

This is the count of records returned

page

int32 | null

total_count

int32

This is the total count of records available, Needed for pagination

Response body

object

data

array of objects | null

data

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

object

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

original_amount

object

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

transfer_id

string | null

Payment transfer id

payment_cycle_id

string | null

Payment Cycle identifier.

payment_source

object

invoice_id

string | null

Invoice External ID for Payment Cycle Invoice Funding Source

total_fees

object

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

count

int32

This is the count of records returned

page

int32 | null

total_count

int32

This is the total count of records available, Needed for pagination

Language

Credentials


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

Choose an example:

text/plain

application/json

text/json

200Success

400Bad Request

401Unauthorized

defaultError