v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

Get Account by ID

Use this API to get details of the specified account.

get/v1/accounts/{account_id}

Path parameters

account_idstring required

Unique identifier of the account for which details should be returned.<br><br>Example: va_onMda9dobg5YYX0kHLoaMecpy

Response

200

idstring

objectstring

typestring

used_asstring

bank_namestring

namestring

mobile_numberstring

emailstring

account_numberstring

ifsc_codestring

{"stackTrail":"paths:/v1/accounts/{account_id}:get:responses:200:content:application/json:schema:properties:vpa","oasType":"schema","type":"unknown"}

additional_vpaobject[]

whitelisted_remittersobject[]

whitelisted_beneficiariesobject[]

{"stackTrail":"paths:/v1/accounts/{account_id}:get:responses:200:content:application/json:schema:properties:kyc_url","oasType":"schema","type":"unknown"}

statusstring

created_atinteger

is_sandboxboolean

{"stackTrail":"paths:/v1/accounts/{account_id}:get:responses:200:content:application/json:schema:properties:settlement_account_id","oasType":"schema","type":"unknown"}

verified_beneficiariesobject[]

verified_remittersobject[]

Example response

{
  "id": "va_P1iM7c246KicyTNqfpK2LR3sy",
  "object": "account.virtual",
  "type": "virtual",
  "used_as": "collection_tool",
  "bank_name": "yes_bank",
  "name": "Lush Adobe",
  "mobile_number": "1252297492",
  "email": "john.doe@example.com",
  "account_number": "36363651456298373",
  "ifsc_code": "YESB0CMSNOC",
  "kyc": {
    "pan": "XXXXXX905H"
  },
  "customer": {
    "id": "cus_FJuVDmHIm3L5hdrrcKJr5DIeF",
    "mobile_number": "1252297492"
  },
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "status": "active",
  "created_at": 1757572978
}