Fetch Account by Number

Fetch Dedicated Account by Account Number

Get details of a dedicated virtual account using its account number.

Endpoint: GET https://api.budpay.com/api/v2/dedicated_account_number/:account_number

Parameters

This section details the header information required for fetching a dedicated account by its account number.

Field Name	Description
URL	`https://api.budpay.com/api/v2/dedicated_account_number/:account_number`
Method	`GET`
Authorization	`Bearer YOUR_SECRET_KEY` (Replace with your actual BudPay secret key)

Path Parameters

Parameter	Type	Required	Description
`account_number`	String	Yes	The NUBAN account number of the dedicated virtual account

Sample Request

curl https://api.budpay.com/api/v2/dedicated_account_number/1671149520 \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -X GET

Sample Response

{
  "status": true,
  "message": "Customer account retrieved",
  "data": {
    "transactions": [],
    "authorizations": [],
    "customer": {
      "first_name": "Pay",
      "last_name": "Bud",
      "email": "customer3@budpay.com",
      "phone": null,
      "customer_code": "CUS_sb7na27qeas7htr",
      "id": 6,
      "created_at": "2022-03-12T16:50:14.000000Z",
      "updated_at": "2022-02-09T13:32:31.000000Z"
    },
    "domain": "test",
    "dedicated_account": {
      "id": 50,
      "account_name": "Samji Ventures / Pay Bud",
      "account_number": "1671149520",
      "currency": "NGN",
      "status": "active",
      "created_at": "2022-03-12T15:50:20.000000Z",
      "updated_at": "2022-03-12T15:50:20.000000Z"
    },
    "provider": {
      "id": 1,
      "bank_code": "000017",
      "bank_name": "Wema Bank",
      "prefix": "802"
    },
    "assignment": "reserved"
  }
}

Try it out

Response Fields

Field	Description
`customer`	Customer details attached to the account
`dedicated_account`	Virtual account details (number, name, status)
`provider`	Bank providing the virtual account
`transactions`	Array of transactions on this account
`authorizations`	Array of saved payment authorizations
`domain`	Environment (`test` or `live`)
`assignment`	Account assignment type (e.g. `reserved`)

Fetch Virtual Account Details Overview