Unlock

post

https://pos.uk.eagleeye.com/2.0/connect/account/unlock

This API endpoint allows the calling application to UNLOCK (Release a Lock) from LOCKED Wallet Account. Please note : This endpoint should be called in real-time only Only the same unit which locked an Account(s) will be able to UNLOCK it (or SETTLE) * Lock will be automatically released, if Locked Account will not be SETTLED nor UNLOCKED within defined expiry lock time-out

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

JSON Payload

accountId

string

required

EES AIR Account ID.

walletId

string

Wallet ID, if this optional attribute is provided EES AIR will perform an additional sanity check if requested accountId belongs to a specified Wallet.

string

Optional Token's PIN.

transactionDetails

object

Key-Value object, please note key name length should be less then 255 characters and key values should be less then 255 characters

location

object

Headers

Accept-Encoding

string

enum

Defaults to ''

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding Response header. Currently supported gzip and deflate. Please note if this request header is not present, no compression will be used.

Allowed:

Connection

string

enum

Defaults to close

This general HTTP header controls (or rather influences) whether the network connection stays open after the current request finishes. If the sent value is keep-alive, the connection should stay in a special state, allowing to be reused for subsequent requests to the same server. Please note these connections will be closed after reaching timeout threshold controlled by EES server (usually after 5 seconds).

Allowed:

X-EES-AUTH-CLIENT-ID

string

required

Client ID, provided by EES during on-boarding. Please note: the authentication mechanic requires the receipt of the full payload so any headers that would chunk the request up, such as transfer-encoding: chunked could potentially cause authentication failures.

X-EES-AUTH-HASH

string

required

Request Authentication Hash, calculated by concatenating Request URI Path with API prefix, Request Query String(s) if applicable, Request Payload if applicable and Client Secret. Please note: the authentication mechanic requires the receipt of the full payload so any headers that would chunk the request up, such as transfer-encoding: chunked could potentially cause authentication failures.

X-EES-TRANSACTION-ID

string

Optional Unique Reference for the API Request (Transaction) within the calling company

X-CUSTOM-SUBSYSTEM-ID

string

Optional header provided by the calling application for EES AIR to identify what was the external Subsystem ID / Name. Please note this header is not essential for AIR to process a Request, this header and its value will be intercepted by AIR and will show up in Wallet Event Notifications, if applicable.

X-CUSTOM-KEY

string

Optional header(s) provided by the calling application to EES AIR. Please note a) this header name has to follow pattern X-CUSTOM-* (i.e. X-CUSTOM-EMAIL) b) this header is not essential for AIR to process a Request, this header and its value will be intercepted by AIR and will show up in Wallet Event Notifications, if applicable.

Responses

Language

Credentials

Loading…

Response

Choose an example:

application/json

200EES AIR has successfully processed a Request

400EES AIR Refuse to process that particular Request as there is something wrong with the Request (e.g. missing Mandatory Request parameter or Mandatory Request Payload attribute is missing, Request payload is unprocessable, etc)

401EES AIR Refuse to process that particular Request due to Authentication error. This could be caused by missing mandatory AUTH header(s), invalid Hash calculation, invalid or inactive API Key used, etc.

403EES AIR Refuse to process that particular Request due to Request Authorization error(s). This indicates that used API Key has not got required permissions to perform this operation.

404EES AIR Refuse to process that particular Request as requested/referenced resource could not be found.

409EES AIR understands this request, but refuses to process it, due to present Conflict with the current state of the target resource or because performing this operation would lead to a Conflict within AIR.

415EES AIR is not able to understand that request due to not supported Content-Type value.

429EES AIR refuses to process that particular Request as Client's API Requests Limit was exceeded.

500EES AIR refuses to process that particular Request due to Unexpected Server Error.

503EES AIR refuses to process that particular Request due to Service(s) being Unavailable (i.e. Scheduled Maintenance)

504EES AIR refuses to process that particular Request due to Networking Issues