Quick Start

Get Access to the Sharable Cash Platform

Start interacting with Sharable Cash. 

To get registered as a Facilitator, please contact us at {    }. 

Once registered, a Facilitator will be issued API keys. These keys must be used for any calls to the Sharable Cash platform within a specific Execution Environment - Sandbox or Live. 

API key has two parts that are separated by a dot:

1. Public - visible part used in audit fields. 
2. Private - visible only during key generation; afterwards, only its hashed version is saved for validation. 

Example key: 0376F7644E7B9FEA.sandfck-5j7zZJJJF6yBDiB3JZfxLtODab9EXAMPLE, where :

• 0376F7644E7B9FEA  - the public part
• sandfck-5j7zZJJJF6yBDiB3JZfxLtODab9EXAMPLE - private part

The public part is visible in audit fields (ex., "modified-by").

The key should be placed in a header parameter called sc-api-key: <key-id>.<api-key>.

Example:

1. GET https://cash.mysharable.com/facilitator-api/v1/facilitators

2. sc-api-key: SDFHJSKDFESDF.sandsak-4L7PIoPkwphzi6QSLSInngdNmjoEXAMPLE

// Sample response

{
 "paging": null,
 "data": [
   {
     "facilitator_id": "fcl_UVWWFcbVs8t2bdPE",
     "facilitator_name": "Balance Finance LLC",
     "facilitator_display_name": "Balance Finance",
     "facilitator_description": "This is an organization provding financial services in insurance sector.",
     "plan_id": "pln_pHLYFSnr1j7AxjRd",
     "email": "contact@balancefinance.com",
     "created_by": "SYSTEM",
     "created_date_time": "2023-02-15T17:41:25.74",
     "modified_by": "510E7392ED8E4149",
     "modified_date_time": "2023-07-20T13:09:17.747"
   }
 ],
 "errors": null
}

All API requests must be made over HTTPS. API requests without authentication will fail.

Make a Transaction

To make your first Transaction, follow the next steps:

1. Check the list of available Programs created for you by Sharable Cash at the start. You'll have ready Applications with defined Transaction Templates based on your requirements.  

2. Create Customer Profiles for your Customers.  

3. If you plan to use a Check in Transactions, add a Customer Profile Address. 

4. Attach your Customer Profile to the selected Program. 

5. Create Payment Instruments for your Customer. 

6. Create a Transaction.