Search Wallets

get https://devapi.qolopay.com/api/{version}/wallets

Search for one or more wallets based on search criteria. This call returns several pieces of wallet related information including accounts and balances.

Responses

Response body

object

count

int32

required

Count of records matching the search criteria

start_index

int32

required

Start Index.

end_index

int32

required

End Index.

has_more

boolean

required

End Index.

data

array of objects

required

List of Records.

data*

object

wallet_guid

uuid

Unique identifier of the wallet on the platform.

wallet_id

string | null

Unique id of wallet

person_guid

uuid

Person Guid

program_guid

uuid

Program Guid

program_name

string | null

Program Name

program_short_name

string | null

Program Short Name

eft_display_name

string | null

Display Name

sponsor_name

string | null

Sponsor Name

parent_program_guid

uuid | null

Program Parent Guid

top_program_guid

uuid | null

Program Top Guid

company_dba_name

string | null

Company DBA Name

company_short_name

string | null

Company Short Name

account_status

string | null

Status of account.

wallet_created

date-time | null

Date wallet was created

wallet_name

string | null

wallet_name

accounts

array of objects | null

List of accounts and balance details

accounts

object

account_guid

uuid

Unique identifier of the account on the platform.

wallet_guid

uuid

Unique identifier of the wallet on the platform.

account_currency

string | null

Currency of account in ISO-3 string format.

account_name

string | null

Name of account provided by the API client.

account_type

string

Type of Account.
Program level accounts: PROGFUND, REVENUE, COLLECTION, PROG_DISBURSE, EXCEPTION, WRITEOFF, SUSPENSE
User accounts: GENERAL, PRINCIPAL, SECURE, CREDIT, ADVANCE, CHECK, USERDEFINED

GENERAL PROGFUND CHECK REVENUE COLLECTION PRINCIPAL SECURE CREDIT USERDEFINED ADVANCE PROG_DISBURSE EXCEPTION WRITEOFF SUSPENSE OMNI_OFFSET

available_balance

double

Open to buy balance (also called Available balance). This is the balance available for authorization or transaction.

ledger_balance

double

Ledger balance (also called Account balance). This include funds that are authorized, but not yet cleared.

suspense_balance

double

Balance that will be credited to the account after clearing.

advance_account_details

object

Additional details for ADVANCE type account

account_status

string

Account status code.

SYSTEM ACTIVE FREEZE CLOSED OPTOUT

last_txn_guid

uuid | null

Unique identifier for last posted transaction on the given account.

post_date

date-time | null

Last transaction posted date in UTC.

amount

double | null

Amount corresponding to the last posted transaction.

mask_account_number

string | null

Last four digits of account number

sys_utcinserted

date-time

status_change_nonmon_detail

object

cards

array of objects | null

List of cards

cards

object

card_number

string | null

Card number will be available only for PCI certified partners

card_proxy

string | null

Card proxy

mask_card_pan

string | null

Masked card number. Example - XXXXXXXXXXXX0007

wallet_guid

uuid

Unique ID of the wallet associated with the card.

wallet_id

string | null

ID of the wallet associated with the card

issuance_type

string

Type of card to be created

FULL - Reloadable plastic card
VIRTUALONETIME - Single load virtual card
VIRTUAL - Reloadable virtual card
ONETIMELOAD - Single load plastic card
VIRTUALTOKENALLOWED - Virtual card with tokenization allowed
TOKEN - Token
OTHER - Any other issuance type

FULL VIRTUALONETIME VIRTUAL VIRTUALTOKENALLOWED TOKEN ONETIMELOAD OTHER

base_iin

string | null

Base IIN associated to card

card_condition

string

ORIGINAL REISSUE REPLACE RENEW

card_status

string

ACTIVE SUSPEND LOST STOLEN CLOSED FCLOSED PENDING DAMAGED FORGET

activation_date

date-time | null

Card activation date

activation_method

string

ONLOAD ONISSUE HOLDER

expiration_date

string | null

Expiration date of the card in YYYY-MM-dd format

cvx2

string | null

Card's cvv/cvc value. This is only available for PCI certified API partners.

logical_expiration_date

date-time

Logical expiration date of the card

person_card_status

string

ACTIVE SUSPEND FORGET

card_tracking_detail

object

status_change_nonmon_detail

object

sys_utcinserted

date-time

sys_utcupdated

date-time

supplemental_details

object

memo_code

string | null

Memo Code.

account_instruments

array of objects | null

List of instruments associated with the

account_instruments

object

routing_number

string | null

For DDA types bank identification routing number

account_instrument_guid

uuid

Unique id of instrument associated with account

account_guid

uuid

Unique identifier of the account on the platform.

account_info

object

mask_account_number

string | null

Last four digits of account number

instrument_type

string

BANKDDA IBAN BBAN CARD CHECK

instrument_status

string

ACTIVE SUSPEND NEGLIST FORGET UNPROVED REPLACED

account_shared_persons

array of objects | null

List of account shares.

account_shared_persons

object

holder_person_guid

uuid

related_person_guid

uuid

holder_shared_account_guid

uuid

holder_wallet_guid

uuid

relationship

string | null

holder_share_status

string | null

system_share_status

string | null

check_statuses

array of strings | null

List of check statuses.

check_statuses

500

Server Error

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://devapi.qolopay.com/api/version/wallets \
3
     --header 'accept: application/json'

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

application/json

200Returns the Wallet details

400Bad request

401Unauthorized

404Wallet not found