Jump to Content

Guides Quick Starts API Reference

API Reference

Guides Quick Starts API Reference

Ctrl+K

All

Guides

Recipes

Reference

Start typing to search…

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

/api/version

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

Response

200

Success

Updated over 2 years ago

/api/user-preferences

Did this page help you?

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.sandbox.mozaic.io/api/version

Updated over 2 years ago

/api/user-preferences

Did this page help you?

Mozaic.io API Documentation
Account
Refresh Auth Access Tokenpost
Verify Auth OTPpost
Generate Authorized Linkpost
Generate Auth OTPpost
Disables a user's account by marking it as blocked in Auth0. The user ID is extracted from the JWT token provided in the Authorization header.delete
Activity
update activity task statusput
Retrieves the Task Activity with the specified key and activity typeget
Create or update an Activityput
Retrieves the Activity with the specified key and activity typeget
Analytics
Retrieve a list of Payments summed by dateget
ApiKey
Deletes the current API key for the current user.delete
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
Apps
Create an application that can call the Mozaic API.put
Delete an applicationdelete
Create an application that can call the Mozaic API.post
Retrieve the info for applications you've createdget
Avatars
Upload avatar profile image via fileput
Retrieve a avatar by id and avatartypeget
Connectors
Retreive portfolio items.get
Smart auth callback to store token.get
Revoke accessdelete
Check if already authenticated for connectorget
Authentication with connector and store access info.get
Connector auth url for authentication.get
Create a connectorpost
Retrieve a List all connectors.get
Contacts
Retrieve the payment acceptance status for an accountget
Bulk add contactspost
Update a contact record - contact invite.put
Create a contact record - contact invite.post
Search contactsget
List requestsget
List of invited contactsget
Reject the contact invitationpost
Accept the contact invitationpost
Delete an contactdelete
Create a contact recordpost
List contactsget
Get a single contactget
Generate a new avatar image via AI prompt.put
Upload avatar via JSON bodyput
Reset avatar to the defaultdelete
Retrieve an avatar by idget
Upload avatar image via fileput
Contracts
Retrieve the total payments associated with a contractget
Retrieve a list of all related paymentsget
Retrieve a contractget
Delete a contractdelete
Update a contractput
Create a contractpost
List all contractsget
DeadLetterQueue
Replays messages from the dead-letter queue based on the specified message IDs or a time range.post
Purges messages older than the specified number of days from the dead-letter queue.post
Diagnostics
/api/diagnostics/signal-r-example-2get
/api/diagnostics/signal-r-example-1get
Simple ping test callget
End Users
/api/end-users/bulk/filepost
/api/end-users/invitepost
Create an end user for a tenantpost
Files
Upload a file for validationa and store in blob for payoutspost
Incomes
Create a contractget
Create a contractpost
Invite Tokens
Send an invite tokenpost
Decrypt an invite token and return information for displayget
Invoices
/api/invoices/{id}/payment-detailsget
Download invoice pdfpost
Pay finalized invoicepost
Finalize draft invoivepost
Find a Invoice by IDget
Create a Invoicepost
Retrieve a list of Invoicesget
Notifications
Update one or many Notifications (mark as read)put
Deletes a Notificationdelete
Update a Notification (mark as read)put
Retrieve notifications countsget
Retrieve a list of Notificationsget
/api/notifications/notification/negotiatepost
Orchestrations
Runs the payments phase for the specified `Orchestration`post
Runs the funding phase for an `Orchestration`post
Attach a funding source to an `Orchestration`. This defines funding origin.put
Attaches a payment push to an `Orchestration` in a pending state.put
Retrieve an `Orchestration` by IDget
Retrieve a list of `Orchestrations`get
Create an `Orchestration`post
Otp
Sends a one-time passcode (OTP) to the provided email address.post
Payer Invites
Get the current user payer profileget
Accept payer invitepost
Get payer invite details by idget
Send payer invite request.post
Retrieve a list of sent payer invitesget
Payment Cycles
Retrieve a list of all related paymentsget
Finalize to generate and pay invoicepost
Delete a payment entry for a payment cycleget
Delete a payment entry for a payment cycledelete
Update a payment entry for a payment cycleput
Get payment entry by idget
Bulk Create a payment entries for a payment cyclepost
Create a payment entry for a payment cyclepost
Retrieve a list of payment entries for a cyclesget
Delete a payment cycle and all associated payment cycle entries.delete
Update payment cycle detailsput
Retrieve payment cycle details by idget
Create payment cycle detailspost
Retrieve a list of payments cyclesget
Payment Pushes
Create payment pushes in bulkpost
Create a PaymentPushpost
Update push payment recordput
Find a PaymentPushCreate by IDget
Calculate fee estimates for individual transactions within a bulk payment.post
/api/payment-pushes/feespost
Payment object
Payment Transfer
Cancel pending transferput
Retrieve a payment transfer by IDget
Initiate balance withdrawalpost
Retrieve a list of payment transfersget
Payments
Retrieve if has any payment or contactget
List Transaction Statusesget
Retrieve Customer Virtual Receiving Accountget
Test method for invoice payment intent generationpost
Accept or Suspend payments from an account.post
List aggregated Pending or Suspended paymentsget
Update a Payment Detailsput
Cancel a paymentput
Retrieve a payment by IDget
Search payments (e.g. between dates, amounts, etc.)get
Retrieve a list of paymentsget
Permissions
List all permissions for the current userget
PersonalAccessToken
Enables a User to delete a personal access token.delete
Enables a User to create a personal access token.post
Retrieves the user's current personal access tokens.get
Portfolio
Create or update an PortfolioCatalogput
Create a PortfolioCatalogpost
Retrieve a list of PortfolioCatalogsget
Create or update an PortfolioItemput
Create a PortfolioItempost
Retrieve a list of PortfolioItemsget
PushNotifications
Push notification to devicepost
/api/push-notifications/username/{userName}delete
delete device registrationdelete
This creates or updates a registration (with provided channelURI) at the specified idput
SimpleContracts
Retrieve a list of all related paymentsget
Update a SimpleContractput
Archive the specified SimpleContractpost
Decline the specified SimpleContractpost
Accept the specified SimpleContractpost
Retrieve a SimpleContract by accountID and contract IDget
Retrieve a SimpleContractget
Delete a SimpleContractdelete
Create a SimpleContractpost
List all SimpleContractsget
Generate a new avatar image via AI prompt.put
Upload avatar via JSON bodyput
Reset avatar to the defaultdelete
Retrieve an avatar by idget
Upload avatar image via fileput
SystemEvents
Sends a payout transfer initiated notification with data from the request body.post
Sends a payment received notification for a recipient with an account with hardcoded values.post
Sends a payment received notification for a recipient without an account with hardcoded values.post
Sends a payment failure notification with hardcoded values.post
Sends a payment success notification with hardcoded values.post
Sends a verification code notification with an email input.post
Tenants
Returns the list of all access rules for the current user on the current accountget
Returns permission details such as CanCreate, CanView, etc for the specified resource to assist the UI. For a list of resources available on this account call GetListResourcesget
Gets an onboarding session key from stripeget
Returns a list of securable resourcesget
It will update the task statusput
Retrieve information about the onbaording taskget
Retrieve information about the onbaording tasksget
It uses to remove details from stripedelete
It uses to update documents needed for stripe, Proof of concept.put
/api/tenants/verificationput
This is a special use case for onboarding a tenant where the external wallets already exist. Calling this will pull data instead of creating new external accounts where possible.put
Create and on-board a tenant accountpost
Retrieve information about the current user/tenantget
Tip Links
Upload imagepost
Create a new Tip Linkpost
Get data for all Tip Linksget
Search tip linksget
Make changes to an existing Tip Linkput
Get data for a single Tip Link by idget
Transactions
Retrieve a list of recent transactionsget
User Statuses
Gets the UserStatus objectget
UserPreferences
/api/user-preferencesput
/api/user-preferencesget
Version
/api/versionget
Waitlist
Deletes the current user from the hubspot waitlist.delete
Add a contact to a waitlist.post
Gets the contact record of the current user if it exists. Can be used to check if a user is on a waitlist at application login. It cannot return which waitlist the user is currently on.get
Wallets
Set Wallet Default Payout Methodpost
Get the balance for all walletsget
Add a payment/payout both method to a walletpost
Update a card or bank payment method.put
Add a payment method to a walletpost
Add a payout method to a walletpost
Enable a walletpost
Get a single walletget
Get all walletsget
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
Refresh Auth Access Tokenpost
Verify Auth OTPpost
Generate Authorized Linkpost
Generate Auth OTPpost
Disables a user's account by marking it as blocked in Auth0. The user ID is extracted from the JWT token provided in the Authorization header.delete
Activity
update activity task statusput
Retrieves the Task Activity with the specified key and activity typeget
Create or update an Activityput
Retrieves the Activity with the specified key and activity typeget
Analytics
Retrieve a list of Payments summed by dateget
ApiKey
Deletes the current API key for the current user.delete
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
Apps
Create an application that can call the Mozaic API.put
Delete an applicationdelete
Create an application that can call the Mozaic API.post
Retrieve the info for applications you've createdget
Avatars
Upload avatar profile image via fileput
Retrieve a avatar by id and avatartypeget
Connectors
Retreive portfolio items.get
Smart auth callback to store token.get
Revoke accessdelete
Check if already authenticated for connectorget
Authentication with connector and store access info.get
Connector auth url for authentication.get
Create a connectorpost
Retrieve a List all connectors.get
Contacts
Retrieve the payment acceptance status for an accountget
Bulk add contactspost
Update a contact record - contact invite.put
Create a contact record - contact invite.post
Search contactsget
List requestsget
List of invited contactsget
Reject the contact invitationpost
Accept the contact invitationpost
Delete an contactdelete
Create a contact recordpost
List contactsget
Get a single contactget
Generate a new avatar image via AI prompt.put
Upload avatar via JSON bodyput
Reset avatar to the defaultdelete
Retrieve an avatar by idget
Upload avatar image via fileput
Contracts
Retrieve the total payments associated with a contractget
Retrieve a list of all related paymentsget
Retrieve a contractget
Delete a contractdelete
Update a contractput
Create a contractpost
List all contractsget
DeadLetterQueue
Replays messages from the dead-letter queue based on the specified message IDs or a time range.post
Purges messages older than the specified number of days from the dead-letter queue.post
Diagnostics
/api/diagnostics/signal-r-example-2get
/api/diagnostics/signal-r-example-1get
Simple ping test callget
End Users
/api/end-users/bulk/filepost
/api/end-users/invitepost
Create an end user for a tenantpost
Files
Upload a file for validationa and store in blob for payoutspost
Incomes
Create a contractget
Create a contractpost
Invite Tokens
Send an invite tokenpost
Decrypt an invite token and return information for displayget
Invoices
/api/invoices/{id}/payment-detailsget
Download invoice pdfpost
Pay finalized invoicepost
Finalize draft invoivepost
Find a Invoice by IDget
Create a Invoicepost
Retrieve a list of Invoicesget
Notifications
Update one or many Notifications (mark as read)put
Deletes a Notificationdelete
Update a Notification (mark as read)put
Retrieve notifications countsget
Retrieve a list of Notificationsget
/api/notifications/notification/negotiatepost
Orchestrations
Runs the payments phase for the specified `Orchestration`post
Runs the funding phase for an `Orchestration`post
Attach a funding source to an `Orchestration`. This defines funding origin.put
Attaches a payment push to an `Orchestration` in a pending state.put
Retrieve an `Orchestration` by IDget
Retrieve a list of `Orchestrations`get
Create an `Orchestration`post
Otp
Sends a one-time passcode (OTP) to the provided email address.post
Payer Invites
Get the current user payer profileget
Accept payer invitepost
Get payer invite details by idget
Send payer invite request.post
Retrieve a list of sent payer invitesget
Payment Cycles
Retrieve a list of all related paymentsget
Finalize to generate and pay invoicepost
Delete a payment entry for a payment cycleget
Delete a payment entry for a payment cycledelete
Update a payment entry for a payment cycleput
Get payment entry by idget
Bulk Create a payment entries for a payment cyclepost
Create a payment entry for a payment cyclepost
Retrieve a list of payment entries for a cyclesget
Delete a payment cycle and all associated payment cycle entries.delete
Update payment cycle detailsput
Retrieve payment cycle details by idget
Create payment cycle detailspost
Retrieve a list of payments cyclesget
Payment Pushes
Create payment pushes in bulkpost
Create a PaymentPushpost
Update push payment recordput
Find a PaymentPushCreate by IDget
Calculate fee estimates for individual transactions within a bulk payment.post
/api/payment-pushes/feespost
Payment object
Payment Transfer
Cancel pending transferput
Retrieve a payment transfer by IDget
Initiate balance withdrawalpost
Retrieve a list of payment transfersget
Payments
Retrieve if has any payment or contactget
List Transaction Statusesget
Retrieve Customer Virtual Receiving Accountget
Test method for invoice payment intent generationpost
Accept or Suspend payments from an account.post
List aggregated Pending or Suspended paymentsget
Update a Payment Detailsput
Cancel a paymentput
Retrieve a payment by IDget
Search payments (e.g. between dates, amounts, etc.)get
Retrieve a list of paymentsget
Permissions
List all permissions for the current userget
PersonalAccessToken
Enables a User to delete a personal access token.delete
Enables a User to create a personal access token.post
Retrieves the user's current personal access tokens.get
Portfolio
Create or update an PortfolioCatalogput
Create a PortfolioCatalogpost
Retrieve a list of PortfolioCatalogsget
Create or update an PortfolioItemput
Create a PortfolioItempost
Retrieve a list of PortfolioItemsget
PushNotifications
Push notification to devicepost
/api/push-notifications/username/{userName}delete
delete device registrationdelete
This creates or updates a registration (with provided channelURI) at the specified idput
SimpleContracts
Retrieve a list of all related paymentsget
Update a SimpleContractput
Archive the specified SimpleContractpost
Decline the specified SimpleContractpost
Accept the specified SimpleContractpost
Retrieve a SimpleContract by accountID and contract IDget
Retrieve a SimpleContractget
Delete a SimpleContractdelete
Create a SimpleContractpost
List all SimpleContractsget
Generate a new avatar image via AI prompt.put
Upload avatar via JSON bodyput
Reset avatar to the defaultdelete
Retrieve an avatar by idget
Upload avatar image via fileput
SystemEvents
Sends a payout transfer initiated notification with data from the request body.post
Sends a payment received notification for a recipient with an account with hardcoded values.post
Sends a payment received notification for a recipient without an account with hardcoded values.post
Sends a payment failure notification with hardcoded values.post
Sends a payment success notification with hardcoded values.post
Sends a verification code notification with an email input.post
Tenants
Returns the list of all access rules for the current user on the current accountget
Returns permission details such as CanCreate, CanView, etc for the specified resource to assist the UI. For a list of resources available on this account call GetListResourcesget
Gets an onboarding session key from stripeget
Returns a list of securable resourcesget
It will update the task statusput
Retrieve information about the onbaording taskget
Retrieve information about the onbaording tasksget
It uses to remove details from stripedelete
It uses to update documents needed for stripe, Proof of concept.put
/api/tenants/verificationput
This is a special use case for onboarding a tenant where the external wallets already exist. Calling this will pull data instead of creating new external accounts where possible.put
Create and on-board a tenant accountpost
Retrieve information about the current user/tenantget
Tip Links
Upload imagepost
Create a new Tip Linkpost
Get data for all Tip Linksget
Search tip linksget
Make changes to an existing Tip Linkput
Get data for a single Tip Link by idget
Transactions
Retrieve a list of recent transactionsget
User Statuses
Gets the UserStatus objectget
UserPreferences
/api/user-preferencesput
/api/user-preferencesget
Version
/api/versionget
Waitlist
Deletes the current user from the hubspot waitlist.delete
Add a contact to a waitlist.post
Gets the contact record of the current user if it exists. Can be used to check if a user is on a waitlist at application login. It cannot return which waitlist the user is currently on.get
Wallets
Set Wallet Default Payout Methodpost
Get the balance for all walletsget
Add a payment/payout both method to a walletpost
Update a card or bank payment method.put
Add a payment method to a walletpost
Add a payout method to a walletpost
Enable a walletpost
Get a single walletget
Get all walletsget
WebhookPortal
Gets the user's webhook console portal link. You can use this link to configure your webhooks, view logs and monitor activity.get