Pincode
This API will give information of all the offices/stores located in an area based on pin code. We must pass pin code in request to get details of office name, region name and address details.
https://kraken.airpay.co.in/airpay/ms/baas/api/pincodeHeader
Section titled “Header”| Field | Type | Description |
|---|---|---|
| affiliate | Text | Will be provided by Airpay (required) |
| checksum | Text | $string = $param.self::$secret_key; sha256(<concate all values+SECRET KEY>); (required) |
| api-key | Text | Will be provided by airpay ( required) |
| processor-key | Text | Will be provided by airpay ( required) |
Parameter
Section titled “Parameter”| Field | Type | Description |
|---|---|---|
| pincode | Numeric | Pincode (length 6, required) |
Request-Example:
Section titled “Request-Example:”curl --location --request POST 'https://kraken.airpay.co.in/airpay/ms/baas/api/pincode' \--header 'api-key: 91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps' \--header 'affiliate: 91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps' \--header 'checksum: 91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps' \--header 'processor-key: 91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps' \--header 'Content-Type: application/x-www-form-urlencoded' \--data-urlencode 'pincode=612345'Success 200
Section titled “Success 200”| Field | Type | Description |
|---|---|---|
| status | Numeric | [400-fail,200- success](length 3) |
| message | text | [success, fail] |
| data | text | { “OFFICE_NAME”: “Arakinar S.O”,“REGION_NAME”: “balussery”, “DISTRICT_NAME”: “KOZHIKODE”,“STATE_NAME”: “KERALA”, “PINCODE”: “612345”, “TALUK”: “Kozhikode”, “LOCALITY_DETAIL_1”: “Arakinar”, “LOCALITY_DETAIL_2”: “NA”, “LOCALITY_DETAIL_3”: “PARAMBA” } |
Success-Response:
Section titled “Success-Response:”{ { "status": "200", "message": "success", "data": [ { "OFFICE_NAME": "Arakinar S.O", "REGION_NAME": "Balussery", "DISTRICT_NAME": "KOZHIKODE", "STATE_NAME": "KERALA", "PINCODE": "612345", "TALUK": "Kozhikode", "LOCALITY_DETAIL_1": "Arakinar", "LOCALITY_DETAIL_2": "NA", "LOCALITY_DETAIL_3": "balussery MAIN ROAD" }, { "OFFICE_NAME": "Arakinar S.O", "REGION_NAME": "balussery", "DISTRICT_NAME": "KOZHIKODE", "STATE_NAME": "KERALA", "PINCODE": "612345", "TALUK": "Kozhikode", "LOCALITY_DETAIL_1": "Arakinar", "LOCALITY_DETAIL_2": "NA", "LOCALITY_DETAIL_3": "CHULLIAN VALAPPU" }, { "OFFICE_NAME": "Arakinar S.O", "REGION_NAME": "balussery", "DISTRICT_NAME": "KOZHIKODE", "STATE_NAME": "KERALA", "PINCODE": "612345", "TALUK": "Kozhikode", "LOCALITY_DETAIL_1": "Arakinar", "LOCALITY_DETAIL_2": "NA", "LOCALITY_DETAIL_3": "PARAMBA" }
]}Error-Response:
Section titled “Error-Response:”{ "status": "400", "message": "Failed", "data": ""}