ChapaChapa Docs

Get Virtual Account

Retrieve comprehensive details about a specific virtual account using its account number

Retrieve comprehensive details about a specific virtual account using its account number.

Endpoint: https://api.chapa.co/v1/virtual-account/{accountNumber}
Method: GET
Authorization: Pass your secret key as a bearer token in the request header to authorize this call.

Path Parameters

ParameterRequiredTypeDescription
accountNumberYesstringThe unique identifier of the virtual account to be retrieved
cURL
PHP
Python

Successful Response

{
  "status": "success",
  "message": "Virtual Account Fetched Successfully",
  "data": {
    "account_name": "SEMER NUR",
    "account_number": 100314252,
    "account_alias": "1234542",
    "balance": 20,
    "status": "active",
    "currency": "ETB",
    "created_at": "2025-02-21T08:06:54.000000Z",
    "updated_at": "2025-02-21T08:06:54.000000Z"
  }
}

Response Parameters

ParameterTypeDescription
statusstringStatus of the request (success/error)
messagestringResponse message
data.account_numbernumberUnique identifier of the virtual account
data.account_namestringName associated with the account
data.account_aliasstringCustom reference name for the account
data.balancenumberCurrent balance in the account
data.currencystringCurrency of the account (e.g., ETB)
data.statusstringCurrent status of the account (e.g., active)
data.created_atstringTimestamp of account creation
data.updated_atstringTimestamp of the most recent transaction

Failed Response

{
  "status": "error",
  "message": "Virtual Account Not Found",
  "errors": {
    "failure_reason": "Transaction failed."
  }
}

Refer to our Error Codes page for all responses for this request.

Use Cases

  • Balance Checking: Verify account balance before processing transactions
  • Account Verification: Confirm account exists and is active
  • Reconciliation: Retrieve account details for reconciliation purposes
  • Status Monitoring: Check account status and recent activity

Next Steps

On this page