Community

Integration Flow - Virtual Account used as Collection Tool

Learn how you can use ZWITCH to create a virtual account used as collection tool from your application.

Suggest Edits

Similar to wallets, collection tools come with their own account number, IFSC, and VPA handle. However, unlike wallets, collection tools do not have their own balance and cannot be used to make transfers.

Collection tools can only be used to receive payments. Money received by a collection tool does not remain in the collection tool. It is immediately transferred to your ZWITCH primary account or settlement account.

You can create a virtual account used as a collection tool using our Accounts API.

Endpoint

Use the below endpoint to create a virtual account used as a collection tool.

POST: https://api.zwitch.io/v1/accounts

Sample Code

Below is a sample request and response for the create a virtual account used as a collection tool API.

{
  "type": "virtual",
  "used_as": "collection_tool",
  "name": "Anil Reddy",
  "email": "[email protected]",
  "mobile_number": "9876543210",
  "create_vpa": true,
  "kyc": {
    "state_code": "KA",
    "city": "Bangalore",
    "pan": "ABCDE0000A",
    "pan_verification_id": null,
    "postal_code": 560010,
    "business_type": "partnership",
    "business_category": "garage_owners",
    "contact_person": null
  },
  "settlement_account_id": "va_UXjVUZdUuWpRezxRmuwQt4Vw0",
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  }
}

{
  "id": "va_5EXSkauOABl88CSkO5NATe0kW",
  "object": "account.virtual",
  "type": "virtual",
  "used_as": "collection_tool",
  "bank_name": "yes_bank",
  "name": "Anil Reddy",
  "mobile_number": "9876543210",
  "email": "[email protected]",
  "account_number": "36363651882499698",
  "ifsc_code": "YESB0CMSNOC",
  "vpa": "zwch868174809@yesbank",
  "additional_vpa": [],
  "whitelisted_remitters": [],
  "whitelisted_beneficiaries": [],
  "kyc": {
    "city": "Bangalore",
    "postal_code": "560010",
    "state_code": "KA",
    "pan": "XXXXXX000A",
    "pan_verification_id": null,
    "business_type": "partnership",
    "business_category": "garage_owners",
    "contact_person": null
  },
  "customer": {
    "id": "cus_LcrmvO6lPgElf7G3hFfIjWvNX",
    "mobile_number": "9876543210"
  },
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "status": "active",
  "created_at": 1681119294,
  "settlement_account_id": "va_UXjVUZdUuWpRezxRmuwQt4Vw0",
  "verified_remitters": null,
  "verified_beneficiaries": null,
  "is_sandbox": true
}

Refer to our Create Virtual Account used as Collection Tool API documentation for more details.

Custom VPA

We allow you to create a custom VPA handle for your Virtual Collection Tools.

Contact our Integrations Team to learn more.

📘

Note:

You can create a custom VPA handled when creating a virtual account or when adding additional VPA handles to a virtual account.

Updated 2 months ago