Business List By Filter

URL

The relevant endpoint and http method information where the merchant accounts are listed are given below.

HTTP Method	URL
POST	/v1/Account/BusinessListByFilter

Request Params

Params	Type	Mandatory
order_column	string	Yes
tenant_id	int	No
account_type_id	int	No
account_id	int	No
account_number	string	No
page_size	int	No
page_index	int	No
order_by	string	No
name	string	No
start_date	string	No
end_date	string	No
access_status_id	int	No
email	string	No
phone_number	string	No
country_code	string	No
kyc_level	int	No
is_account_locked	boolean	No
group_code	string	No

Response Params

Params	Type
status	int
code	string
message	string
payload	object
results	object
id	string
tenant_id	string
parent_business_account_id	string
name	string
account_number	string
business_type	int
alias	string
kyc_level	string
owner_user_id	string
contact_address_contact_first_name	string
contact_address_contact_last_name	string
contact_address_contact_email	string
contact_address_contact_phone	string
contact_address_address_line1	string
contact_address_address_line2	string
contact_address_zip_postal_code	string
contact_address_state_province_code	string
contact_address_country_code	string
tax_office	string
tax_number	string
access_level_status_id	int
created_date_utc	string
updated_date_utc	string
sector_id	string
group_code	string
page_index	int
last_row_index	int
page_count	int
page_size	int
row_count	int
order_column	string
order_by	string

REQUEST (POST) :

{
  "tanant_id": 0,
  "account_type_id": 0,
  "account_id": 0,
  "account_number": "",
  "page_size": 0,
  "page_index": 0,
  "order_column": "Id",
  "order_by": "desc",
  "name": "",
  "start_date": "",
  "end_date": "",
  "access_status_id": 0,
  "email": "",
  "phone_number": "",
  "group_code": " ",
  "is_account_locked": false
}

RESPONSE

{
    "status": 0,
    "code": null,
    "message": null,
    "payload": {
        "results": [
            {
                "id": "538673624553903957005",
                "tenant_id": "5",
                "parent_business_account_id": null,
                "name": "Orhan",
                "account_number": "72000784987982",
                "business_type": 1,
                "alias": "Orhan",
                "kyc_level": "Contracted",
                "owner_user_id": "5386750594799758349",
                "contact_address_contact_first_name": "Orhan",
                "contact_address_contact_last_name": "ARKIN",
                "contact_address_contact_email": "orhanyeni3@deneme.com",
                "contact_address_contact_phone": "5375983182",
                "contact_address_address_line1": "Çengeldere Mh. Cumhuriyet Cd.",
                "contact_address_address_line2": "No:350 Beykoz/İstanbul",
                "contact_address_zip_postal_code": "34714",
                "contact_address_state_province_code": "TR",
                "contact_address_country_code": "90",
                "tax_office": "Zeytinburnu VERGİ DAİRESİ",
                "tax_number": "3333333333",
                "access_level_status_id": 1,
                "created_date_utc": "2022-06-20T12:08:49.2633931Z",
                "updated_date_utc": null,
                "sector_id": null,
                "group_code": null
            }
        ],
        "page_index": 0,
        "last_row_index": 0,
        "page_count": 0,
        "page_size": 0,
        "row_count": 0,
        "order_column": null,
        "order_by": null
    }
}