API v1 2022-04-01

This is the first ReadyRemit release note. A ReadyRemit release is the act of copying the latest tested copy of ReadyRemit to the sandbox environment and updating documentation including publishing a new release note. Generally, a release note describes improvements introduced by a new release compared to the previous one. In this case, however, there is no previous release, so this release note simply records the two use cases described on the original Getting Started page in order to establish a baseline.

Overview

ReadyRemit leverages core Brightwell expertise, and makes it available as a generic remittance service to financial technology companies targeting various use cases including Your service is the sender and Your users are the senders.

Currently, ReadyRemit is suitable for early adopters targeting Your service is the sender where your service (1) pushes money to end users, or (2) allows end users to pull money from your service.

Your service is the sender

For this use case, your service is the sender, and your end users are the recipients. The use case supports transfers initiated by your service (e.g. payroll) and transfers initiated by your end users (e.g. reward redemption). Once fully implemented, ReadyRemit will represent your service with a Sender entity and one or more Sender Account entities, and each of your end users with a Recipient entity and one or more Recipient Account entities:

Your users are the senders

Note: The ReadyRemit Team is not targeting this use case yet.

In this use case, ReadyRemit represents each of your end users with a Sender entity and one or more Sender Account entities, and ReadyRemit represents each of your end user's recipients with a Recipient entity and one or more Recipient Account entities. Your database may not have any information about your users' recipients, so the ReadyRemit Recipient entity provides your service with a convenient place to store general profile information about these out-of-database recipients.