The BloomRemit API gives developers programmatic access to the core functionality of the platform. Using our RESTFUL API, a developer will be able to build applications that accomplish the following:
The typical remittance workflow is as follows:
Create or select a Sender associated with an Agent
Each Partner has 1 or more agents, which represent the individual pay-in channels (kiosks, website, mobile app, etc) that the sender can interact with.
Create a Recipient
A Sender has 1 or more recipients associated with their account. Recipients are scoped to each sender, and cannot be shared from one sender to another.
A remittance is a transaction between a Sender and a Recipient, facilitated by an Agent.
Monitor Transaction Status
After a transaction is created, its status may change to any of the following: bank_error, incomplete, paid, completed, rejected, refunded, cancelled, cancelling, error, delayed, waiting, unpaid, and outstanding
Currently there are 3 api versions available, you can use these different versions in combination.
Most API Endpoints need authentication for you to access. To know about your authentication details: you log in as an admin user and go to Organization Settings > API Access. For further inquiries and questions, please direct your inquiries to firstname.lastname@example.org.
Some API Endpoints don’t need API Tokens and Secrets, it’ll be indicated on the documentaiton.