API Reference
Introduction
The Paycashless REST API lets you securely collect payments and disburse funds through a reliable platform built for developers.
Getting Started
Paycashless API is a RESTful service that accepts and returns JSON. All requests must be made over HTTPS and authenticated using your API keys. To get started, create a free Paycashless account here. You’ll receive test API keys which you can use to start making requests in a sandbox environment. Base URLHTTP 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 |
Supported Currencies
Paycashless uses ISO 4217 currency codes. Amounts must be sent in the smallest unit of the currency (i.e., multiplied by 100). For example, to charge NGN 100.00, you should send10000.
| Currency Code | Base Unit | Description |
|---|---|---|
NGN | Kobo | Nigerian Naira |