The MCASuite REST API allows other systems to integrate into MCA Suite through a HTTP RESTful web service. The API is designed to ease the painful process of hand entering data from one system to another system. All responses will be in JSON format. If you are adding more than 25 transactions at once, we suggest you use the bulk AddTransactions API.
All calls require two identifying header parameters for credentialing:
Both of these values will be generated by MCA Suite and provided to our customers. Please contact your representative to get these credentials.
The Base REST URL will be provided to the customer upon API request.
The API will only accept json encoded parameters.
To test the rest url and parameter, we recommend using the Rested app on Mac OS. Alternatively, you can use the “Advanced Rest Client” extension on google Chrome. If using the Chrome extension, please verify you use application/json as content type, and paste the json parameters into the Raw tab.
Adding a Single Transaction
When adding a transaction through the rest api, the transaction can be seen under Deal Tracking similar to importing with csv or adding a manual transaction on the page.
Before adding a transaction, you must set up a Collector and a Merchant number on deal tracking page. This will identify which deal the transaction will be uploaded too. Alternatively, you can send in the MCA Suite dealId.
|collector||Yes||String||The name of the collector company|
|date||Yes||String||Date of transaction (MM/dd/yy)|
|dealId||String||Alternative method to match transaction to a deal.|
If dealId is used, merchantNumber and collector are ignored
|description||String - Max 30||Recommended.|
|Yes||String||'Upload', 'Fee' or 'Discount'|
default is 'Upload' if not supplied
|category||String||Transaction Category set up in your Application Configuration. |
Must exist in MCA Suite. It is case sensitive.
|achWorksId||String||Optional for users who use ACH Works and want to lookup a|
deal by the ACHWorks front end trace number. This will replace
dealId and collector + merchantNumber.
|error||List||List of error messages if available|