Manage Account

🙌

Important Note

Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.

API Endpoints

This API allows you to manage/update an existing account for your consumers/businesses in real-time.

Body Params
string
required

Action type; can be update/deactivate

string
required

Account type; can be physical/ savings/ virtual, only virtual allowed as of now. Other supported types to be added in the subsequent iterations

string
required

The account number for which the details are to be updated

string
required

Customer name to be put against the account and linked with UPI-ID

boolean

Email address of the merchant for whom sub-merchant onboarding is to be done

string
required

Mobile of the entity

string

Physical address of the entity

int32
required

0/1 depending on the status of the customer/ merchant at your end. Please note that the onus of KYC lies on you

string
required

0/1 depending on the status of the KYC check requirement from our end (if used). Default value is 0

int32

Maximum transaction amount limit

string
required

Unique customer ID to be saved against the customer

string

Flag to enable/disable the virtual account for balance settlement.For VA's with disabled flag will not be included in balance settlement API

int32
Defaults to 0

Flag to indicate if UPI sub-merchant onboarding is required

string

Prefix to be added to the VPA created

string

PAN number of the merchant for whom sub-merchant onboarding is to be done

string

City of the merchant for whom sub-merchant onboarding is to be done

int32

State Code of the merchant for whom sub-merchant onboarding is to be done

int32

State Code of the merchant for whom sub-merchant onboarding is to be done

upi_onboarding_details
object

Mandatory when upi_onboarding is set to 1

Headers
string
required
string
required
string
required
string
required
Responses

Response body

Language