Business Model

FieldTypeDescriptionNullable
idIntegerA unique identifier of businessfalse
uidIntegerA unique Identifier for businessfalse
nameStringBusiness namefalse
currencyStringThree letters ISO currency code e.g NGNfalse
bvnStringUnique identity for verification in the Nigerian Banking Industrytrue
typeEnum(String)Type of business: 'corporate' or 'individual'false
streetaddressStringAddress of businesstrue
phonenumberStringValid business phone numberfalse
countryStringCountry where business is locatedtrue
stateStringState in country where business is locatedtrue
cityStringCity in state where business is locatedtrue
postcodeStringCode of numbers and letters part of a mailing address of businesstrue
statusEnum(String)Current KYC state of business: 'active', 'inactive', 'pending', 'processing', 'approved', 'resubmission_requested', 'declined', 'expired', 'abandoned', or 'review'false
activationCodeStringCode given to business upon activationtrue
activatedonDate(String)Date of activation of businesstrue
deactivatedonDate(String)Date of deactivation of businesstrue
reasondeactivatedStringReason for deactivation of businesstrue
acceptTermsBooleanStates whether Vendy's terms and conditions have been accepted by businesstrue
verifiedBooleanStates whether the business have completed KYC and can operate with Vendyfalse
verifiedonDate(String)Date of business verificationtrue
apikeyStringAPI keys for initiating transactions with Vendyfalse
secretStringSensitive key for API communication between Vendy and businessfalse
emailStringValid business email addressfalse
clientIdStringUnique id of clientfalse
metaJSONExtra data on businesstrue
hasWebhookBooleanStates if a business has webhook enabled or notfalse
feeDoubleStandard fee charge for business on transactionsfalse
commissionDoubleStandard commission gained by business on transactionsfalse
createdAtDate(String)Date of creation of businessfalse
updatedAtDate(String)Most recent date of update on businessfalse
deletedAtDate(String)Date of deletion of businesstrue
walletsArray[Wallet]Wallets created for and associated with business, may be omitted in a minified business model responsetrue
codeStringA 4 digit uniquely generated merchant code through which payments can be collectedtrue

Sample Business Model response

{
    "status": true,
    "code": 200,
    "msg": "Business",
    "data": {
        "id": 899,
        "uid": 1008,
        "name": "Joyce Stores",
        "currency": "ngn",
        "bvn": null,
        "type": "corporate",
        "streetaddress": null,
        "phonenumber": "2349090264861",
        "country": null,
        "state": null,
        "city": null,
        "postcode": null,
        "status": "pending",
        "activationCode": null,
        "activatedon": null,
        "deactivatedon": null,
        "reasondeactivated": null,
        "acceptTerms": true,
        "verified": false,
        "verifiedon": null,
        "apikey": "******",
        "secret": "************************************",
        "email": "[email protected]",
        "clientId": "9f600deb-8754-4837-bb76-012dcb7e8b0f",
        "meta": {
            "notification": {
                "transaction": {
                    "push": true,
                    "email": true
                }
            }
        },
				"code": "1232",
        "hasWebhook": false,
        "fee": 0.015,
        "commission": 0.001,
        "createdAt": "2023-04-04T15:23:04.000Z",
        "updatedAt": "2023-04-04T15:23:04.000Z",
        "deletedAt": null,
        "wallets": [
            {
                "id": 1687,
                "ownerid": 899,
                "uid": 1008,
                "businessId": 899,
                "balance": 0,
                "lockedBalance": 0,
                "meta": null,
                "pendingInflow": 0,
                "pendingWithdrawal": 0,
                "availableBalance": 0,
                "status": "active",
                "type": "balance",
                "currency": "ngn",
                "fee": 0.015,
                "createdAt": "2023-04-04T15:23:04.000Z",
                "updatedAt": "2023-04-04T15:23:04.000Z",
                "deletedAt": null
            },
            {
                "id": 1688,
                "ownerid": 899,
                "uid": 1008,
                "businessId": 899,
                "balance": 0,
                "lockedBalance": 0,
                "meta": null,
                "pendingInflow": 0,
                "pendingWithdrawal": 0,
                "availableBalance": 0,
                "status": "active",
                "type": "commission",
                "currency": "ngn",
                "fee": 0.001,
                "createdAt": "2023-04-04T15:23:04.000Z",
                "updatedAt": "2023-04-04T15:23:04.000Z",
                "deletedAt": null
            }
        ]
    }
}