Introduction
This is the documentation for the PayCashless API
If you’re an issuer trying to accept QR payment intents on your bank app make sure you check the integration guides first
Get started
PayCashless API is a REST API that accepts application/json and returns JSON with standard HTTP response codes.
The API is only available via HTTPS.
Authentication
All request require API key to be passed in the Authorization request header (using the bearer authentication scheme). Send an to email [email protected] if you do not have an API key.
Errors
PayCashless follows the conventional HTTP status codes.
Code in the range of 2xx indicate success, while codes in the range of 4xx indicates that the request failed as a result of the something provided in the request data.
And codes in the range 5xx are unexpected server errors.
Every error includes a type. We have 4 possible values api_error, authentication_error, idempotency_error, or invalid_request_error
This is a more specific error code that summarises the error. Can be implemented or caught in your code for specific error handling.
A detailed human-readable message providing information about the error.
HTTP status codes
| Code | Description | Definition |
|---|---|---|
| 200 | OK | Everything worked as expected |
| 400 | Bad Request | Request could not be processed, often due to missing parameter |
| 401 | Unauthorised | Could not complete authorization due to missing key, invalid key or missing authorisation header |
| 404 | Not found | Resource does not exist |
| 409 | Conflict | Request conflicts with another request (likely using the same idempotency key) |
| 429 | Too many requests | You are sending too many requests |
| 422 | Unprocessable entity | Payload validation error |
| 5xx | Server error | An unexpected error happened while processing the request |