Unsubscribe API


Services API	Subscriptions API	Transactions API	Authentication	Unsubscribe API	Blacklist API

🚧
In order to unsubscribe user from Centili platform you must use HTTP POST method in application/json format, sent to the following URL with parameters described below.

URL to which request should be posted

https://api.centili.com/api/payment/1_4/unsubscribe

Example of POST request

URL: https://api.centili.com/api/payment/1_4/unsubscribe
Method: POST
Content type: application/json

{
    "subscriptionid":"3466xx",
    "apikey":"cd309e5822e5d5d5d5d5ecc6c8d6042c2a8b",
    "sign":"5d5ecc6c8d6042c2a8bf6t3g2a1d3b7m2v5673gf32"
}

Example of response

HTTP/1.1 200 OK
Content-Type: application/json
{
    "status": "ACCEPTED",
    "errorMessage": ""
}

All parameters which You can send in request, or get in response

Parameter	Request	Example of param value	Info
"apikey"	mandatory	f31a355df6dad07e49ba474db7ff9b07	Centili issued service key, unique for every payment service. Same as "serviceKey" in our other APIs
"sign"	mandatory	def0a0ba4f188cf174d383dc4d7f7041e358ba92	Signature parameter created using key issued for signing request. Please refer to the signature key generation guide.
"subscriptionid"	optional	1234567	Unique identifier of subscription in Centili system. If "subscriptionid" is used than "userid" parameter can be skipped.
"userid"	optional	usrId1983 NOTE: If the value is not set within payment request, this field will contain MSISDN of the particular customer.	Identification of the end user performing payment. By default it is msisdn of the end-user, but it can contain some other string which is meaningful to out merchants. If "userid" is used than "subscriptionid" parameter can be skipped.
"status"		ACCEPTED INVALID_REQUEST NOT_ACCEPTABLE SERVER_ERROR
"errorMessage"		null Bad request Mandatory parameters missing! ...

Possible server responses

Server response	Meaning	Possible Error messages
HTTP 202 Accepted	User has been successfully unsubscribed.
HTTP 400 invalid request	Unsubscribe request is invalid or cannot be resolved.	-Bad request -Mandatory parameters missing! -Signature validation failed! -Subscription does not exists. -Action is not supported
HTTP 406 Not Acceptable	Opt-out transaction already exists.	There is already an outgoing opt-out process for this user.
HTTP 500 Server error.	Some unexpected internal server error has occured.	Server error.

Example of response for bad request

{
    "status":"INVALID_REQUEST",
    "errorMessage":"Subscription does not exists."
}