Skip to main content

List valid prepaid total balances

GET 
/valid-prepaid-total-balances

Returns a paginated list of prepaid total balances (shared wallets) that have active or blocked status.

Audit event

  • total.balance.prepaid.list

Privileges (one of the following based on the deployment type):

  • bulk-billing-cust-sms.view
  • bulk-billing-supplier-sms.view
  • bulk-billing-cust-mnp.view
  • bulk-billing-supplier-mnp.view
  • bulk-billing-cust-sms-own.view
  • bulk-billing-supplier-sms-own.view
  • bulk-billing-cust-mnp-own.view
  • bulk-billing-supplier-mnp-own.view

Filter/Sort fields

  • id
  • bizPartnerId
  • currency
  • name
  • status
  • alertsPolicyId
  • alertsBaseAmount
  • bizPartnerName
  • bizPartnerShortName
  • alertsPolicyName
  • paidTotal
  • unpaidTotal
  • billedTotal
  • overdraftLimit
  • debitBalanceThreshold
  • pricePackageMode
  • pricePackageId
  • overdraftPriceListId
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • alertsLanguage
  • amount
  • smsCount
  • accountsTotal
  • usage
  • availableAmount
  • totalCredit
  • isDefault

Searchable attributes

  • name
  • billingTypeName
  • bizPartnerShortName
  • bizPartnerName
  • status
  • alertsPolicyName
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • blockOnOutOfCredit
  • bizPartnerId
  • debitBalanceThreshold
  • overdraftLimit

Errors:

  • NOT_AUTHENTICATED - Not authenticated
  • NOT_AUTHORIZED - Not authorized
  • INT_APP_ERROR - Unexpected internal error

Request​

Responses​

OK — data contains active and blocked prepaid total balances with a fixed property set per row; meta.pagination describes the page.