Skip to main content
GET
https://api.fossapay.com
/
v1
/
virtual-accounts
/
{virtual_account_id}
Get Virtual Account
curl --request GET \
  --url https://api.fossapay.com/v1/virtual-accounts/{virtual_account_id}
{
  "status": "success",
  "data": {
    "virtual_account_id": "va_abc123xyz",
    "account_number": "1234567890",
    "account_name": "FOSSAPAY - JOHN DOE",
    "bank_name": "Wema Bank",
    "bank_code": "035",
    "type": "dedicated",
    "status": "active",
    "customer_name": "John Doe",
    "customer_email": "[email protected]",
    "total_received": 150000,
    "transaction_count": 3,
    "last_payment_at": "2024-01-15T14:30:00Z",
    "metadata": {
      "user_id": "12345"
    },
    "created_at": "2024-01-15T10:30:00Z"
  }
}

​
Path Parameters

​
virtual_account_id
string
required
The unique identifier of the virtual account

​
Request Example

curl https://api.fossapay.com/v1/virtual-accounts/va_abc123xyz \
  -H "Authorization: Bearer fp_live_sk_xxxxxxxx"

const account = await client.virtualAccounts.get('va_abc123xyz');

account = client.virtual_accounts.get('va_abc123xyz')

​
Response

​
status
string
Response status: success or error
​
data
object

​
Response Example

{
  "status": "success",
  "data": {
    "virtual_account_id": "va_abc123xyz",
    "account_number": "1234567890",
    "account_name": "FOSSAPAY - JOHN DOE",
    "bank_name": "Wema Bank",
    "bank_code": "035",
    "type": "dedicated",
    "status": "active",
    "customer_name": "John Doe",
    "customer_email": "[email protected]",
    "total_received": 150000,
    "transaction_count": 3,
    "last_payment_at": "2024-01-15T14:30:00Z",
    "metadata": {
      "user_id": "12345"
    },
    "created_at": "2024-01-15T10:30:00Z"
  }
}

​
Error Codes

CodeDescription
ACCOUNT_NOT_FOUNDVirtual account with this ID does not exist
UNAUTHORIZEDInvalid API key or insufficient permissions