API Docs

Create VPA Beneficiary

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

Use this API to add a VPA beneficiary to an account.

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

Unique identifier of the account to which the beneficiary should be linked.

Example: va_Y6evcApKFXhQ9X7qKQ5AaysEI

Body Params
string
required
Defaults to vpa

Type of account details linked to the beneficiary.
Possible value:

  • vpa

string
required

Beneficiary's name.

Supported characters:

  • a-z
  • A-Z
  • 0-9
  • space
  • ’
  • -
  • _
  • /
  • (
  • )
  • .
  • &
  • #
  • $
  • @
Example: Anil Reddy

string

Beneficiary's email address.

Example: [email protected]

string

Beneficiary's phone number.

Example: 9876543210

string
required

Beneficiary's VPA handle.

Example: anil-reddy@example

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 over 1 year ago

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

Updated over 1 year ago

Did this page help you?