get https://api.vendy.money/business
Endpoint to get all businesses of a client or merchant.
Example request
curl --location 'https://api.vendy.money/business' \
--header 'Authorization: Bearer <token>'
Response:
| Field | Type | Description |
|---|---|---|
| status | Boolean | States if request was successfully executed or not |
| code | Integer | Internal code, success if 200 |
| data | Array[Business] | List of businesses |
| verificationUrl | String | Url to complete KYC verification process |
Example response
{
"status": true,
"code": 200,
"msg": "Businesses",
"data": [
{
"id": 420,
"uid": 156,
"name": "Isre2 User",
"currency": "kes",
"bvn": null,
"type": "individual",
"streetaddress": null,
"phonenumber": "25456789887867",
"country": null,
"state": null,
"city": null,
"postcode": null,
"status": "active",
"activationCode": null,
"activatedon": null,
"deactivatedon": null,
"reasondeactivated": null,
"acceptTerms": null,
"verified": false,
"verifiedon": null,
"email": "[email protected]",
"clientId": "c572f1ba-f264-4a98-aafe-d0d22942fbb0",
"meta": {
"notification": {
"transaction": {
"push": true,
"email": true
}
}
},
"hasWebhook": true,
"fee": 0.015,
"commission": 0.001,
"createdAt": "2022-10-30T18:23:21.000Z",
"updatedAt": "2022-10-30T18:23:21.000Z",
"deletedAt": null,
"wallets": [
{
"id": 729,
"ownerid": 420,
"uid": 156,
"businessId": 420,
"balance": 0,
"lockedBalance": 0,
"meta": null,
"pendingInflow": 0,
"pendingWithdrawal": 0,
"availableBalance": 0,
"status": "active",
"type": "balance",
"currency": "kes",
"fee": 0.015,
"createdAt": "2022-10-30T18:23:21.000Z",
"updatedAt": "2022-10-30T18:23:21.000Z",
"deletedAt": null
},
{
"id": 730,
"ownerid": 420,
"uid": 156,
"businessId": 420,
"balance": 0,
"lockedBalance": 0,
"meta": null,
"pendingInflow": 0,
"pendingWithdrawal": 0,
"availableBalance": 0,
"status": "active",
"type": "commission",
"currency": "kes",
"fee": 0.001,
"createdAt": "2022-10-30T18:23:21.000Z",
"updatedAt": "2022-10-30T18:23:21.000Z",
"deletedAt": null
}
]
},
{
"id": 930,
"uid": 156,
"name": "Business Name",
"currency": "ngn",
"bvn": null,
"type": "individual",
"streetaddress": null,
"phonenumber": "08101851915",
"country": null,
"state": null,
"city": null,
"postcode": null,
"status": "pending",
"activationCode": null,
"activatedon": null,
"deactivatedon": null,
"reasondeactivated": null,
"acceptTerms": null,
"verified": false,
"verifiedon": null,
"email": "[email protected]",
"clientId": "c25d262a-d004-47b5-95c5-9d449f963241",
"meta": {
"notification": {
"transaction": {
"push": true,
"email": true
}
}
},
"hasWebhook": true,
"fee": 0.015,
"commission": 0.001,
"createdAt": "2023-06-23T00:14:45.000Z",
"updatedAt": "2023-06-23T00:14:45.000Z",
"deletedAt": null,
"wallets": [
{
"id": 1749,
"ownerid": 930,
"uid": 156,
"businessId": 930,
"balance": 0,
"lockedBalance": 0,
"meta": null,
"pendingInflow": 0,
"pendingWithdrawal": 0,
"availableBalance": 0,
"status": "active",
"type": "balance",
"currency": "ngn",
"fee": 0.015,
"createdAt": "2023-06-23T00:14:45.000Z",
"updatedAt": "2023-06-23T00:14:45.000Z",
"deletedAt": null
},
{
"id": 1750,
"ownerid": 930,
"uid": 156,
"businessId": 930,
"balance": 0,
"lockedBalance": 0,
"meta": null,
"pendingInflow": 0,
"pendingWithdrawal": 0,
"availableBalance": 0,
"status": "active",
"type": "commission",
"currency": "ngn",
"fee": 0.001,
"createdAt": "2023-06-23T00:14:45.000Z",
"updatedAt": "2023-06-23T00:14:45.000Z",
"deletedAt": null
}
],
"verificationUrl": "https://onboard-sandbox.aiprise.com/?verification_session_id=e282d4fa-8bf9-47f2-88bb-ca97b85e336b"
}
]
}