get https://api.instantpay.in/contacts/business
Instantpay's List Business API gives firms a complete view of their business entities. This API lets you get a detailed list of all linked businesses. It provides insights into your business landscape. This helps with better decisions and strategic communication.
Integrating the List Business API lets organisations analyse and segment their business entities. This fosters a more targeted and personalised approach to relationship management. This is useful for firms wanting to improve their partnerships. It helps them optimise their strategy for greater impact.
Request Parameters
Name | Type | Requirement | Description |
---|---|---|---|
gcId | String | Mandatory | Contact Id(You will get from Add Contact Response) |
Sample Request
curl --location --request GET 'https://api.instantpay.in/contacts/business' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'Content-Type: application/json' \
--data '{
"gcId":"64466fd613d5c829a60e4cdf"
}'
GET /contacts/business HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json
Content-Length: 41
{
"gcId":"64466fd613d5c829a60e4cdf"
}
Response Parameter
Parameter Name | Type | Description |
---|---|---|
statuscode | String | Instantpay status code |
actcode | String | Action code |
status | String | Status message |
data | Array | Response data(if Present) |
timestamp | String | Response time (YYYY-MM-DD HH:II:SS) |
ipay_uuid | String | Request reference number |
orderid | String | Transaction Id ( If transaction otherwise it is null ) |
environment | String | Live/Sandbox |
{
"statuscode": "TXN",
"actcode": null,
"status": "Transaction Successful",
"data": [
{
"_id": "645390ff45c523e177063342",
"gcId": "645383ba4acec95a32089822",
"pan": "business",
"panVerified": true,
"cin": "L17110MH1973PLC019786",
"cinVerified": true,
"gstin": "",
"gstinVerified": true,
"tan": "",
"tanVerified": true,
"udyam": "",
"udyamVerified": true,
"updated_at": "2023-05-04T11:03:27.688000Z",
"created_at": "2023-05-04T11:03:27.688000Z"
}
],
"timestamp": "2023-05-04 16:35:46",
"ipay_uuid": "h006991603f2-12a3-4452-9614-139d45cb7586",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}