Fetch account

All top-ups made to the account will bear the reference on the top-up account. Webhook calls are also initiated to the specified callback URL (or the webhook URL specified on the merchant dashboard).

Retrieve a dedicated top-up account by its id.

get
Authorizations
Path parameters
idstringRequired
Responses
200
Success
application/json
get
GET /v1/merchant-dedicated-accounts/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Success

{
  "status": "success",
  "message": "text",
  "data": {
    "id": "text",
    "is_live": true,
    "account_reference": "text",
    "gateway_code": "text",
    "callback_url": "text",
    "account_name": "text",
    "account_number": "text",
    "country": "text",
    "bank_code": "text",
    "bank_name": "text",
    "currency": "text",
    "bvn": "text",
    "metadata": "text",
    "created_at": "2025-06-27T00:48:19.644Z",
    "edited_at": "2025-06-27T00:48:19.644Z",
    "wallet_account_tag": "text",
    "wallet_account_tag_description": "text",
    "wallet_account_tag_metadata": "text"
  },
  "meta": {},
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}

Retrieve a dedicated top-up account using its reference.

get
Authorizations
Path parameters
account_refstringRequired
Responses
200
Success
application/json
get
GET /v1/merchant-dedicated-accounts/reference/{account_ref} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Success

{
  "status": "success",
  "message": "text",
  "data": {
    "id": "text",
    "is_live": true,
    "account_reference": "text",
    "gateway_code": "text",
    "callback_url": "text",
    "account_name": "text",
    "account_number": "text",
    "country": "text",
    "bank_code": "text",
    "bank_name": "text",
    "currency": "text",
    "bvn": "text",
    "metadata": "text",
    "created_at": "2025-06-27T00:48:19.644Z",
    "edited_at": "2025-06-27T00:48:19.644Z",
    "wallet_account_tag": "text",
    "wallet_account_tag_description": "text",
    "wallet_account_tag_metadata": "text"
  },
  "meta": {},
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}

Last updated