Boya Statement API

Boya Statement API (1.0.0)

API for retrieving business wallet balance and statements

Download OpenAPI description

statements.json

statements.yaml

Servers

Mock server

https://developer.boyahq.com/_mock/statements/

Boya API server

https://api.boyahq.com/v1/

Retrieve Business Balance

Request

Get main account balance

Headers

org_wallet_refinteger

wallet ref currency

Default 1

curl -i -X GET \
  https://developer.boyahq.com/_mock/statements/wallet/ \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -H 'org_wallet_ref: 1'

Responses

Successful response

Bodyapplication/json

docsArray of objects(StatementEntry)

totalinteger

limitstring

pagestring

pagesinteger

Response

application/json

{
  "docs": [
    { … }
  ],
  "total": 0,
  "limit": "string",
  "page": "string",
  "pages": 0
}

Retrieve Business Statements

Request

Get a paginated list of statement entries

Query

fromstring

from date yyyy-mm-dd

tostring

to date yyyy-mm-dd

pageinteger

Page number for pagination

Default 1

limitinteger

Number of items per page

Default 25

Headers

org_wallet_refinteger

wallet ref currency

Default 1

curl -i -X GET \
  'https://developer.boyahq.com/_mock/statements/wallet/all-in-one/{org_wallet_ref}?from=string&limit=25&page=1&to=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -H 'org_wallet_ref: 1'

Responses

Successful response

Bodyapplication/json

docsArray of objects(StatementEntry)

totalinteger

limitstring

pagestring

pagesinteger

Response

application/json

{
  "docs": [
    { … }
  ],
  "total": 0,
  "limit": "string",
  "page": "string",
  "pages": 0
}

Retrieve Account Topup History

Request

Get a paginated list of topup history

Path

accountNumberstring

wallet accountNumber

Default 1

Query

fromstring

from date yyyy-mm-dd

tostring

to date yyyy-mm-dd

pageinteger

Page number for pagination

Default 1

limitinteger

Number of items per page

Default 25

Headers

org_wallet_refinteger

wallet ref currency

Default 1

curl -i -X GET \
  'https://developer.boyahq.com/_mock/statements/wallet/topup-history/{accountNumber}/{org_wallet_ref}?from=string&limit=25&page=1&to=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -H 'org_wallet_ref: 1'

Responses

Successful response

Bodyapplication/json

availableBalancedouble

Total amount available in business wallets

allocatedAmountdouble

Total Amount allocated & Available in employee wallets

Response

application/json

{
  "availableBalance": null,
  "allocatedAmount": null
}