API Docs

Create Virtual Account used as Collection Wallet

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to virtual

Type of account to be created.

Accepted value:

  • virtual

string
required
Defaults to wallet

Type of virtual account to be created.

Accepted value:

  • wallet

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

To create a collection wallet, bank_name must be yes_bank.

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

Accepted value:

  • yes_bank

boolean
Defaults to false

Accepted values for virtual account used as a collection wallet:

  • true: Generate VPA, account number, and IFSC.
  • false (default): Generate account number and IFSC only.

string

On-demand feature for virtual account used as a collection wallet.

Prerequisites: create_vpa parameter must be true.

Custom VPA handle that you want to assign to the virtual account used as a collection wallet.

Contact our Integrations Team for more details.

kyc
object
required

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