Dealers Merchant Onboarding API
Introduction
The Dealers Merchant Onboarding API streamlines the process of onboarding new merchants into your dealership network. By integrating this API into your systems, you can automate and expedite the merchant registration and verification process. Through a secure and efficient interface, the API allows you to collect necessary merchant information, perform background checks, and verify identities seamlessly. Simplify the journey for merchants looking to join your network while maintaining compliance and security standards. With the Dealers Merchant Onboarding API, enhance the efficiency and effectiveness of your dealership's expansion efforts.
Get List Of Business Types
Get List Of Countries & Counties
Get List Of Sub-Counties
Get List Industries & Sub-Industries Specifications
Get a Unique System Generated Bill Numbers
POST request
Individual onboarding Request Parameters
| Field | Type | Description | Example |
|---|---|---|---|
| merchant_code | String | A unique number assigned to an organization/merchant registered with ViewTech, through which payment is received (can be Paybill or Till number). | 2****9 |
| business_type_id | String | The type of business being onboarded. | Indivitual/sole propietor/ private liability |
| product_type | String | The type of payment option to be used for the business. | Till/ PayBill |
| country_id | String | The country the business being onboarded | 1 |
| subregion_id | String | The county being the business is being onboarded | 35 |
| sub_county_code | String | The sub county the business being onboarded | 130 |
| physical_address | String | The address of the business being onboarded | 300, Nairobi |
| director_name | String | The name of business owner. this is hown as full name as it appears on id on the frontend | John Doe |
| director_mobile_number | String | The mobile number of the business owner. this is shown as mobile number on frontend | 07******638 |
| director_id_number | String | The ID number of the business owner.shown as ID Number on frontend | 07******638 |
| nature_of_business | String | The type/nature of the business being onboarded. | Retail Shop |
| referral_code | String | The alias number of the referrer | 2***9 |
| industry_id | String | The type of industry the business being onboarded | 1 |
| sub_industry_id | String | The type of sub industry the business being onboarded | 1 |
| bill_number | String | This is the bill number/account number of the business for B2B/ B2C/C2B | 12***56 |
| estimated_monthly_transaction_amount | String | This is the estimated/expected transactions to done in a month | 123456 |
| estimated_monthly_transaction_count | String | This is the estimated number of transactions in a month. | 100 |
| purpose | String | The purpose of the business | Collection/Disbursement |
| business_reg_cert | File | The business registration certificate | pdf/img |
| director_id_front | File | The front ID of the business owner | img |
| director_id_back | File | The back ID of the business owner | img |
Request sample
Body:
{
"business_type_id": "11",
"product_type": "Till",
"country_id": "2",
"subregion_id": "35",
"sub_county_code": "190",
"physical_address": "300, Nairobi",
"director_name": "John Doe",
"director_mobile_number": "07*******1",
"director_id_number": "27*****56",
"nature_of_business": "Retail shop",
"industry_id": "62",
"sub_industry_id": "2",
"dealer_number": "1**9",
"bill_number": "5**5",
"referral_code":"3***9",
"estimated_monthly_transaction_amount": "10***0" ,
"estimated_monthly_transaction_count": "200",
"purpose": "Collection",
"business_reg_cert":"dd50f1b4-bd7f-402f-8855-27ac0959c6e4",
"director_id_front":"dd50f1b4-bd7f-402f-8855-27ac0959c6e4",
"director_id_back":"dd50f1b4-bd7f-402f-8855-27ac0959c6e4",
}
Private Liability Company/Patnership/sole propiator Request Parameters
| Field | Type | Description | Example |
|---|---|---|---|
| merchant_code | String | A unique number assigned to an organization/merchant registered with ViewTech, through which payment is received (can be Paybill or Till number). | 2****9 |
| business_type_id | Numeric | The type of business being onboarded. | Indivitual/sole propietor/ private liability |
| product_type | Numeric | The type of payment option to be used for the business. | Till/ PayBill |
| country_id | Numeric | The country the business being onboarded | 1 |
| subregion_id | Numeric | The county being the business is being onboarded | 35 |
| sub_county_code | Numeric | The sub county the business being onboarded | 130 |
| physical_address | AlphaNumeric | The address of the business being onboarded | 300, Nairobi |
| description | String | The description of the business being onboarded | business desc |
| AlphaNumeric | The email of the business being onboarded | m@g.net | |
| mobile_number | AlphaNumeric | The mobile number of the business being onboarded | 07******8 |
| registration_number | AlphaNumeric | The registration number of the business being onboarded | A234567 |
| kra_pin | AlphaNumeric | The kra pin number of the business being onboarded | A234****887R |
| director_name | String | The name of business owner. this is hown as full name as it appears on id on the frontend | John Doe |
| director_mobile_number | Numeric | The mobile number of the business owner. this is shown as mobile number on frontend | 07******638 |
| director_id_number | Numeric | The ID number of the business owner.shown as ID Number on frontend | 07******638 |
| nature_of_business | String | The type/nature of the business being onboarded. | Retail Shop |
| referral_code | Numeric | The alias number of the referrer | 2***9 |
| industry_id | Numeric | The type of industry the business being onboarded | 1 |
| sub_industry_id | Numeric | The type of sub industry the business being onboarded | 1 |
| bill_number | Numeric | This is the bill number/account number of the business for B2B/ B2C/C2B | 12***56 |
| estimated_monthly_transaction_amount | Numeric | This is the estimated/expected transactions to done in a month | 123456 |
| estimated_monthly_transaction_count | Numeric | This is the estimated number of transactions in a month. | 100 |
| purpose | string | The purpose of the business | Collection/Disbursement |
| business_reg_cert | Alphanumeric | The business registration certificate | pdf/img |
| cr_12 | Alphanumeric | This is the comapny registration certificate this field is nullable | pdf/img |
| board_resolution | Alphanumeric | The board resolution/agreement registration.this field is nullable | pdf/img |
| director_id_front | Alphanumeric | The front ID of the business owner | img |
| director_id_back | Alphanumeric | The back ID of the business owner | img |
| director_kra_pin_doc | Alphanumeric | The KRA PIN of the business owner | img |
| director_kra_pin | Alphanumeric | The kra pin number of the business owner | img |
Request sample
Body:
{
"product_type": "3",
"bill_number": "842745",
"description": "msn",
"country_id": 2,
"subregion_id": 28,
"sub_county_code": 147,
"sub_industry_id": 2,
"dealer_number": "2**6",
"industry_id": 62,
"purpose": "Disbursement",
"estimated_monthly_transaction_amount": 200000,
"business_type_id": 2,
"email": "m@g.net",
"registration_number": "A12345678J",
"kra_pin": "A12345768787R",
"board_resolution": "dd50f1b4-bd7f-402f-8855-27ac0959c6e4",
"business_reg_cert": "dd50f1b4-bd7f-402f-8855-27ac0959c6e4",
"nature_of_business": "retail",
"cr_12": "dd50f1b4-bd7f-402f-8855-27ac0959c6e4",
"referral_code": "3**5",
"director_name": "John Doe",
"mobile_number": "0712***78",
"director_id_number": 1234567888,
"director_id_front": "dd50f1b4-bd7f-402f-8855-27ac0959c6e4",
"director_id_back": "dd50f1b4-bd7f-402f-8855-27ac0959c6e4",
"director_kra_pin_doc": "dd50f1b4-bd7f-402f-8855-27ac0959c6e4",
"kra_pin_doc": "dd50f1b4-bd7f-402f-8855-27ac0959c6e4",
"director_kra_pin": "A23454444444444R",
"estimated_monthly_transaction_count": "90",
"physical_address": "00100 Nairobi",
"director_mobile_number": "0722****22"
}
Response Parameters
| Field | Type | Description | Example |
|---|---|---|---|
| status | Numeric | This is a numeric status code that indicates the status of the response. 0 means success and any other code means an error occurred or the request failed.Please refer to the response codes table above. | 0 |
| message | String | Your merchant onboarding has been received successfully and is awaiting approval |
Sample Response
{
"status": true,
"message": "Your merchant onboarding has been received successfully and is awaiting approval"
}
`