Qodex.ai

Prepay Balance Management

Number of APIs: 57

TMF API Reference: TMF654 - Prepay Balance Management

Final : 19.5 - June 2020

The Prepay Balance Management API enables consumers to manage the balance, recharge (top-up), transfer, reserve, unreserve, deduct and balance adjustments of a bucket. A bucket is understood in the context of this API to be an entity that keeps track of the balance available to use services. Every bucket will measure balance in different units, it can be monetary or non-monetary (e.g.: number of sms that are available, number of GB of data available, …)

Resources

  • Bucket
  • TopupBalance
  • AdjustBalance
  • TransferBalance
  • ReserveBalance
  • AccumulatedBalance
  • BalanceAction

Operations

  • Retrieve the balance information on a bucket for a given product (individual or aggregated).
  • Retrieve the list of balance-related operations performed over a given product
  • Retrieve information about all the top-up operations stored in the server filtered by some criteria.
  • Perform a new top up operation (recharge)
  • Retrieve detailed information about a top-up operation previously processed by the server.
  • Retrieve the current and historic status information about a top-up operation previously processed by the server.
  • Perform a new transfer operation
  • Retrieve information about all the transfer operations stored in the server filtered by some criteria
  • Retrieve detailed information about a transfer operation previously processed by the server
  • Retrieve the current and historic status information about a transfer operation previously processed by the server.
  • Retrieve information about all the adjustments stored in the server filtered by some criteria.
  • Perform a new adjustment operation
  • Retrieve detailed information about a balance adjustment operation previously processed by the server
  • Reserve a balance on a bucket.
  • Unreserve a balance on a bucket.
  • Retrieve aggregated (accumulative) balances for a bucket.

  1. reserve Balance - List or find ReserveBalance objects GET {{baseUrl}}/reserveBalance?fields=id voluptate&offset=6696224&limit=6696224

  2. balance Action - List or find BalanceAction objects GET {{baseUrl}}/balanceAction?fields=id voluptate&offset=6696224&limit=6696224

  3. reserve Balance - Creates a ReserveBalance POST {{baseUrl}}/reserveBalance

  4. topup Balance-{id} - Updates partially a TopupBalance PATCH {{baseUrl}}/topupBalance/:id

  5. accumulated Balance - List or find AccumulatedBalance objects GET {{baseUrl}}/accumulatedBalance?fields=id voluptate&offset=6696224&limit=6696224

  6. bucket-{id} - Retrieves a Bucket by ID GET {{baseUrl}}/bucket/:id?fields=id voluptate

  7. accumulated Balance - Retrieves a AccumulatedBalance by ID GET {{baseUrl}}/accumulatedBalance/:id?fields=id voluptate

  8. bucket-{id} - Deletes a Bucket DELETE {{baseUrl}}/bucket/:id

  9. transfer Balance-{id} - Deletes a TransferBalance DELETE {{baseUrl}}/transferBalance/:id

  10. adjust Balance-{id} - Deletes a AdjustBalance DELETE {{baseUrl}}/adjustBalance/:id