Introduction
This documentation serves as a technical guide to outline the required and optional API functionalities necessary for integrating the Cashier (“Cashier”) with your software platform (“Platform”).
Review this documentation thoroughly
Read through this document in full to understand all relevant integration points.
Schedule an introductory call
Organize a meeting between your business stakeholders, IT developers, and our team to discuss the Cashier-to-Platform integration and identify any special requirements.
Analyze business requirements
Understand how the integration affects user experience and your internal business processes.
Sandbox environment & credentials
We will provide access to a sandbox environment and share credentials so you can begin development.
This setup will reflect your business needs, including but not limited to:
Deposit only
Deposit and payout
Backoffice support
Virtual Terminal access
Develop or expose your Platform API
Build or expose a REST API that connects your Platform to the Cashier. This API should be implemented using secure development practices and may be developed in any programming language or using any libraries of your choice.
Perform integration testing
Test your Platform in a fully functional test environment integrated with the Cashier. Once everything works as expected, you can coordinate with our team to move to production.
Cashier training session
Before going live, we’ll provide a dedicated training session for your team. After training, link your Platform’s cashier access to the new Cashier system. Our support team will remain available for any follow-up assistance.
Go live & finalize configurations
When your production website is integrated with the live Cashier system, we’ll help you configure:
Payment methods
Limits
Rules
Additional account settings
To ensure a smooth technical implementation, make sure your team understands the following requirements. These define both the scope of development and the associated technical and compliance needs:
If using the Payment API with full card data, you must provide PCI Level 1 compliance documents (AOC) from either your organization or your CRM provider.
If PCI documents are not available, please use the Cashier API integration path instead.
Is payout functionality required?
If Yes, one of the following options must be fulfilled:
Are you planning to use authorization & capture flows?
If Yes, make sure to:
Do you want to support MOTO (manual deposits on behalf of the customer)?
If Yes, you must implement the Virtual Terminal feature.