m2pfintech
API LibraryWallet Management

Wallet Fetch Ledger Transactions

Retrieves wallet transaction history from the Ledger service for a given kit and wallet type. Returns detailed transaction records including amounts, statuses, error codes, and timestamps. Supports date range filtering and a flag to show only successful transactions. Transactions include types such as LOAD, OFFLINE_LOAD_CASH, SERVICE_CREATION, and others.

POST
/wallet/fetch/ledger/transaction

Authorization

tenantAuth
tenant<token>

The DCMS tenant name for multi-tenant isolation. Every API call must include this header to identify the client organization.

In: header

Header Parameters

tenant*string

The DCMS client or tenant name for multi-tenant isolation.

Request Body

application/json

kitNo*string

Unique kit number identifying the card whose wallet transactions are being queried.

entityId*string

Customer entity identifier who owns the wallet.

walletType*string

Type of wallet to query transactions for.

Value in"NCMC"
startDate?string

Start date for the transaction date range filter in DD-MM-YYYY format.

endDate?string

End date for the transaction date range filter in DD-MM-YYYY format.

isSuccessTransaction?boolean

When set to true, only returns successful transactions. When false or omitted, returns all transactions.

Response Body

application/json

curl -X POST "https://api.dcms.example.com/v1/wallet/fetch/ledger/transaction" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{    "kitNo": "4240210463",    "entityId": "875826",    "walletType": "NCMC",    "startDate": "01-10-2024",    "endDate": "11-10-2024",    "isSuccessTransaction": true  }'
{
  "result": {
    "entityId": "900007",
    "kitNo": "10000077",
    "ledgerOfflineStagedTransactionData": [
      {
        "accountNo": "2405030617682",
        "amount": "250.0",
        "convertedAmount": 0,
        "crDr": "C",
        "errorCode": "TX0057",
        "errorDescription": "balance greater than Maximum Balance",
        "kitNo": "10000077",
        "time": "2024-05-08T16:57:48",
        "transactionCurrencyCode": "356",
        "transactionStatus": "FAILED",
        "transactionType": "LOAD",
        "txnOrigin": "WEB"
      },
      {
        "accountNo": "2405030617682",
        "amount": "250.0",
        "convertedAmount": 0,
        "crDr": "C",
        "errorCode": null,
        "errorDescription": null,
        "kitNo": "10000077",
        "time": "2024-05-08T17:10:22",
        "transactionCurrencyCode": "0356",
        "transactionStatus": "SUCCESS",
        "transactionType": "OFFLINE_LOAD_CASH",
        "txnOrigin": "POS"
      }
    ]
  },
  "exception": null,
  "pagination": null
}

Fetch Wallet Balance POST

Retrieves the current wallet balance for a given kit and wallet type. Returns both the confirmed offline wallet balance and the staged offline wallet balance. The staged balance represents transactions that have been initiated but not yet fully confirmed.

Fetch Wallet Linked Services POST

Retrieves the list of services linked to the wallet for a given kit and wallet type. Services represent transit or payment networks that are enabled on the NCMC wallet such as metro systems, bus networks, or other mobility services.