Business

Business Model

Field	Type	Description	Nullable
id	Integer	A unique identifier of business	false
uid	Integer	A unique Identifier for business	false
name	String	Business name	false
currency	String	Three letters ISO currency code e.g NGN	false
bvn	String	Unique identity for verification in the Nigerian Banking Industry	true
type	Enum(String)	Type of business: 'corporate' or 'individual'	false
streetaddress	String	Address of business	true
phonenumber	String	Valid business phone number	false
country	String	Country where business is located	true
state	String	State in country where business is located	true
city	String	City in state where business is located	true
postcode	String	Code of numbers and letters part of a mailing address of business	true
status	Enum(String)	Current KYC state of business: 'active', 'inactive', 'pending', 'processing', 'approved', 'resubmission_requested', 'declined', 'expired', 'abandoned', or 'review'	false
activationCode	String	Code given to business upon activation	true
activatedon	Date(String)	Date of activation of business	true
deactivatedon	Date(String)	Date of deactivation of business	true
reasondeactivated	String	Reason for deactivation of business	true
acceptTerms	Boolean	States whether Vendy's terms and conditions have been accepted by business	true
verified	Boolean	States whether the business have completed KYC and can operate with Vendy	false
verifiedon	Date(String)	Date of business verification	true
apikey	String	API keys for initiating transactions with Vendy	false
secret	String	Sensitive key for API communication between Vendy and business	false
email	String	Valid business email address	false
clientId	String	Unique id of client	false
meta	JSON	Extra data on business	true
hasWebhook	Boolean	States if a business has webhook enabled or not	false
fee	Double	Standard fee charge for business on transactions	false
commission	Double	Standard commission gained by business on transactions	false
createdAt	Date(String)	Date of creation of business	false
updatedAt	Date(String)	Most recent date of update on business	false
deletedAt	Date(String)	Date of deletion of business	true
wallets	Array[Wallet]	Wallets created for and associated with business, may be omitted in a minified business model response	true
code	String	A 4 digit uniquely generated merchant code through which payments can be collected	true

Sample Business Model response

JSON

{
    "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
            }
        ]
    }
}