Get Operation Status

The endpoint can be used to retrieve current status of any operation (not just payment) performed on the API. The endpoint receives operationID of the request performed earlier and returns its status.

Operation can have one of the following statuses:

• done
• initialized
• user_input_required
• failed

To read more about operation statuses, you can visit Operation Statuses

👍

Pre-Conditions

You have obtained user's permanent access token from Exchange Token endpoint.

To read more about authentication process and access token please refer to Authentication Documentation

Request

HTTP [POST]

https://api.dapi.com/v2/operation/get

Headers

Body Parameters

Parameter	Type	Description
appKey REQUIRED	String	App key generated at application creation.
appSecret REQUIRED	String	Private token generated at application creation.
operationID REQUIRED	String	Unique ID generated to identify a specific operation.

Request Example

JSON

{
	"appKey": "b61812ed5f27889fe3c14001137b35de438cd9baea0a5a3df58a92205dae84b7",
	"appSecret": "c29eea94b3ed3ddd48306f24077cc15f17d61be144ce532ecc29dd962d46223a",
	"operationID":"CBDUAEAD:f64e6f59-ead8-4074-9602-e978b50abb57"
}

Response

📘

Note

Your responses may differ from those listed below on a case-by-case basis.

Parameter	Type	Description
opInfo	OpInfo	An object containing the operation info.
status	String	Returns the status of the job. It can be one of following: - done - initialized - user_input_required - failed
success	Boolean	Returns true if request is successful and false for all else.

OpInfo Schema

Parameter	Type	Description
endDate	Date	The operation start date.
startDate	Date	The operation end date.
errorType	String	Descriptive error message only in case of failure
status	String	Returns the status of the job. It can be one of following: - done - initialized - user_input_required - failed
type	String	The API endpoint path that was called.
transferDetails	TransferDetails	Returns null if not a transfer operation.

Response Example

JSON

{
    "opInfo": {
        "endDate": "2023-08-25T14:26:21.577Z",
        "errorType": "",
        "startDate": "2023-08-25T14:26:21.229Z",
        "status": "done",
        "transferDetails": null,
        "type": "data/identity/get"
    },
    "status": "done",
    "success": true
}

Successful Request / Response

Successful Request

JSON

{
	"appKey": "b61812ed5f27889fe3c14001137b35de438cd9baea0a5a3df58a92205dae84b7",
	"appSecret": "c29eea94b3ed3ddd48306f24077cc15f17d61be144ce532ecc29dd962d46223a",
	"operationID":"CBDUAEAD:f64e6f59-ead8-4074-9602-e978b50abb57"
}

Successful Response

JSON

{
    "opInfo": {
        "endDate": "2023-08-25T14:26:21.577Z",
        "errorType": "",
        "startDate": "2023-08-25T14:26:21.229Z",
        "status": "done",
        "transferDetails": null,
        "type": "data/identity/get"
    },
    "status": "done",
    "success": true
}

Failed Request / Response - OperationID Not Provided

Failed Request - OperationID Not Provided

JSON

{
	"appKey": "b61812ed5f27889fe3c14001137b35de438cd9baea0a5a3df58a92205dae84b7",
	"appSecret": "c29eea94b3ed3ddd48306f24077cc15f17d61be144ce532ecc29dd962d46223a"
}

Failed Response - OperationID Not Provided

JSON

{
    "msg": "validation error on field 'operationID'. err: value must not be an empty string",
    "type": "INVALID_ARGS",
    "success": false,
    "status": "failed"
}

Failed Request / Response - Invalid OperationID Provided

Failed Request - Invalid OperationID Provided

JSON

{
	"appKey": "b61812ed5f27889fe3c14001137b35de438cd9baea0a5a3df58a92205dae84b7",
	"appSecret": "c29eea94b3ed3ddd48306f24077cc15f17d61be144ce532ecc29dd962d46223a",
  "operationID": "XXXXX:f64e6f59-ead8-4074-9602-e978b50abb571"
}

Failed Response - Invalid OperationID Provided

JSON

{
    "msg": "Operation not found",
    "type": "NOT_FOUND",
    "success": false,
    "status": "failed"
}

Failed Request / Response - Invalid JSON Body Provided

Request - Invalid JSON Body Provided

JSON

{
	"appKey": "b61812ed5f27889fe3c14001137b35de438cd9baea0a5a3df58a92205dae84b7",
	"appSecret": "c29eea94b3ed3ddd48306f24077cc15f17d61be144ce532ecc29dd962d46223a"
	"operationID":"CBDUAEAD:f64e6f59-ead8-4074-9602-e978b50abb57"
}

Response - Invalid JSON Body Provided

JSON

{
    "msg": "Invalid JSON request",
    "type": "BAD_REQUEST",
    "success": false,
    "status": "failed"
}

📘

Note

For more information and detailed breakdown of possible errors, please see Errors.