API keys to help create business

How to create a business

You will be required to include the JWT token in a subsequent request to the API as part of the;

Authorization: Bearer <token> .

You must first create or register your business in order to sign up as a Vendy merchant. To get your business authenticated on Vendy, submit a "POST" request using this API;

📘

POST

https://api.vendy.money/business

Example request

curl --location --request POST 'https://api.vendy.money/business' \
--data-raw '{
    "name":"Business Name",
    "currency":"NGA",
    "email":"[email protected]"
}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "status": true,
  "code": 200,
  "msg": "Business created",
  "data": {
    "name": "Business Name",
    "currency": "NGA",
    "email": "[email protected]",
    "uid": 1,
    "businessname": "business",
    "status": "pending",
    "type": "business",
    "secret": "bcc12ce7d35340f684488736ad95c286b55e7db9c7e94107bfd42ad0d9944ee3",
    "apikey": "bc3062ea-0528-43a1-ae70-4e3af69b94bd"
  }
}

Where the business data is;

FieldTypeDescription
nameStringA valid business name
currencyString (NGN)Currency value
emailStringA valid business email
user idStringA unique identifier
business typeenumThe scale of business ( Individual, Small business, Enterprise)
phone numberStringA valid phone number
statusStringStatus while creating business
Secret
api

Possible Errors are;

Error codeDescription
400 (Bad request)Required fields were invalid and not specified.
Language
Authentication
Header
Click Try It! to start a request and see the response here!