Skip to main content
POST
/
pg
/
vba
Create VBA
curl --request POST \
  --url https://api-pacb-uat.eximpe.com/pg/vba/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --header 'X-Merchant-ID: <api-key>' \
  --data '
{
  "remitter_lock_details": {
    "allowed_remitters": [
      {
        "account_number": "26291800001191",
        "ifsc": "YESB0000262"
      }
    ]
  },
  "amount_lock_details": {
    "min_amount": 1000,
    "max_amount": 5000
  }
}
'
{
  "success": true,
  "message": "VBA created successfully",
  "data": [
    {
      "virtual_account_id": "24586202",
      "vba_account_name": "Acme Imports",
      "vba_bank_code": "UTIB",
      "vba_account_number": "9461257424586202",
      "vba_ifsc": "UTIB0CCH274",
      "vba_status": "ACTIVE",
      "remitter_lock_details": {
        "allowed_remitters": [
          {
            "account_number": "1234567891",
            "ifsc": "SBIN0005943"
          }
        ]
      },
      "amount_lock_details": {
        "min_amount": 100,
        "max_amount": 10000
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.eximpe.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

​
X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

​
X-Merchant-ID
string
header
required

Merchant Identifier - The unique ID for the merchant account. This is required for PSP (Payment Service Provider) merchants who manage multiple merchant accounts. You can find merchant IDs in the Merchant Management section of the dashboard.

​
X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Body

application/json
​
remitter_lock_details
object

Optional. Omit to allow transfers from any remitter. When supplied, restricts the VBA to accept transfers only from the listed remitter accounts. Persisted on the VBA and echoed back on every read.

​
amount_lock_details
object

Optional. Omit to allow transfers of any amount. When supplied, restricts the VBA to accept transfers within the given range.

Response

VBA created successfully

​
success
boolean
Example:

true

​
message
string
Example:

"VBA created successfully"

​
data
object[]