Cashonrails - Developer Documentation

Fetch Transfers

The Fetch Transfers endpoint allows you to retrieve a list of all transfers that have been initiated, along with their statuses and other relevant details.

Endpoint

GET https://mainapi.cashonrails.com/api/v1/fetch_all_transfers

Request Headers

Header	Type	Description
Authorization	string	Bearer token with your secret key

Sample Request

GET https://mainapi.cashonrails.com/api/v1/fetch_all_transfers

Sample cURL Request

curl -X GET https://mainapi.cashonrails.com/api/v1/fetch_all_transfers \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_SECRET_KEY"

Sample Response

{
    "success": true,
    "status": "00",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 20,
                "trx": "2025011019031105106485",
                "reference": "COR-2025011019031105106485",
                "transactionRef": null,
                "sessionid": null,
                "currency": "NGN",
                "amount": "100",
                "fee": "25",
                "account_name": "John Doe",
                "account_number": "0123456789",
                "bank_name": "SAFE HAVEN MICROFINANCE BANK",
                "bank_code": "999240",
                "narration": "Test",
                "domain": "test",
                "status": "pending",
                "created_at": "2025-01-10T18:03:12.000000Z",
                "updated_at": "2025-01-10T17:03:13.000000Z"
            },
            // ... more transfers
        ],
        "first_page_url": "http://mainapi.stag.cashonrails.com/api/v1/fetch_all_transfers?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://mainapi.stag.cashonrails.com/api/v1/fetch_all_transfers?page=1",
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "http://mainapi.stag.cashonrails.com/api/v1/fetch_all_transfers?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "http://mainapi.stag.cashonrails.com/api/v1/fetch_all_transfers",
        "per_page": 50,
        "prev_page_url": null,
        "to": 17,
        "total": 17
    }
}

Response Fields

Field	Type	Description
success	boolean	Indicates if the request was successful
status	string	Status code of the request
data	object	Contains the transfer details
current_page	number	The current page number
data	array	List of transfer objects
id	number	Unique identifier for the transfer
trx	string	Transaction reference
reference	string	Unique reference for the transfer
transactionRef	string	Transaction reference from the bank
sessionid	string	Session ID
currency	string	The currency of the transfer
amount	string	The amount transferred
fee	string	The fee for the transfer
account_name	string	The account name of the recipient
account_number	string	The account number of the recipient
bank_name	string	The bank name of the recipient
bank_code	string	The bank code of the recipient
narration	string	The narration for the transfer
domain	string	The domain of the transfer
status	string	The status of the transfer
created_at	string	The date and time the transfer was created
updated_at	string	The date and time the transfer was last updated
first_page_url	string	URL of the first page
from	number	The starting record number
last_page	number	The last page number
last_page_url	string	URL of the last page
links	array	Pagination links
next_page_url	string	URL of the next page
path	string	Path of the current request
per_page	number	Number of records per page
prev_page_url	string	URL of the previous page
to	number	The ending record number
total	number	The total number of records

Use this endpoint to fetch a list of all transfers, allowing you to monitor and manage your transactions effectively.

Fetch Transfers By Status

The Fetch Transfers by Status endpoint allows you to retrieve transfers filtered by their current status (success, pending, or failed).

Endpoint

GET https://mainapi.cashonrails.com/api/v1/fetch_all_transfers/{status}

Request Headers

Header	Type	Description
Authorization	string	Bearer token with your secret key

Status Options

Status	Description
success	Completed transfers
pending	Transfers awaiting processing
failed	Failed transfer attempts

Sample Request

curl -X GET https://mainapi.cashonrails.com/api/v1/fetch_all_transfers/success \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_SECRET_KEY"

Sample Response

{
    "success": true,
    "status": "00",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 20,
                "trx": "2025011019031105106485",
                "reference": "COR-2025011019031105106485",
                "currency": "NGN",
                "amount": "100",
                "fee": "25",
                "account_name": "John Doe",
                "account_number": "0123456789",
                "bank_name": "SAFE HAVEN MICROFINANCE BANK",
                "bank_code": "999240",
                "narration": "Test",
                "status": "success",
                "created_at": "2025-01-10T18:03:12.000000Z",
                "updated_at": "2025-01-10T17:03:13.000000Z"
            }
            // ... more transfers with the specified status
        ],
        "first_page_url": "http://mainapi.stag.cashonrails.com/api/v1/fetch_all_transfers/success?page=1",
        "from": 1,
        "last_page": 1,
        "per_page": 50,
        "to": 17,
        "total": 17
    }
}

Response Fields

Field	Type	Description
success	boolean	Indicates if the request was successful
status	string	Status code of the request
data	object	Contains the transfer details
current_page	number	The current page number
data	array	List of filtered transfer objects

Get Transfer Fee Introduction