Fetch Accounts by Balance

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

SecurityBearer
Request
path Parameters
program_guid
required
string <uuid>

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

version
required
string
query Parameters
based_on
string
Default: "ledger"

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

sort_by
string
Default: "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
integer <int32>
Default: 50

Number of accounts to be fetched.

include_negative_balances
boolean
Default: false

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

account_status
string (AccountStatus)

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

Enum: "SYSTEM" "ACTIVE" "FREEZE" "CLOSED" "OPTOUT"
refresh
boolean
Default: false

Specify whether to retrieve cached data or get updated values.

Responses
200

Returns the Account details

400

Bad request

401

Unauthorized

404

Account not found

500

Server Error

get/api/{version}/accounts/program/{program_guid}
Request samples 
Response samples 
application/json
{
  • "cache_utcdate": "2019-08-24T14:15:22Z",
  • "count": 0,
  • "start_index": 0,
  • "end_index": 0,
  • "has_more": true,
  • "data": [
    • {
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
      • "account_currency": "string",
      • "account_name": "string",
      • "account_type": "GENERAL",
      • "available_balance": 0.1,
      • "ledger_balance": 0.1,
      • "suspense_balance": 0.1,
      • "account_status": "SYSTEM",
      • "person_info": {
        • "identifications": [
          • {
            • "govt_id_type": "NOTPROVIDED",
            • "govt_id_number": "string"
            }
          ],
        • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
        • "birth_date": "string",
        • "email": "string",
        • "first_name": "string",
        • "middle_name": "string",
        • "last_name": "string",
        • "additional_data": {
          • "property1": "string",
          • "property2": "string"
          },
        • "mobile_number": "string",
        • "home_number": "string",
        • "office_number": "string",
        • "base_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "mailing_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "billing_address": {
          • "city": "string",
          • "country": "str",
          • "address_line1": "string",
          • "address_line2": "string",
          • "postal_code": "string",
          • "state": "string"
          },
        • "nationality": "str",
        • "ip_address": "string",
        • "person_status": "INCOMPLETE",
        • "client_reference_id": "string",
        • "verfication_mode": "string",
        • "verfication_level": "string",
        • "person_forget_mode": "string",
        • "person_forget_mode_date": "string",
        • "market_notification_optin": "string",
        • "market_notification_optin_date": "string",
        • "address_lat": 0.1,
        • "address_lon": 0.1,
        • "contact_type": "string",
        • "profile_dd_mode": "string",
        • "request_code": "string",
        • "wallet_id": "string",
        • "title": "string",
        • "mask_govt_id_number": "string",
        • "comments": "string",
        • "jurisdiction_state": "string",
        • "jurisdiction_country": "str",
        • "beneficial_ownership": 100,
        • "person_relations": [
          • {
            • "holder_person_guid": "67b4ee47-03be-4fa4-8a21-68a2b2312803",
            • "related_person_guid": "ad395ead-8b71-46c4-b7c0-1c41ae432595",
            • "person_relationship": "string",
            • "sys_utcinserted": "2019-08-24T14:15:22Z",
            • "sys_utcupdated": "2019-08-24T14:15:22Z"
            }
          ],
        • "mask_account_number": "string",
        • "ledger_balance": 0.1,
        • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f"
        },
      • "account_instrument_info": {
        • "routing_number": "string",
        • "account_instrument_guid": "e5662964-577d-4724-b8d5-e791eee05564",
        • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
        • "account_info": {
          • "account_type": "DDA",
          • "account_number": "string",
          • "routing_number": "string",
          • "rtp_routing_number": "string",
          • "bank_identifier": "string",
          • "bank_dba": "string",
          • "bank_address": {
            • "city": "string",
            • "country": "str",
            • "address_line1": "string",
            • "address_line2": "string",
            • "postal_code": "string",
            • "state": "string"
            },
          • "swift_code": "string",
          • "bank_phone": "string",
          • "description": "string",
          • "name_on_account": "string",
          • "accountholder_address": {
            • "city": "string",
            • "country": "str",
            • "address_line1": "string",
            • "address_line2": "string",
            • "postal_code": "string",
            • "state": "string"
            },
          • "additional_data": {
            • "property1": "string",
            • "property2": "string"
            }
          },
        • "mask_account_number": "string",
        • "instrument_type": "BANKDDA",
        • "instrument_status": "ACTIVE"
        },
      • "last_txn_guid": "100ead98-12b5-4d05-9c0c-900006fc8694",
      • "post_date": "2019-08-24T14:15:22Z",
      • "amount": 0.1
      }
    ],
  • "check_statuses": [
    • "string"
    ]
}
Copyright © Qolo 2019-2023. All right reserved.