ChapaChapa Docs

Get Virtual Account Credit History

Retrieve all credit transactions for a specific virtual account

This endpoint allows you to retrieve all credit transactions for a specific virtual account. The response is paginated, providing up to 25 transactions per page.

Endpoint: https://api.chapa.co/v1/virtual-account/history/credit/{account_number}
Method: GET
Authorization: Pass your secret key as a bearer token in the request header
Content-Type: application/json

Path Parameters

ParameterRequiredTypeDescription
account_numberYesstringThe virtual account number to fetch history for
cURL
PHP
Python

Successful Response

A successful request returns a list of credit transactions with pagination details:

{
  "status": "success",
  "message": "Virtual Account Credit History Fetched Successfully",
  "data": {
    "current_page": 1,
    "first_page_url": "https://api.chapa.co/v1/virtual-account/history/credit/100700352?page=1",
    "from": 1,
    "next_page_url": null,
    "path": "https://api.chapa.co/v1/virtual-account/history/credit/100700352",
    "per_page": 25,
    "prev_page_url": null,
    "to": 1,
    "transactions": [
      {
        "chapa_reference": null,
        "Merchant Reference": "VT8x1EwoPF",
        "type": "credit",
        "note": null,
        "amount": 10,
        "currency": "ETB",
        "created_at": "2025-02-17T19:54:47.000000Z",
        "updated_at": "2025-02-17T19:54:47.000000Z"
      }
    ]
  }
}

Response Parameters

ParameterTypeDescription
statusstringStatus of the request ("success" or "failed")
messagestringA message describing the result
data.current_pagenumberThe current page number
data.first_page_urlstringURL to the first page of results
data.fromnumberStarting index of records on current page
data.next_page_urlstring|nullURL to the next page (null if on last page)
data.pathstringBase path for pagination URLs
data.per_pagenumberNumber of records per page (default: 25)
data.prev_page_urlstring|nullURL to the previous page (null if on first page)
data.tonumberEnding index of records on current page
data.transactionsarrayList of transaction objects

Transaction Object Properties

PropertyTypeDescription
chapa_referencestring|nullChapa's reference for the transaction (can be null)
Merchant ReferencestringYour reference for the transaction
typestringType of transaction (e.g., "credit")
notestring|nullTransaction note or description (can be null)
amountnumberTransaction amount
currencystringTransaction currency (e.g., "ETB")
created_atstringTimestamp of transaction creation
updated_atstringTimestamp of last transaction update

Failed Response

{
  "message": "Invalid API Key",
  "status": "failed",
  "data": null
}

Refer to our Error Codes page for all responses for this request.

Pagination

The response includes pagination information to help you navigate through multiple pages of transactions. Use the next_page_url and prev_page_url fields to fetch additional pages.

Use Cases

  • Transaction Auditing: Review all credit transactions for an account
  • Reconciliation: Reconcile account deposits with your records
  • Reporting: Generate reports on account deposits
  • Customer Support: Help customers track their deposit history

Next Steps

On this page