Documentation

Wallet Management

Suggest Edits

This section covers the APIs for the wallet management features like blocking/unblocking wallet, Fetch & Update user profile, Link Debit/Credit Cards, Beneficiary management for wallet to account transfers and to set recurring payments to load wallet, if the wallet balance falls below the threshold.


Card Management

  • Call Payment Params API to get the configured route for card management
  • Use the Generate Hash API if the pgImplementation mode is SDK
  • Use the following to manage cards:
    • Create Card API
    • Fetch Card API
    • Delete Card API
  • Call Consent API in order to tokenise cards
  • Card Link API to link a debit/credit card
  • Fetch Payment Instruments API to fetch the payment instrument linked to the user account
  • Update Card Name API to update the Nick name of the card linked
  • Delink Card API to unlink the cards

Beneficiary Management

To enable bank transfers from wallet, the following API provides support to manage beneficiaries.

  • Create Beneficiary API to add a new beneficiary
  • Fetch Beneficiary API to fetch the list of beneficiaries

Auto top-up Management

The following API's helps to manage subscription to auto top up wallet if the wallet balance falls below the user defined threshold. A penny drop transaction is done to authenticate the user enabling for consuming this service.

  • Top-up Subscription Init API to initiate the subscription.
  • Top-up Subscription Confirm API to confirm the subscription. This api to be called after authenticating the penny drop transaction.
  • Fetch Top-up Subscription Status API to get status of the subscription can be fetched by using
  • Modify Top-up Subscription API to modify subscription.

Wallet Management:

The following API's to block/unblock the user's own wallet and to block/unblock other user's to initiate collect request.

  • Block Card API to block wallet initiated by the user
  • Unblock Card API to unblock wallet initiated by the user
  • Block Collect Request API to restrict collect request being received from a particular user
  • UnBlock Collect Request API to unblock a particular user in order to receive collect request
  • Blocked Users List API to view the list of blocked users

API Documentation: Comprehensive API documentation for the partners who want to integrate can be found below

https://apimanagement.readme.io/reference/post_wallet-lc-v2-link-api

Updated 4 months ago