Deactivate Terminal

Used to deactivate terminal.

HTTP POST

Environment	Endpoint
QA	https://onboarding-service.{instance}.qa.rubean.io/api/{acquirer}/{client}/deactivate/{terminalId}
PROD	https://onboarding-service.{instance}.phonepos.online/api/{acquirer}/{client}/deactivate/{terminalId}

Response

Successful response message

{
	"terminalId": "12345678",
	"status": {
		"result": "COMPLETE",
		"timestamp": "2022-03-01T13:00:00Z",
		"uuid": "9a1a37a2-b779-434a-a28b-de98ec692f59",
	}
}

Failed request due to a technical reason

{
	"terminalId": "12345678",
	"status": {
		"result": "FAILED",
		"timestamp": "2022-03-01T13:00:00Z",
		"uuid": "9a1a37a2-b779-434a-a28b-de98ec692f59",
        "description": "System error"
	}
}

A failed message due to a wrong provided terminalId

{
    "terminalId": "123456789",
    "status": {
        "result": "REJECTED",
        "timestamp": "2022-03-01T13:00:00Z",
        "uuid": "9a1a37a2-b779-434a-a28b-de98ec692f59",
        "description": "terminal.terminalId: must match \"^\\p{Alnum}{8}$\""
    }
}

Parameter	Fromat	Occurance	Description
terminalId	AN 8	M	Terminal id that is mirrored from the request
status	collection	M	This is a collection representing the result of the request consisting of a timestamp and a result description.
status.result	ENUM	M	Result code: COMPLETE: onboarding request finished without problems and terminal is ready to use. REJECTED: invalid request, e.g. terminalId format error FAILED: Internal system error FAILED_TO_COMPLETE: timeout exception
status.timestamp	YYYY-MM-DD’T’HH24:MM:SS:TimeZone	M	e.g. 2022-03-01T13:00:00Z
status.uuid	UUID	M	Request ID as generated by Rubean (ROS).
status.description	AN	O	In case of failure contains a more detailed failure explanation.