Skip to main content

Update version to the serviceId

This is used by the integrators to update the version for the particular service-ID.

PATCH/api/hiecm/gateway/v3/scanPay/updateVersion

<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-CM-ID [ Example: sbx]</li> </ol> </li> <br/> <li> <b>Request Body</b> <ol type='a'><br/> <li>recordShareEnabled It describes whether the record share is enabled or not.</li><li>scanPayEnabled It describes whether the scan pay is enabled or not.</li><li>scanPayVersion This is a key value pair which contains the version [ Example: type: v2 / v3]</li> <li>serviceId This is a key value pair which contains ServiceId[ Example: SERVICE_ID1,SERVICE_ID2 ]</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-CM-IDstringRequired

Suffix of the consent manager to which the request was intended

Body

recordShareEnabledbooleanRequired

It describes whether the record share is enabled or not.

scanPayEnabledbooleanRequired

It describes whether the scan pay is enabled or not.

scanPayVersionstringRequired

It describes the version.

serviceIdobject[]Required

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

Everything returns 401

403

Forbidden

Error codes for this module

500

Internal Server Error

Error codes for this module

503

Service Unavailable

Error codes for this module