Check the status of reports
Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.
This is an API is called by HIU to check the status of reports.
<ol type='1'> <li> <b>Header</b> <ol type='a'> <br/> <li>Authorisation will be provided by the gateway session API after the successful verification of client ID and Secret [ Example: Bearer <TOKEN> ]</li><li>REQUEST-ID unique UUID[ Example: 18235d89-cb13-479d-ad71-7a57d5f669a8 ]</li> <li>TIMESTAMP actual time of the requested was initiated[ Example: 2022-10-06T10:10:00.587Z ]</li> <li>X-HIP-ID [ Example: HIP ID ]</li> </ol> </li> <br/> <li> <b>Request Body</b> <ol type='a'><br/> <li>intent This is a key value pair which contains the purpose [ Example: type: OPEN_PAYMENT_ORDER ]</li> <li>metaData This is a key value pair which contains hipId and counterId[ Example: { hipId: IN3810000008 counterId:12123 } ]</li> <li>profile which contains user details</li> </ol> </ol> Unique UUID for track the end to end request transaction Actual time of the request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and milliseconds. Identifier of the health information provider to which the request was intended The intention of share API call A key-value pair carrying the location longitude and latitude. The service ID of the health information provider it describes the counterId. This should populated only for PAYMENT_SHARE The abha number of the patient. Should be only 14 digit The abha address of the patient. Should start with Alphanumeric . and _ in the middle and must be ending with @abdm or @sbx The name of the patient. Only alphabets. The gender of the patient One of The day of birth of the patient. Only allows numeric values between 1 abd 31 The month of birth of the patient. Only allows numeric values between 1 abd 12 The month of birth of the patient. Only allows numeric values and must be 4 digit ranging between 1900 and 2200 The address line The district and should only contain alphabets The state and should only contain alphabets Should be 5 digits and only contain numbers The mobile number of the patient. Must be 10 digit and contain only 0-9 OK Bad Request. The request could not be processed because it was malformed or failed validation - a missing mandatory field, a value in the wrong format, or a header that did not match the body. Unauthorized. The request carried no valid credentials, or the access token has expired. Obtain a fresh token from the session API and retry. Forbidden. The caller is authenticated but is not permitted to perform this operation on this resource.Authorizations
Authorizationbearer tokenRequiredHeaders
REQUEST-IDstringRequiredTIMESTAMPstringRequiredX-HIP-IDstringRequiredBody
intentstringRequiredmetaDataobjectRequiredmetaData.hipIdstringRequiredmetaData.counterIdnumberRequiredprofileobjectRequiredprofile.patientobjectRequiredprofile.patient.abhaNumberstringRequiredprofile.patient.abhaAddressstringRequiredprofile.patient.namestringRequiredprofile.patient.genderstringRequiredMFODprofile.patient.dayOfBirthstringprofile.patient.monthOfBirthstringprofile.patient.yearOfBirthstringRequiredprofile.patient.addressobjectRequiredprofile.patient.address.linestringRequiredprofile.patient.address.districtstringprofile.patient.address.statestringprofile.patient.address.pincodestringprofile.patient.phoneNumberstringResponses
200400401403
Where this fits
hiecm-scan-and-pay.yaml declares this callback at module level and names no call against it. Which call produces it is not documented, so this page does not say.