Sign in

v1

latestOpenAPI 3.1.02026-07-2656258207.2 KB
Virtual-Accounts

Update a virtual account

Update a virtual account

put/virtual-accounts/{id}

Path parameters

idstring required

ID of the virtual account.

Example:va_EFAHCzELJb

Headers

X-Trace-Idstring

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

X-Scenario-Keystring

An optional scenario key that can be used to simulate specific behaviors or test different scenarios within the API. Providing this header allows you to trigger predefined responses or alter data based on the key's value, which can be useful for testing, development, or demonstrating specific functionalities. The key should be a string of 1 to 1000 characters.

Request body

action_type'update_bvn' | 'update_status' required

The supported virtual account update actions.

status'inactive'

The status of the virtual account.

bvnstring

This is the customer's Bank Verification Number.

metaMeta

Example request

{
  "action_type": "update_bvn",
  "status": "inactive",
  "bvn": "12345678912"
}

Response

OK

status'success' | 'failed'
messagestring

Example response

{
  "data": {
    "amount": 1000,
    "account_number": "7824822527",
    "reference": "htuy68787hvhyff454",
    "account_bank_name": "WEMA BANK",
    "account_type": "static",
    "account_expiration_datetime": "2025-12-03T13:54:21.546559974Z",
    "note": "Please make a bank transfer to James Burgers",
    "customer_id": "cus_J0PvwvJB2n",
    "created_datetime": "2024-12-03T13:54:21.546559974Z",
    "customer_reference": "AEGP2345",
    "currency": "NGN",
    "narration": "James Burgers"
  }
}