Object

Shown below is a sample bharat_connect.business object for Register Business.

{
    "id": "bhb_k3pbaALyh1CmzTPTOToHywYey",
    "object": "bharat_connect.business",
    "b2b_id": "zwch_4234233551",
    "name": "Business Name",
    "mobile_number": "9876543210",
    "email": "[email protected]",
    "phone": "9888763451",
    "kyc": {
        "city": "Bangalore",
        "postal_code": "560005",
        "state_code": "KA",
        "pan": "ABCTY1239H",
        "company_name": "ZXC Tech",
        "contact_person": "Rahul Reddy",
        "mcc_code": "4112",
        "business_type": "partnership",
        "primary_business_identifier": {
            "type": "GST",
            "reference_number": "22AAAAA0000A1Y7",
            "registered_name": "ZXC Tech"
        },
        "other_business_identifiers": [
            {
                "type": "",
                "reference_number": "",
                "registered_name": ""
            }
        ],
	  "status":""
    },
    "documents": [
        {
            "type": "customer_photo",
            "id": "doc_69ec2a9d8dbaf5ea1bc"
        },
        {
            "id": "doc_Ix0xZ13phVqfcwwpvPmQi3122",
            "type": "shop_and_establishment_license",
            "reference_number": "910192182120",
            "date_of_issue": "2016-12-18"
        },
        {
            "type": "customer_signature",
            "id": "doc_9c4O9c5DJQ3lie3SADVAHWFDT"
        }
    ],
    "addresses": [
        {
            "type": "OTHER",
            "address": "sarjapur",
            "city": "Bengaluru",
            "postal_code": "560010",
            "state_code": "KA",
            "state": "KARNATAKA"
        }
    ],
    "bank_details": [
        {
            "vpa": "test@vpa",
            "account_type": "SAVINGS",
            "bank_account_number": "67334963307",
            "name_of_account_holder": "Rahul Reddy",
            "bank_ifsc_code": "SBIN0070305",
            "bank_name": "abcd"
        }
    ],
    "status":"ACTIVE",
    "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
    },
    "response": {
        "status": "", //get from bbps resp
        "message": ""
    }
}

The table below lists the various parameters in the bharat_connect.business object.

Parameters	Type	Description
id	`string`	Unique identifier of the business. Example: `bhb_k3pbaALyh1CmzTPTOToHywYey`
object	`string`	API object that is returned. Example: `bharat_connect.business`
b2b_id	`string`	B2B identifier for the business. Example: `zwch_4234233551`
name	`string`	Name of the business. Example: `Business Name`
mobile_number	`string`	Mobile number of the business. Example: `9876543210`
email	`string`	Email address of the business contact. Example: `[email protected]`
phone	`string`	Phone number of the business. Example: `9888763451`
kyc	`object`	KYC details of the business. Refer to the KYC object definition below.
documents	`array of objects`	List of documents associated with the business. Refer to the Documents object definition below.
addresses	`array of objects`	List of addresses associated with the business. Refer to the Addresses object definition below.
bank_details	`array of objects`	List of bank details associated with the business. Refer to the Bank Details object definition below.
status	`string`	Status of the business. Example: `ACTIVE`
metadata	`object`	Additional metadata. Example: `{ "key_1": "DD", "key_2": "XOF" }`
response	`object`	Response details. Refer to the Response object definition below.

[Child Object] KYC

The table below lists the various parameters in the kyc child object. This object is part of the bbharat_connect.business object.

Parameters	Type	Description
city	`string`	City of the business. Example: `Bangalore`
postal_code	`string`	Postal code of the business. Example: `560005`
state_code	`string`	State code of the business. Example: `KA`
pan	`string`	PAN number of the business. Example: `ABCTY1239H`
company_name	`string`	Registered name of the company. Example: `ZXC Tech`
contact_person	`string`	Primary contact person. Example: `Rahul Reddy`
mcc_code	`string`	Merchant Category Code. Example: `4112`
business_type	`string`	Type of business. Example: `partnership`
primary_business_identifier	`object`	Primary business identifier. Contains `type`, `reference_number`, and `registered_name`.
other_business_identifiers	`array of objects`	Other business identifiers. Each contains `type`, `reference_number`, and `registered_name`.
status	`string`	KYC status of the business.

[Child Object] Documents

The table below lists the various parameters in the documents child object. This object is part of the bbharat_connect.business object.

Parameters	Type	Description
type	`string`	Type of the document. Example: `customer_photo`
id	`string`	Document ID. Example: `doc_69ec2a9d8dbaf5ea1bc`
reference_number	`string`	Reference number (if applicable). Example: `910192182120`
date_of_issue	`string`	Date of issue (if applicable). Example: `2016-12-18`

[Child Object] Bank Details

The table below lists the various parameters in the bank_details child object. This object is part of the bbharat_connect.business object.

Parameters	Type	Description
vpa	`string`	Virtual Payment Address (VPA). Example: `test@vpa`
account_type	`string`	Type of bank account. Example: `SAVINGS`
bank_account_number	`string`	Bank account number. Example: `67334963307`
name_of_account_holder	`string`	Name of the account holder. Example: `Rahul Reddy`
bank_ifsc_code	`string`	IFSC code of the bank. Example: `SBIN0070305`
bank_name	`string`	Name of the bank. Example: `abcd`

[Child Object] Bank Details

The table below lists the various parameters in the response child object. This object is part of the bbharat_connect.business object.

Parameters	Type	Description
status	`string`	Status of the response from BBPS. Example: `SUCCESS` or `FAILURE`
message	`string`	Message returned in the response. Example: `Transaction successful`