v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

Get All Accounts

Use this API to get details of all accounts created by you.

get/v1/accounts

Query parameters

results_per_pagestring

The number of results to be returned per API call. Use this with the start_before or start_after parameters for pagination. <ul><li>Default value 10.</li><li>Maximum value 100.</li></ul>Example: 15

start_beforestring

The account_id before which details should be returned. Use this with the results_per_page for pagination. Example: va_GtkNV8sHqmGBZUnv1iHpHm4M4

start_afterstring

The account_id after which details should be returned. Use this with the results_per_page for pagination. Example: va_GtkNV8sHqmGBZUnv1iHpHm4M4

from_datestring

Has to be used with to_date. The UNIX timestamp after which details should be returned. Use this with the results_per_page, start_after, and start_before for pagination. Example: 1651052818

to_datestring

Has to be used with from_date. The UNIX timestamp before which details should be returned. Use this with the results_per_page, start_after, and start_before for pagination. Example: 1651052818

typestring

Get a list of all accounts matching the entered type. Accepted values:<ul><li>virtual</li></ul>

emailstring

Get a list of all accounts matching the entered email. Example: anil.reddy@example.com

mobile_numberstring

Get a list of all accounts matching the entered mobile_number. Example: 9876543210

used_asstring

Can only be used with type set as virtual. Get a list of all accounts matching the entered used_as. Possible values:<ul><li>wallet</li><li>collection_tool</li><li>receivable</li><li>primary</li><li>verification</li></ul>

Response

200

objectstring

has_moreboolean

Example response

{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "va_iymvvuibd5WvciAKxIr1ChBwj",
      "object": "account.virtual",
      "type": "virtual",
      "used_as": "wallet",
      "bank_name": "yes_bank",
      "name": "Anil Reddy",
      "mobile_number": "9876543210",
      "email": "anil.reddy@example.com",
      "account_number": "3636365124906878",
      "ifsc_code": "YESB0CMSNOC",
      "kyc": {
        "city": "Bangalore",
        "postal_code": "560010",
        "state_code": "KA",
        "pan": "XXXXXX290L",
        "business_type": "partnership",
        "business_category": "garage_owners",
        "pan_verification_id": "pan_t2iX5hAWHxX3cdfG6E2VKC628"
      },
      "customer": {
        "id": "cus_OGOuL7NxzlUj27ECK6T6E0xCR",
        "mobile_number": "9876543210"
      },
      "metadata": {
        "order_id": "12345"
      },
      "status": "active",
      "created_at": 1707479900,
      "is_sandbox": true,
      "verified_beneficiaries": [
        {
          "account_verification_id": "accver_v3VdjmJChY7oK2mKC5MAWjIa5",
          "name_match_id": "nm_jj7rN3Drqmp2s4mX5qFwAmzOr"
        }
      ]
    }
  ]
}

All 36 operations