API Docs

Create Virtual Account used as Collection Tool

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

Use this API to create a virtual account used as a collection tool.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

Note:

Refer to our Wallets vs. Collection Tool documentation to understand the difference between a collection wallet and a collection tool.

Body Params
string
required
Defaults to virtual

Type of account to be created.

Accepted value:

  • virtual

string
required
Defaults to collection_tool

Type of virtual account to be created.

Accepted value:

  • collection_tool

string
required

Applicant's name.

Maximum 70 characters.

Example: Anil Reddy

Supported characters:

  • A-Z
  • a-z
  • 0-9
  • .
  • /
  • \
  • -
  • _
  • ,
  • (
  • )
  • '

string
required

Account holder's mobile number.

Has to be 10 digits.

Example: 9876543210

Supported characters:

  • 0-9

string
required

Account holder's email address.

Example: [email protected]

string

Bank where the virtual account used as a collection tool needs to be created.

Accepted value:

  • yes_bank

boolean
Defaults to false

Accepted values:

  • true: Create a VPA and bank account.
  • false (default): Create bank account only.

kyc
object

Mandatory if create_vpa is true.

JSON object to pass the account holder's KYC details.

metadata
object

Key-value pair that can be used to store additional information about the entity.

  • Each pair cannot exceed 256 characters.
  • Maximum 5 key-value pairs.
Example: "key_1": "DD”

Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago