Get Business

Getting all details of a particular business of a client or merchant using the business unique identifier

Request:

FieldTypeDescription
idIntegerUnique identifier of business

Example request

curl --location 'https://api.vendy.money/business/930' \
--header 'Authorization: Bearer <token>'

Response:

FieldTypeDescription
statusBooleanStates if request was successfully executed or not
codeIntegerInternal code, success if 200
dataBusinessNewly created business details

Example response

{
    "status": true,
    "code": 200,
    "msg": "Business",
    "data": {
        "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
            }
        ]
    }
}
Language
Authorization
Header
Click Try It! to start a request and see the response here!