Cashonrails - Developer Documentation

Create Reserved Account

Create a dedicated virtual account for a customer.

Endpoint

POST https://mainapi.cashonrails.com/api/v1/reserved_virtual_account

Request Headers

Header	Type	Description
Content-Type	string	application/json
Authorization	string	Bearer token with your secret key

Request Parameters

Parameter	Type	Required	Description
customer_code	string	Yes	Customer’s unique identifier (Get Customer Details)
provider	string	Yes	Virtual account provider e.g, netbank (Get Providers)
otp	string	No	One-time password if required

How to get the customer_code

Create a New Customer: Make a POST request to Create Customer endpoint. The response will contain the customer_code.
Find Existing Customer:
- Use Get Customer to find by ID
- Use List Customers to search all customers

How to get OTP

The customer initiates the process by dialing *565*3# on their phone that is registered under their BVN (Bank Verification Number). They will be prompted to enter their BVN followed by the iGree Code. For your service, the iGree Code is 11113.

Sample Request

curl --location 'https://mainapi.cashonrails.com/api/v1/reserved_virtual_account' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_KEY' \
--data '{
    "customer_code": "CUS_2qag1olxkkom7kl",
    "provider": "netbank",
    "otp": "123456"
}'

Introduction Account Providers