Skip to Content
TransactionsIntroduction

Transactions

The Transactions API allows you to retrieve, verify, and manage transaction information in your CashOnRails integration. You can fetch transactions by ID, reference, or get a list of all transactions.

Available Endpoints

  • Get All Transactions - Retrieve a list of all transactions
  • Get Transaction by ID - Fetch a specific transaction using its ID
  • Get Transaction by Reference - Retrieve a transaction using its reference number
  • Verify Transaction - Verify the status and details of a transaction

Response Structure

All transaction endpoints return a consistent response structure containing:

  • Transaction Data - Core transaction information including ID, amount, status, reference, and timestamps
  • Customer Information - Details about the customer who initiated the transaction
  • Log Information - Processing logs including time spent, attempts, and history
  • Fees - Transaction fees charged
  • Gateway Response - Response from the payment gateway (if applicable)

Transaction Statuses

Transactions can have the following statuses:

  • success - Transaction completed successfully
  • pending - Transaction is being processed
  • failed - Transaction failed to complete
  • abandoned - Transaction was started but not completed

Supported Channels

Transactions can be processed through various channels:

  • banktransfer - Bank transfer payments
  • card - Credit/debit card payments
  • ussd - USSD payments
  • mobile_money - Mobile money payments
Last updated on