Cashonrails API Basics

Before you begin!

You should create a free Cashonrails account that you can test the API against. We will provide you with test keys that you can use to make API calls.

The Cashonrails API gives you access to pretty much all the features you can use on our dashboard and lets you extend them for use in your application. It strives to be RESTful and is organized around the main resources you would be interacting with - with a few notable exceptions.

Postman API Collection

To help you get started quickly with our API, we’ve created a comprehensive Postman collection that includes all available endpoints, request examples, and sample responses.

Using the Collection

1. Access the Collection: Our official Postman collection is available here

2. Import to Postman: Click the “Run in Postman” button on the collection page or use the Postman app to import via URL

3. Configure Environment: Set up your environment variables including your API key and other authentication details

4. Explore and Test: Browse through the available requests organized by category (Payments, Transfers, etc.) and test them directly from Postman

The collection is regularly updated to reflect the latest API changes and includes detailed documentation for each endpoint.

Benefits

• Quickly understand available endpoints and required parameters
• Test API responses without writing code
• Use request examples as a reference for your implementation
• Explore advanced features through pre-built request examples

Request Authorization Header

To ensure the authenticity of API requests, all requests must include the Authorization header with a Bearer Token containing your live or test secret key.

Authorization: Bearer {{ secret_key }}

Webhook Authorization Header

To ensure the authenticity of webhooks sent to your server, set the webhook key in your dashboard. This key will be sent as an Authorization header with a Bearer Token containing your webhook key.

Authorization: Bearer {{ webhook_key }}

HTTP Methods

Sample Requests

We provide sample API calls next to each method using cURL. All you need to do is insert your specific parameters, and you can test the calls from the command line. See this tutorial on using cURL with APIs.

Requests and Responses

Both request body data and response data are formatted as JSON. Content type for responses will always be application/json. Generally, all responses will be in the following format:

Response Keys

HTTP Status Codes

Cashonrails uses conventional HTTP response codes to indicate the success or failure of API requests. Here’s what each code means in the context of Cashonrails operations:

Success Codes

Client Error Codes

Server Error Codes

IP Whitelisting

IP whitelisting adds an extra layer of security by allowing only specified IP addresses to make API requests using your API keys.

To whitelist your IP addresses send an email from your registered email address to support@cashonrails.com

Sample email format:

Subject: IP Whitelisting Authorization Request

Message body:

Dear Cashonrails Admin,

We, **{business name}**, with Business ID **{business ID}**, hereby authorize the whitelisting of the following IP address(es) for our account:

192.168.1.1
192.168.1.2

Best regards,
[Your Full Name]
[Your Position]