Skip to main content

Receive the patient scan pay order status

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.

POST/v3/patient/scan-pay/order-status

This is callback API for the order_status API. This API needs to implement by HIP to receive the request for payment status.

<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> queryStatus which contains the orderNumber and requestId[ Example: { orderNumber: 39413413 abhaAddress: <ABHA_ADDRESS> requestId: 059fcb69-8ad8-4789-a049-62db16c7b5a0 } ] </li> </ol> </ol>

Authorizations

Authorizationbearer tokenRequired

Headers

REQUEST-IDstringRequired

Unique UUID for track the end to end request transaction

TIMESTAMPstringRequired

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.

X-HIP-IDstringRequired

Identifier of the health information provider to which the request was intended

Body

queryStatusobjectRequired

The queryStatus is used to check the status of a specific order and its associated patient-share request.

queryStatus.orderNumberstringRequired

A unique identifier for the order. This helps in tracking and referencing the specific order associated with the query.

queryStatus.abhaAddressstringRequired

abha address of the user/patient.

queryStatus.openOrderRequestIdstringRequired

A unique identifier for the patient-share request. This ID is used to track and reference the specific request within the system.

Responses

200

OK

400

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.

Error codes for this module

401

Unauthorized. The request carried no valid credentials, or the access token has expired. Obtain a fresh token from the session API and retry.

Everything returns 401

403

Forbidden. The caller is authenticated but is not permitted to perform this operation on this resource.

Error codes for this module

500

Internal Server Error

Error codes for this module

503

Service Unavailable

Error codes for this module

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.