Cancelling a bundle

This method can be used for canceling a bundle due to various reasons, e.g. due to user churn or failed subscription renewal.

Every request should be secured using JWT authentication token provided in an Authorization: Bearer header containing JWT token using the following payload and also include a JWT-Request: true header for indicating the type of request.

The body_sha256 claim in the JWT header must be equal to the sha256 checksum of the request body.

Returns either 200 OK or error in case of refused operation. Cancellation result will be sent via an asynchronous termination callback to a previously configured backend URL.

Request URL: https://bundle-api.fortumo.io/bundle/cancel

Request parameters

Attribute Type Description Required
channel → code String Channel code. Attribute that specifies the channel (carrier) that your consumer is using for bundling. Mandatory
merchant_id String Value must equal to partner ID as provided by Fortumo. Mandatory
reason String Identifies the reason why bundle was terminated. Equals to one of the values described in Status and Error Codes page. Mandatory
bundle_id String Unique activated bundle id. Either bundle_id or msisdn parameter should be present in the request Optional
msisdn String Unique consumer identifier. Either msisdn or bundle_id parameter should be present in the request. NB! this will cancel all bundles for this consumer Optional
callback_url String Partner backend URL to be used for cancellation callbacks. Optional
1
2
3
4
5
6
7
8
9
10
{
    "body_sha256": "daa813eff0066298af3ec0b9b63b4514bd3bd1165ec0391165178abb1368f760",
    "iss": "d3ad608d0a1729727a3eb6bc0892b426",
    "exp": 1525437711,
    "iat": 1522845411,
    "nbf": 1522845211,
    "sub": "bundle",
    "aud": "Fortumo",
    "jti": "jwt-id"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
POST bundle/cancel HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiI2N...OL4LxCc4FA-OtAb_UD9M5M
Content-Type: application/json

{
    "channel": {
        "code": "telekom-fr"
    },
    "merchant_id": "sASd9829hdaoda0dasuasdas0d9u2djads",
    "bundle_id": "8ebd3885-7129-4e23-99c7-58e9741d3941:d3304123", 
    "msisdn": "132432093802",
    "reason": "customer_ineligible",
    "callback_url": "https://example.com/bundles/callbacks"
}
Either bundle_id or msisdn is required
Help us improve our Merchants Portal. Was this article helpful?