Skip to main content

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

Alt test Endpoint: https://sandbox.sasapay.app/api/v1/accounts/business-types/

Get List Of Countries & Counties

Alt test Endpoint: https://sandbox.sasapay.app/api/v1/accounts/countries/

Get List Of Sub-Counties

Alt test Endpoint: https://sandbox.sasapay.app/api/v1/accounts/sub-counties/?county_id={county_id}

Get List Industries & Sub-Industries Specifications

Alt test Endpoint: https://sandbox.sasapay.app/api/v1/accounts/industries/

Get a Unique System Generated Bill Numbers

Alt test Endpoint: https://sandbox.sasapay.app/api/v1/accounts/available-bill-number/

POST request

Alt test Endpoint: https://sandbox.sasapay.app/api/v1/accounts/merchant-onboarding/

Individual onboarding Request Parameters

FieldTypeDescriptionExample
merchant_codeStringA 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_idStringThe type of business being onboarded.Indivitual/sole propietor/ private liability
product_typeStringThe type of payment option to be used for the business.Till/ PayBill
country_idStringThe country the business being onboarded1
subregion_idStringThe county being the business is being onboarded35
sub_county_codeStringThe sub county the business being onboarded130
physical_addressStringThe address of the business being onboarded300, Nairobi
director_nameStringThe name of business owner. this is hown as full name as it appears on id on the frontendJohn Doe
director_mobile_numberStringThe mobile number of the business owner. this is shown as mobile number on frontend07******638
director_id_numberStringThe ID number of the business owner.shown as ID Number on frontend07******638
nature_of_businessStringThe type/nature of the business being onboarded.Retail Shop
referral_codeStringThe alias number of the referrer2***9
industry_idStringThe type of industry the business being onboarded1
sub_industry_idStringThe type of sub industry the business being onboarded1
bill_numberStringThis is the bill number/account number of the business for B2B/ B2C/C2B12***56
estimated_monthly_transaction_amountStringThis is the estimated/expected transactions to done in a month123456
estimated_monthly_transaction_countStringThis is the estimated number of transactions in a month.100
purposeStringThe purpose of the businessCollection/Disbursement
business_reg_certFileThe business registration certificatepdf/img
director_id_frontFileThe front ID of the business ownerimg
director_id_backFileThe back ID of the business ownerimg
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

FieldTypeDescriptionExample
merchant_codeStringA 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_idNumericThe type of business being onboarded.Indivitual/sole propietor/ private liability
product_typeNumericThe type of payment option to be used for the business.Till/ PayBill
country_idNumericThe country the business being onboarded1
subregion_idNumericThe county being the business is being onboarded35
sub_county_codeNumericThe sub county the business being onboarded130
physical_addressAlphaNumericThe address of the business being onboarded300, Nairobi
descriptionStringThe description of the business being onboardedbusiness desc
emailAlphaNumericThe email of the business being onboardedm@g.net
mobile_numberAlphaNumericThe mobile number of the business being onboarded07******8
registration_numberAlphaNumericThe registration number of the business being onboardedA234567
kra_pinAlphaNumericThe kra pin number of the business being onboardedA234****887R
director_nameStringThe name of business owner. this is hown as full name as it appears on id on the frontendJohn Doe
director_mobile_numberNumericThe mobile number of the business owner. this is shown as mobile number on frontend07******638
director_id_numberNumericThe ID number of the business owner.shown as ID Number on frontend07******638
nature_of_businessStringThe type/nature of the business being onboarded.Retail Shop
referral_codeNumericThe alias number of the referrer2***9
industry_idNumericThe type of industry the business being onboarded1
sub_industry_idNumericThe type of sub industry the business being onboarded1
bill_numberNumericThis is the bill number/account number of the business for B2B/ B2C/C2B12***56
estimated_monthly_transaction_amountNumericThis is the estimated/expected transactions to done in a month123456
estimated_monthly_transaction_countNumericThis is the estimated number of transactions in a month.100
purposestringThe purpose of the businessCollection/Disbursement
business_reg_certAlphanumericThe business registration certificatepdf/img
cr_12AlphanumericThis is the comapny registration certificate this field is nullablepdf/img
board_resolutionAlphanumericThe board resolution/agreement registration.this field is nullablepdf/img
director_id_frontAlphanumericThe front ID of the business ownerimg
director_id_backAlphanumericThe back ID of the business ownerimg
director_kra_pin_docAlphanumericThe KRA PIN of the business ownerimg
director_kra_pinAlphanumericThe kra pin number of the business ownerimg
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

FieldTypeDescriptionExample
statusNumericThis 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
messageStringYour 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"
}

`