Jump to Content
Guides
Quick Starts
API Reference
v1.0
v2.0
Log In
API Reference
Log In
Lighthouse
Guides
Quick Starts
API Reference
Retreive portfolio items.
JUMP TO
Mozaic.io API Documentation
Account
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
Generate Auth OTP
post
Generate Authorized Link
post
Verify Auth OTP
post
Refresh Auth Access Token
post
Activity
Retrieves the Activity with the specified key and activity type
get
Create or update an Activity
put
Retrieves the Task Activity with the specified key and activity type
get
update activity task status
put
Analytics
Retrieve a list of Payments summed by date
get
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
Retrieve the info for applications you've created
get
Create an application that can call the Mozaic API.
post
Delete an application
delete
Create an application that can call the Mozaic API.
put
Avatars
Retrieve a avatar by id and avatartype
get
Upload avatar profile image via file
put
Connectors
Retrieve a List all connectors.
get
Create a connector
post
Connector auth url for authentication.
get
Authentication with connector and store access info.
get
Check if already authenticated for connector
get
Revoke access
delete
Smart auth callback to store token.
get
Retreive portfolio items.
get
Contacts
Upload avatar image via file
put
Retrieve an avatar by id
get
Reset avatar to the default
delete
Upload avatar via JSON body
put
Generate a new avatar image via AI prompt.
put
Get a single contact
get
List contacts
get
Create a contact record
post
Delete an contact
delete
Accept the contact invitation
post
Reject the contact invitation
post
List of invited contacts
get
List requests
get
Search contacts
get
Create a contact record - contact invite.
post
Update a contact record - contact invite.
put
Bulk add contacts
post
Retrieve the payment acceptance status for an account
get
Contracts
List all contracts
get
Create a contract
post
Update a contract
put
Delete a contract
delete
Retrieve a contract
get
Retrieve a list of all related payments
get
Retrieve the total payments associated with a contract
get
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
Simple ping test call
get
/api/diagnostics/signal-r-example-1
get
/api/diagnostics/signal-r-example-2
get
End Users
Create an end user for a tenant
post
/api/end-users/invite
post
/api/end-users/bulk/file
post
Files
Upload a file for validationa and store in blob for payouts
post
Incomes
Create a contract
post
Create a contract
get
Invite Tokens
Decrypt an invite token and return information for display
get
Send an invite token
post
Invoices
Retrieve a list of Invoices
get
Create a Invoice
post
Find a Invoice by ID
get
Finalize draft invoive
post
Pay finalized invoice
post
Download invoice pdf
post
/api/invoices/{id}/payment-details
get
Notifications
/api/notifications/notification/negotiate
post
Retrieve a list of Notifications
get
Retrieve notifications counts
get
Update a Notification (mark as read)
put
Deletes a Notification
delete
Update one or many Notifications (mark as read)
put
Orchestrations
Create an `Orchestration`
post
Retrieve a list of `Orchestrations`
get
Retrieve an `Orchestration` by ID
get
Attaches a payment push to an `Orchestration` in a pending state.
put
Attach a funding source to an `Orchestration`. This defines funding origin.
put
Runs the funding phase for an `Orchestration`
post
Runs the payments phase for the specified `Orchestration`
post
Otp
Sends a one-time passcode (OTP) to the provided email address.
post
Payer Invites
Retrieve a list of sent payer invites
get
Send payer invite request.
post
Get payer invite details by id
get
Accept payer invite
post
Get the current user payer profile
get
Payment Cycles
Retrieve a list of payments cycles
get
Create payment cycle details
post
Retrieve payment cycle details by id
get
Update payment cycle details
put
Delete a payment cycle and all associated payment cycle entries.
delete
Retrieve a list of payment entries for a cycles
get
Create a payment entry for a payment cycle
post
Bulk Create a payment entries for a payment cycle
post
Get payment entry by id
get
Update a payment entry for a payment cycle
put
Delete a payment entry for a payment cycle
delete
Delete a payment entry for a payment cycle
get
Finalize to generate and pay invoice
post
Retrieve a list of all related payments
get
Payment Pushes
Payment object
/api/payment-pushes/fees
post
Calculate fee estimates for individual transactions within a bulk payment.
post
Find a PaymentPushCreate by ID
get
Update push payment record
put
Create a PaymentPush
post
Create payment pushes in bulk
post
Payment Transfer
Retrieve a list of payment transfers
get
Initiate balance withdrawal
post
Retrieve a payment transfer by ID
get
Cancel pending transfer
put
Payments
Retrieve a list of payments
get
Search payments (e.g. between dates, amounts, etc.)
get
Retrieve a payment by ID
get
Cancel a payment
put
Update a Payment Details
put
List aggregated Pending or Suspended payments
get
Accept or Suspend payments from an account.
post
Test method for invoice payment intent generation
post
Retrieve Customer Virtual Receiving Account
get
List Transaction Statuses
get
Retrieve if has any payment or contact
get
Permissions
List all permissions for the current user
get
PersonalAccessToken
Retrieves the user's current personal access tokens.
get
Enables a User to create a personal access token.
post
Enables a User to delete a personal access token.
delete
Portfolio
Retrieve a list of PortfolioItems
get
Create a PortfolioItem
post
Create or update an PortfolioItem
put
Retrieve a list of PortfolioCatalogs
get
Create a PortfolioCatalog
post
Create or update an PortfolioCatalog
put
PushNotifications
This creates or updates a registration (with provided channelURI) at the specified id
put
delete device registration
delete
/api/push-notifications/username/{userName}
delete
Push notification to device
post
SimpleContracts
Upload avatar image via file
put
Retrieve an avatar by id
get
Reset avatar to the default
delete
Upload avatar via JSON body
put
Generate a new avatar image via AI prompt.
put
List all SimpleContracts
get
Create a SimpleContract
post
Delete a SimpleContract
delete
Retrieve a SimpleContract
get
Retrieve a SimpleContract by accountID and contract ID
get
Accept the specified SimpleContract
post
Decline the specified SimpleContract
post
Archive the specified SimpleContract
post
Update a SimpleContract
put
Retrieve a list of all related payments
get
SystemEvents
Sends a verification code notification with an email input.
post
Sends a payment success notification with hardcoded values.
post
Sends a payment failure notification with hardcoded values.
post
Sends a payment received notification for a recipient without an account with hardcoded values.
post
Sends a payment received notification for a recipient with an account with hardcoded values.
post
Sends a payout transfer initiated notification with data from the request body.
post
Tenants
Retrieve information about the current user/tenant
get
Create and on-board a tenant account
post
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
/api/tenants/verification
put
It uses to update documents needed for stripe, Proof of concept.
put
It uses to remove details from stripe
delete
Retrieve information about the onbaording tasks
get
Retrieve information about the onbaording task
get
It will update the task status
put
Returns a list of securable resources
get
Gets an onboarding session key from stripe
get
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 GetListResources
get
Returns the list of all access rules for the current user on the current account
get
Tip Links
Get data for a single Tip Link by id
get
Make changes to an existing Tip Link
put
Search tip links
get
Get data for all Tip Links
get
Create a new Tip Link
post
Upload image
post
Transactions
Retrieve a list of recent transactions
get
User Statuses
Gets the UserStatus object
get
UserPreferences
/api/user-preferences
get
/api/user-preferences
put
Version
/api/version
get
Waitlist
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
Add a contact to a waitlist.
post
Deletes the current user from the hubspot waitlist.
delete
Wallets
Get all wallets
get
Get a single wallet
get
Enable a wallet
post
Add a payout method to a wallet
post
Add a payment method to a wallet
post
Update a card or bank payment method.
put
Add a payment/payout both method to a wallet
post
Get the balance for all wallets
get
Set Wallet Default Payout Method
post
WebhookPortal
Gets the user's webhook console portal link. You can use this link to configure your webhooks, view logs and monitor activity.
get
Retreive portfolio items.
get
https://api.sandbox.mozaic.io/api/connectors/items
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
