Transactions
Transactions
Transaction History

Transaction History API

Welcome to the documentation for the Transaction History API. This API allows users to retrieve transaction history for a specific account within a specified year.

Base URL

The base URL for this API is {baseURL}/v1/transaction/get_transaction_history.

Endpoint

  • Path: /:account_number
  • Method: GET

Authorization

Include the following Authorization header in your HTTP requests using a Bearer token:

Authorization: Bearer YOUR_ACCESS_TOKEN

Query Parameters

  • year: The year for which transaction history is to be fetched.
  • limit: (Optional) The maximum number of transactions to retrieve. Default is 10.
  • page: (Optional) The pagianation number Default is 1.

Sample Request

curl -X GET '{baseURL}/v1/transaction/get_transaction_history/:account_number?year=2024&limit=10&page=1' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'accept: application/json' \

Sample 200 Response

{
    "message": "Account history fetched successfully",
    "data": {
        "transfers": [
            {
                "transfer_request_id": "123f5aad-f72b-4db0-95d2-c5ca2ba49645",
                "account_id": "65c39cd78751f99773e06896",
                "narration": "string",
                "amount": "20000",
                "organization_id": "65b36ac83a9d4b54811bfc05",
                "transaction_reference": "J0LJ6S0SD8HD",
                "destination_bank_code": "056",
                "destination_account_name": "prince",
                "destination_account_type": "savings",
                "destination_bank_name": "GTB",
                "destination_account_number": "0354882788",
                "originating_account_number": "00510011011003213",
                "originating_account_name": "Jolaoso",
                "transfer_type": "inter",
                "provider_id": "64dfdf50c013a4fc3828678a",
                "session_id": "1234566",
                "provider_response_id": null,
                "transfer_status_id": null,
                "tsq_requery_count": 0,
                "transfer_request_decision_id": null,
                "mandate_rule_id": null,
                "status": "failed",
                "transfer_status": "failed",
                "created_at": "2024-02-20T07:27:14.450Z",
                "updated_at": "2024-02-20T07:27:15.362Z"
            }
        ],
        "meta": {
            "total": 3,
            "limit": 10,
            "page": 1
        }
    },
    "success": true
}
Transaction by IdTransaction Status