Purpl Api

Welcome to Purpl's RESTful API.

This API has the following resources:

• User - A user who can login to the system and create resources in the system.
• Application - A client application that can interact with the API on behalf of a User. A User registers an Application to be able to use the API.
• Token - A value that represents authentication of a user or a client application. The token is passed with requests to the API, which then processes the request based on the credentials presented in the token.
• Remittance - An amount of money sent by a sender to a beneficiary or a User in the system.
• Cash Out - An attempt to cash out a remittance by the beneficiary (User) in the system.

To be able to use this API, follow this workflow:

1. Register for a User account. Purpl can do this for you.
2. Log in to the API by clicking on the Log in link on the top-right of the page and logging in with your user account.
3. After successfully logging in, click on the URL for the applications resource.
4. Fill out the form and set the name of your application. Copy the client_id and client_secret that was created for your application.
5. Save your Application by clicking on the POST button.
6. In your client application, obtain a token for use in the API by sending a POST request to the tokens endpoint while passing the client_id, client_secret, grant_type of 'client_credentials' and an optional scope.
7. Use the access_token returned in step 6 to access the API by passing it as a 'Bearer' token in the Authorization header of your application's requests.