Jump to Content

Guides Quick Starts API Reference

API Reference

Guides Quick Starts API Reference

Mozaic.io API Documentation

Account
Activity
Analytics
- Retrieve a list of Payments summed by dateget
ApiKey
- Retrieves the user's current API Keys if they already exist, otherwise a new ClientID and ClientSecret will be generated for the user's account.get
- Deletes the current API key for the current user.delete
Apps
Avatars
- Retrieve a avatar by id and avatartypeget
- Upload avatar profile image via fileput
Connectors
Contacts
Contracts
DeadLetterQueue
- Purges messages older than the specified number of days from the dead-letter queue.post
- Replays messages from the dead-letter queue based on the specified message IDs or a time range.post
Diagnostics
End Users
Files
- Upload a file for validationa and store in blob for payoutspost
Incomes
- Create a contractpost
- Create a contractget
Invite Tokens
- Decrypt an invite token and return information for displayget
- Send an invite tokenpost
Invoices
Notifications
Orchestrations
Otp
- Sends a one-time passcode (OTP) to the provided email address.post
Payer Invites
Payment Cycles
Payment Pushes
Payment Transfer
Payments
Permissions
- List all permissions for the current userget
PersonalAccessToken
Portfolio
PushNotifications
SimpleContracts
SystemEvents
Tenants
Tip Links
Transactions
- Retrieve a list of recent transactionsget
User Statuses
- Gets the UserStatus objectget
UserPreferences
- /api/user-preferencesget
- /api/user-preferencesput
Version
- /api/versionget
Waitlist
Wallets
WebhookPortal
- Gets the user's webhook console portal link. You can use this link to configure your webhooks, view logs and monitor activity.get

Mozaic.io API Documentation

Account
Activity
Analytics
- Retrieve a list of Payments summed by dateget
ApiKey
- Retrieves the user's current API Keys if they already exist, otherwise a new ClientID and ClientSecret will be generated for the user's account.get
- Deletes the current API key for the current user.delete
Apps
Avatars
- Retrieve a avatar by id and avatartypeget
- Upload avatar profile image via fileput
Connectors
Contacts
Contracts
DeadLetterQueue
- Purges messages older than the specified number of days from the dead-letter queue.post
- Replays messages from the dead-letter queue based on the specified message IDs or a time range.post
Diagnostics
End Users
Files
- Upload a file for validationa and store in blob for payoutspost
Incomes
- Create a contractpost
- Create a contractget
Invite Tokens
- Decrypt an invite token and return information for displayget
- Send an invite tokenpost
Invoices
Notifications
Orchestrations
Otp
- Sends a one-time passcode (OTP) to the provided email address.post
Payer Invites
Payment Cycles
Payment Pushes
Payment Transfer
Payments
Permissions
- List all permissions for the current userget
PersonalAccessToken
Portfolio
PushNotifications
SimpleContracts
SystemEvents
Tenants
Tip Links
Transactions
- Retrieve a list of recent transactionsget
User Statuses
- Gets the UserStatus objectget
UserPreferences
- /api/user-preferencesget
- /api/user-preferencesput
Version
- /api/versionget
Waitlist
Wallets
WebhookPortal
- Gets the user's webhook console portal link. You can use this link to configure your webhooks, view logs and monitor activity.get

Simple ping test call

get https://api.sandbox.mozaic.io/api/diagnostics/ping

The API ping is the simplest way to test availbility and authentcation of the Mozaic API

Language

Credentials