GET
/
accounts
/
{id}
curl --request GET \
  --url http://localhost:5001/accounts/{id}
{
  "account_id": "acc_463b25b8-7b24-4e8b-aa49-7844d9074019",
  "name": "Chijioke Adeola",
  "number": "294364850431",
  "bank_name": "Blnk Bank",
  "currency": "NGN",
  "created_at": "0001-01-01T00:00:00Z",
  "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0",
  "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db",
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "meta_data": {
    "reference": "XYZ123456789",
    "verified": true
  },
  "ledger": {
    "id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
    "name": "Customer wallets Ledger",
    "created_at": "2024-02-20T05:28:03.563132Z"
  },
  "balance": {
    "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0",
    "balance": 30300,
    "credit_balance": 30600,
    "debit_balance": 300,
    "currency": "NGN",
    "currency_multiplier": 1,
    "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
    "identity_id": "",
    "created_at": "2024-02-20T05:33:01.3116Z",
    "meta_data": null
  },
  "identity": {
    "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db",
    "identity_type": "individual",
    "organization_name": "",
    "category": "",
    "first_name": "Chijioke",
    "last_name": "Adeola",
    "other_names": "Emeka",
    "gender": "male",
    "dob": "1990-01-01T00:00:00Z",
    "email_address": "chijioke.adeola@gmail.com",
    "phone_number": "+2347012345678",
    "nationality": "Nigerian",
    "street": "10 Aso Villa Way",
    "country": "Nigeria",
    "state": "Lagos",
    "post_code": "101001",
    "city": "Lagos",
    "created_at": "2023-10-16T10:00:00Z",
    "meta_data": null
  }
}

Path Parameters

​
id
string
required
Example:

"acc_463b25b8-7b24-4e8b-aa49-7844d9074019"

Query Parameters

​
include
string
required
Example:

"identity"

Response

200 - application/json; charset=utf-8
OK
​
account_id
string
required
​
name
string
required
​
number
string
required
​
bank_name
string
required
​
currency
string
required
​
created_at
string
required
​
balance_id
string
required
​
identity_id
string
required
​
ledger_id
string
required
​
meta_data
object
required
Example:
{
  "verified": true,
  "reference": "XYZ123456789"
}
​
ledger
object
required
Example:
{
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "Customer wallets Ledger",
  "created_at": "2024-02-20T05:28:03.563132Z",
  "meta_data": { "project_owner": "Blnk Tech" }
}
​
balance
object
required
Example:
{
  "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0",
  "balance": 30300,
  "credit_balance": 30600,
  "debit_balance": 300,
  "currency": "NGN",
  "currency_multiplier": 1,
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "identity_id": "",
  "created_at": "2024-02-20T05:33:01.3116Z",
  "meta_data": null
}
​
identity
object
required
Example:
{
  "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db",
  "identity_type": "individual",
  "organization_name": "",
  "category": "",
  "first_name": "Chijioke",
  "last_name": "Adeola",
  "other_names": "Emeka",
  "gender": "male",
  "dob": "1990-01-01T00:00:00Z",
  "email_address": "chijioke.adeola@gmail.com",
  "phone_number": "+2347012345678",
  "nationality": "Nigerian",
  "street": "10 Aso Villa Way",
  "country": "Nigeria",
  "state": "Lagos",
  "post_code": "101001",
  "city": "Lagos",
  "created_at": "2023-10-16T10:00:00Z",
  "meta_data": null
}

Was this page helpful?

Suggest edits