All successful responses are returned with HTTP Status code 204. In case of failure, API returns a JSON error response with the parameters that contain the failure reason.

Understanding Error Response🔗

The error response contains code, description, field, source, step, and reason parameters to understand and troubleshoot the error.

Let us take an example where a merchant tries to add new allowed payer accounts when the overall limit is exceeded.

 Sample Error Response
Copy{
   "error":{
      "code":"BAD_REQUEST_ERROR",
      "description":"Only 10 allowed payer accounts can be added",
      "field":"allowed_payers",
      "source":"business",
      "step":"virtual_account_edit",
      "reason":"allowed_payer_limit_exceeded",
      "metadata":{
         
      }
   }
}

Response Parameters🔗

error: object The error object.
code: string Type of the error.
description: string Description of the error.
field: string Name of the parameter in the API request that caused the error.
source: string The source where occurred. It is business in this example.
step: string The step where the error occurred.
reason: string The exact reason for the error.

Errors and Description🔗

The following section provides information about all the possible errors and their description.

Account Validation not Supported on VPA🔗

This error occurs when you try to add an allowed payer account on a virtual account with VPA added as a receiver (with or without a Bank account).

code: BAD_REQUEST_ERROR
description: Account validation is only applicable on bank account as a receiver type.
field: receivers
source: business
step: virtual_account_edit
reason: account_validation_not_supported_on_vpa

Allowed Payer Limit Exceeded🔗

This error occurs when you try to add new allowed payer accounts when the overall allowed_payers limit is exceeded. You can only add up to 10 allowed payer accounts.

code: BAD_REQUEST_ERROR
description: Only 10 allowed payer accounts can be added.
field: allowed_payers
source: business
step: virtual_account_edit
reason: allowed_payer_limit_exceeded

Bank Account Number Required🔗

This error occurs when you do not pass the bank account number in the request.

code: BAD_REQUEST_ERROR
description: The bank account.account number field is required when bank account is present.
field: allowed_payers
source: business
step: virtual_account_edit
reason: bank_account_number_required

IFSC Required🔗

This error occurs when you do not pass the IFSC in the request.

code: BAD_REQUEST_ERROR
description: The bank account.ifsc field is required when bank account is present.
field: allowed_payers
source: business
step: virtual_account_edit
reason: ifsc_required

Invalid IFSC🔗

This error occurs when you pass an incorrect IFSC in the request. An IFSC must be 11 characters.

code: BAD_REQUEST_ERROR
description: The ifsc must be 11 characters.
field: allowed_payers
source: business
step: virtual_account_edit
reason: invalid_ifsc

Duplicate Allowed Payer Details🔗

This error occurs when you try to add a duplicate allowed payers account with the same IFSC and account number that already exists.

code: BAD_REQUEST_ERROR
description: Payer detail already exist for virtual account.
field: allowed_payers
source: business
step: virtual_account_edit
reason: duplicate_allowed_payer