Get Corporate
Description: Retrieve all employee paying salaries on Corporate Pay
- Sample Request
- Sample Response
Request Parameters
Parameter | Type | Description | Required |
---|---|---|---|
businessName | String | Name of the business | No |
queryRef | String | Client specific unique transaction reference | Yes |
GET {base_url}/corporate?businessName=eTranzact&queryRef=POLARIS1234
curl `${base_url}/corporate?businessName=eTranzact&queryRef=POLARIS1234`
-H "Content-type: application/json"
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X GET
Response Parameters
Parameter | Type | Description | Required |
---|---|---|---|
message | String | Description of performed requested action | Yes |
status | Integer | HTTP status code | Yes |
error | String | Specific errors when request does not return a HTTP status of 201. | No |
queryRef | String | Client specific unique transaction reference | Yes |
data | Array of object | Response data. Contains details of corporate. | Yes |
businessName | String | Name of the business | Yes |
businessEmail | String | Email of the business | No |
businessPhone | String | Phone number associated to the business | No |
businessWebsite | String | Website of the business | No |
businessId | String | eTranzact corporate identifier | Yes |
GET {base_url}/corporate?businessName=eTranzact&queryRef=POLARIS1234
{
"status": 201,
"message": "Corporate users",
"queryRef ": "POLARIS1234",
"error": "",
"data": [
{
"businessName": "etz business",
"rcNumber": "82742",
"businessEmail": "biz@etz.com",
"businessPhone": "+2349087878787",
"businessWebsite": "www.etzbusiness.com",
"businessId": 363737834
}
]
}