Fetch Accounts by Balance

get

https://devapi.qolopay.com/api/{version}/accounts/program/{program_guid}

The end point allows fetching accounts sorted by balance. Up to 50 accounts can be fetched based on either ledger or available balance.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

program_guid

uuid

required

Unique identifier of the program, for the accounts being fetched.

version

string

required

Query Params

based_on

string

Defaults to ledger

Criteria to identify if the account must be fetched based on Ledger or Available balance.

sort_by

string

Defaults to desc

Criteria to identify if the accounts with highest balance or lowest balance is to be fetched. Default: desc (i.e.accounts with highest balances will be fetched)

count

int32

Defaults to 50

Number of accounts to be fetched.

include_negative_balances

boolean

Defaults to false

Whether accounts with negative balances are to be considered in the search.

account_status

string

enum

Status of accounts that is to be considered for the search.

Allowed:

refresh

boolean

Defaults to false

Specify whether to retrieve cached data or get updated values.

Responses

500

Server Error

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the Account details

400Bad request

401Unauthorized

404Account not found