update virtual account/customer

Update a virtual account/customer to support multiple banks

Each customer you create is provisioned with a VFD MFB virtual account by default. In order to link other bank accounts to your customer, you must pass an array of desired bank codes to this endpoint. Available banks are:

1) Providus Bank (Code: 000023)

This endpoint will asynchronously process your request bank by bank and send a response payload to your custom web hook once each requested bank is successfully added to your customer. Presently, you may request to add this custom web hook to your account in any of the developer support groups. NOTE: This custom webhook is different from your primary webhook that is configured from your dashboard profile settings.

This endpoint is throttled to 1 request every 500 milliseconds.

Request

Method	URL
POST	{{baseUrl}}/api/service/v1/query/customer/otherbanks/virtualaccount/update

Header	Value
Content-Type	application/json
publicKey	{{publicKey}}
b-access-token	{{accessToken}}	Use the accessToken that was given in response to /api/service/v1/query/merchant/login

Request Body	Type	Description
vfdvirtualaccount	string	VFD account for the customer	Mandatory
banks	array	Array of bankcodes of the banks you want to update the customer with	Mandatory

Request Payload Sample

{
  "vfdvirtualaccount": "4600020122",
  "banks": [
    "000023"
  ]
}

Response Payload Sample

{
    "status": true,
    "message": "Processing virtual account update to this customer."
}

Webhook Success Notification: Payload Sample

{
  "status": "successful",
  "message": "Providus virtualaccount successfully added for this customer.",
  "data": {
    "_id": "6214f2c3764d690016021e10",
    "email": "[e-mail]",
    "contactfirstname": "A",
    "contactlastname": "Customer",
    "phone": "0000000000",
    "nuban": "4600019908",
    "virtualaccounts": [
      {
        "bank": "Providus Bank",
        "nuban": "9977578909"
      },
      {
        "bank": "VFD MICROFINANCE BANK",
        "nuban": "4620019908"
      }
    ],
    "timestamp": "2023-05-05T09:23:04.064Z"
  }
}

Webhook Failure Notification: Payload Sample

{
  "status": "failed",
  "message": "Bank is already assigned to this customer.",
  "data": {
    "timestamp": "2023-05-05T09:49:43.130Z"
  }
}