We are pleased to announce that your favorite Merchant Services CRM now includes an Open Residuals API!
Check out the latest IRIS CRM Residuals API Documentation.
The Residuals API is the latest of the Open API extensions added over the last 12 months, which also include the Lead, Merchant, and Helpdesk APIs.
IRIS CRM Residuals API opens the door to endless possibilities to integrate your residual reports data with other systems. For example, you may want to download specific fields from your monthly residuals reports into an external data warehouse, accounting system, or business intelligence tool. IRIS CRM gives your developers access and flexibility to calculate residuals income like never before.
Instructions: How To Use Your IRIS CRM Residuals API
To begin using the Residuals API, you will first need to create an API Token.
Click on your username in the top right corner in IRIS CRM, and then click Settings.
On the Settings page that opens click on the API Settings tab, and click the Create New API Token button.
You can now enter a name for your token and optionally restrict the API usage to specific IP addresses. When you’re done, click Add New Token and the token will be generated:
Once you have the token continue to the API documentation page for further instructions and a complete list of API functions.
The API documentation is available at https://yoursitedomain.com/api (replace the letters in bold with your actual domain) and also at https://www.iriscrm.com/api
Video: How To Connect And Use The New Residuals API
Check out this brief video showing the entire process of creating the API token and then sending a few sample API requests via the Postman tool:
Note: Below is a list of the Residuals API functions you can now use, including the function descriptions and a list of available parameters. Make sure to check the actual Residuals API documentation which will always reflect the latest specifications in (the likely) case that we make updates and enhancements after this article is published.
Get residuals summary data
Enables you to retrieve residuals summary data by year and month.
The optional query parameters include:
- processor: an integer value for retrieving the summary data by processor ID
- group: an integer value for retrieving the summary data by group ID
- agent: an integer value for retrieving the summary data by agent ID
- search: a text string to search for in the report data
- hide_null_merchants: a boolean value for hiding inactive merchants (true by default)
- page: the page number to retrieve in the response
- per_page: an integer value to limit the number of records per page
URL request example: https://demo.iriscrm.com/api/v1/residuals/reports/summary/{year}/{month}
Get residuals summary with merchant rows
Enables you to retrieve residuals summary data for a specific processor by year and month, including merchant rows.
The optional query parameters include:
- group: an integer value for retrieving the residuals summary by group ID
- agent: an integer value for retrieving the residuals summary by agent ID
- search: a text string to search for in the report data
- hide_null_merchants: a boolean value for hiding inactive merchants (true by default)
- template: a boolean value for applying user templates (true by default)
- page: the page number to retrieve in the response
- per_page: an integer value to limit the number of records per page
URL request example: https://demo.iriscrm.com/api/v1/residuals/reports/summary/rows/{processor_id}/{year}/{month}
Get residuals details with merchant rows
Enables you to retrieve residuals report calculation details for a specific processor by year and month, including merchant rows.
The optional query parameters include:
- group: an integer value for retrieving residuals details by group ID
- agent: an integer value for retrieving residuals details by agent ID
- search: a text string to search for in the report data
- hide_null_merchants: a boolean value for hiding inactive merchants (true by default)
- page: the page number to retrieve in the response
- per_page: an integer value to limit the number of records per page
URL request example: https://demo.iriscrm.com/api/v1/residuals/reports/details/{processor_id}/{year}/{month}
Get residuals line items
Enables you to retrieve line items by year and month.
The optional query parameters include:
- created: a date string to filter the line items by date (Y-m-d)
- dba: a text string for retrieving line items by a merchant name
- username: a text string for retrieving line items by user name
- user_id: an integer value for retrieving line items by user ID
- description: a text string for retrieving the line items that match a description
- page: the page number to retrieve in the response
- per_page: an integer value to limit the number of records per page
URL request example: https://demo.iriscrm.com/api/v1/residuals/lineitmes/{year}/{month}
Get residuals templates
Enables you to retrieve residuals templates with their respective rules.
The optional query parameters include:
- name: a text string to filter templates by name
- revision: a text string to filter templates by the revision
- creator: a text string to filter templates by the creator
- page: the page number to retrieve in the response
- per_page: an integer value to limit the number of records per page
URL request example: https://demo.iriscrm.com/api/v1/residuals/templates
Get a list of users with assigned residuals templates
Enables you to retrieve a list of users with assigned residuals templates by month and year.
The optional query parameters include:
- user: a text string to filter templates by name
- processor: an integer value for retrieving templates by processor ID
- group: an integer value for retrieving templates by group ID
- class: a text string to filter templates by the creator
- page: the page number to retrieve in the response
- per_page: an integer value to limit the number of records per page
URL request example: https://demo.iriscrm.com/api/v1/residuals/templates
You can also create subscriptions to receive notifications in your system when:
- A residuals report is published
- A residuals line item is added
We hope that you enjoy using the Residual API.
Stay tuned for more updates coming soon!
For sales tips and the latest electronic payments news check out the daily IRIS CRM Daily Bulletin and for the latest product updates and company news please join our newsletter.