10. Tariff

This page contains all documentation under this Postman category.

Additional usage notes

ratezoneId should be sourced via GET Ratezone.
serviceProfileId should be sourced via GET Service Profile.
tariffId should be sourced via GET Tariff or from the Create Tariff response.
Tariffs define pricing rules for services and are linked to Ratezones.
Tariffs are later attached to Plans.
Before deleting a Tariff, check Plan usage with GET Query Rate Plan.

Tariff - Create

Path: Tariff / Tariff - Create

Method: POST

URL: https://sft.bics.com/api/CreateTariff

Description

This API will be used to Create Tariff.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
requestParam	M	Object of Tariff Details

Input requestParam Parameters

Field	Optional/ Mandatory	Description
tariffDetails	M	Object Tariff Details

Input tariffDetails Parameters

Field	Optional/Mandatory	Description
name	M	Tariff Name
serviceId	M	Service Id <br>2 - SMS_MO <br>3 - SMS_MT <br>4 - DATA <br>5 - NB-IOT
currencyId	CM	Currency Id, for enterprise this field is not required and will fetch from parent currency
ratingGroup	CM	Rating Group Id, For data tariff, For NBIOT tariff,RatingGroup is mandatory <br>3 – RG-Redirect <br>5 – Default
ppu	M	Price per unit and this would be used while charging. Ex. If we have given pulse 1 and unit type MB and Price Per Unit 2 then for 1MB 2euro would be charged <br> <br>This field is applicable for price against originating rate zone criteria.
pulse	M	Pulse. Pulse and unit type is coupled with each other. Ex. If we have given Pulse as 1 and unit type is MB, then charging will be 1MB pulse <br> <br>In case of SMS tariff scenario, pulse value must be 1. If pulse is set to another value in the API request, platform will still set it to 1
unitType	M	Unit Type (COUNT for MT-SMS & MO-SMS and MB or KB for Data)
rateZone	CM	Rate Zone Id - For multiple rate zones, values should be pipe separated For data and nbiot it is mandatory
p2pOffnetSms	CM	- true / false <br>false: P2P OFF-NET SMS is Not allowed <br>true: P2P OFF-NET SMS is allowed and ppuDestCriteria must be provided <br> <br>- This field becomes mandatory only for P2P SMS Tariff Creation, and valid only if serviceId = 2 (SMS-MO) and rate zone is provided. <br>- If not provided, default value is False <br>- This flag must be set to true in order to set a price in ppuDestCriteria.
ppuDestCriteria	CM	This field is only applicable for SMS scenarios and related to additional price when SMS is sent to external B-Party subscribers. <br> <br>ppuDestCriteria i.e. pulse per unit destination is price per SMS for offnet scenarios. Ex. this price is applicable for offnet SMS on top of ppu set in earlier fields. Hence totatl price for offnet SMS = ppu + ppuDestCriteria <br> <br>ppuDest i.e. pulse per unit against destination criteria. This is mandatory when "p2pOffnetSms" is true.
minSessionFee	O	Minimum Session Fee, applicable only for serviceId=4(Data) in Enterprise level <br>NOTE: minSessionFee is not available for NB-IOT service

Output

Output Parameters

Field	Optional/ Mandatory	Description
Response	M	Object of response details

Output Response Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Result code <br>0 – Success <br>1 – Failure
responseId	M	Response Transaction ID
responseTimestamp	M	Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss
resultParam	M	Object of transaction result
tariffId	O	Tariff Id

Output resultParam Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Result Codes

Result Codes	Description	Next Steps
7013	Create tariff success
7014	Create tariff failure
10239	Operation has failure. Request has been received and it has failed. Please verify the request has been completed successfully or not.
10240	Operation has Time out. Request has been received and it has timeout. Please verify the request has been completed successfully or not.

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{  
   "Request":{  
      "requestParam":{  
         "tariffDetails":{  
            "serviceId":"4",
            "currencyId":"44",
            "name":"NewTariffSMS_MO",
            "ppu":"10",
            "pulse":"10",
            "unitType":"COUNT",
            "rateZone":"5211|5213"
         }
      }
   }
}

Response Examples

Create Tariff - Failure

JSON

{
    "Response": {
        "responseId": "10147764526003929674",
        "responseTimestamp": "26/05/2020 01:59:44",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "7014",
            "resultDescription": "Create tariff failure"
        }
    }
}

Create Tariff - Success - {SMS-MO} — 200 — OK

JSON

{
    "Response": {
        "responseId": "46616946948486278",
        "responseTimestamp": "2020-05-12 19:13:25",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "7013",
            "resultDescription": "Create tariff success"
        },
        "tariffId": "12731"
    }
}

Create Tariff - Success - {Data} — 200 — OK

JSON

{
    "Response": {
        "responseId": "46616822374131111",
        "responseTimestamp": "2020-05-12 19:11:20",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "7013",
            "resultDescription": "Create tariff success"
        },
        "tariffId": "12730"
    }
}

Create Tariff - Success - {SMS-MT} — 200 — OK

JSON

{
    "Response": {
        "responseId": "46616998320718123",
        "responseTimestamp": "2020-05-12 19:14:16",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "7013",
            "resultDescription": "Create tariff success"
        },
        "tariffId": "12732"
    }
}

Create Tariff - Sucess - {NB-IOT}

JSON

{
    "Response": {
        "responseId": "46616822374131111",
        "responseTimestamp": "2021-05-12 19:11:20",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "7013",
            "resultDescription": "Create tariff success"
        },
        "tariffId": "12830"
    }
}

Tariff

Path: Tariff / Tariff

Method: GET

URL: https://sft.bics.com/api/GetTariff

Description

This API will be used to fetch the tariff details.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes

Output

Output Parameters

Field	Optional/ Mandatory	Description
Response	M	Object of response details

Output Response Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Result code <br>0 – Success <br>1 – Failure
responseId	M	Response Transaction ID
responseTimestamp	M	Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss
resultParam	M	Object of transaction result
responseParam	O	Object of the Tariff Details

Output resultParam Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Output responseParam Parameters

Field	Optional/Mandatory	Description
tariffList	O	Object of the Tariff

Output tariffList Parameters

Field	Optional/ Mandatory	Description
name	O	Tariff Name
Id	O	ID assigned / configured in the system against each Tariff (This will be an auto increment value)
serviceId	O	Service Id <br>2 – SMS-MO <br>3 – SMS-MT <br>4 - Data <br>5 -NB-IOT
serviceIdName	O	Service Name
currencyId	O	Currency Id
rateZone	O	Rate Zone Id
ppu	O	Price per unit and this would be used while charging. Ex. If we have given pulse 1 and unit type MB and Price Per Unit 2 then for 1MB 2euro would be charged <br> <br>This field is applicable for price against originating rate zone criteria.
pulse	O	Pulse. Pulse and unit type is coupled with each other. Ex. If we have given Pulse as 1 and unit type is MB, then charging will be 1MB pulse <br> <br>In case of SMS tariff scenario, pulse value must be 1. If pulse is set to another value in the API request, platform will still set it to 1
unitType	O	Unit Type
status	O	Status of Tariffs <br>0 – Inactive <br>1 – Active
minSessionFee	O	Minimum Session Fee
ratingGroup	O	Rating Group Id. For data tariff, RatingGroup is mandatory <br>3 – RG-Redirect <br>5 – Default
countryId	O	Country Id
p2pOffnetSms	O	p2pOffnetSms to be allowed (true/false) <br>false: P2P OFF-NET SMS is Not allowed <br>true: P2P OFF-NET SMS is allowed <br>If not provided, default value is false
ppuDestCriteria	O	ppuDestCriteria i.e. pulse per unit against destination criteria. This is mandatory when "p2pOffnetSms" is true.

Result Codes

Result Codes	Description	Next Steps
8194	Get tariff success
8195	Get tariff failure

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Response Examples

Get Tariff - Failure

JSON

{
    "Response": {
        "responseId": "10147764526003929674",
        "responseTimestamp": "26/05/2020 01:59:44",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "8195",
            "resultDescription": "Get tariff failure"
        }
    }
}

Get Tariff - Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "46617644747129163",
        "responseTimestamp": "2020-05-12 19:25:03",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "8194",
            "resultDescription": "Get tariff success"
        },
        "responseParam": {
            "tariffList": [
                {
                    "ppu": "10",
                    "pulse": "1",
                    "id": "12734",
                    "name": "NewTariffSMS_MO",
                    "serviceId": "2",
                    "serviceIdName": "SMS-MO",
                    "currencyId": "44",
                    "rateZone": "5213|5211",
                    "unitType": "COUNT",
                    "status": "1",
                    "p2pOffnetSms":"True",
                    "ppuDestCriteria":"3"
                    
                },
                {
                    "ppu": "10",
                    "pulse": "10",
                    "minSessionFee": "10",
                    "id": "12730",
                    "name": "NewTariffData",
                    "serviceId": "4",
                    "serviceIdName": "DATA",
                    "ratingGroup": "5",
                    "currencyId": "44",
                    "rateZone": "5213|5211",
                    "unitType": "MB",
                    "status": "1"
                }
            ]
        }
    }
}

Tariff - Modify

Path: Tariff / Tariff - Modify

Method: POST

URL: https://sft.bics.com/api/ModifyTariff

Description

This API will be used to Modify Tariff.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes	Only when custom tariff is ON

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
requestParam	M	Object of Tariff Details
tariffDetails	M	Object of Tariff Details

Input tariffDetails Parameters

Field	Optional/ Mandatory	Description
tariffDetails	M	Object Tariff Details

Input tariffDetails Parameters

Field	Optional/Mandatory	Description
tariffId	M	Tariff Id
name	O	Tariff Name
currencyId	O	Currency Id
ratingGroup	O	Rating Group Id <br>3 – RG-Redirect <br>5 – Default
ppu	O	Price per unit and this would be used while charging. Ex. If we have given pulse 1 and unit type MB and Price Per Unit 2 then for 1MB 2euro would be charged <br> <br>This field is applicable for price against originating rate zone criteria.
pulse	O	Pulse. Pulse and unit type is coupled with each other. Ex. If we have given Pulse as 1 and unit type is MB, then charging will be 1MB pulse <br> <br>In case of SMS tariff scenario, pulse value must be 1. If pulse is set to another value in the API request, platform will still set it to 1
unitType	O	Unit Type (COUNT for MT-SMS & MO-SMS and MB or KB for Data)
p2pOffnetSms	O	- true / false <br>false: P2P OFF-NET SMS is Not allowed <br>true: P2P OFF-NET SMS is allowed and ppuDestCriteria must be provided <br> <br>- This field becomes mandatory only for P2P SMS Tariff Creation, and valid only if serviceId = 2 (SMS-MO) and rate zone is provided. <br>- If not provided, default value is False <br>- This flag must be set to true in order to set a price in ppuDestCriteria.
ppuDestCriteria	O	This field is only applicable for SMS scenarios and related to additional price when SMS is sent to external B-Party subscribers. <br> <br>ppuDestCriteria i.e. pulse per unit destination is price per SMS for offnet scenarios. Ex. this price is applicable for offnet SMS on top of ppu set in earlier fields. Hence totatl price for offnet SMS = ppu + ppuDestCriteria <br> <br>ppuDest i.e. pulse per unit against destination criteria. This is mandatory when "p2pOffnetSms" is true.
minSessionFee	O	Minimum Session Fee, applicable only for serviceId=4(Data) in Enterprise level <br>NOTE: minSessionFee is not available for NB-IOT service

Output

Output Parameters

Field	Optional/ Mandatory	Description
Response	M	Object of response details

Output Response Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Result code <br>0 – Success <br>1 – Failure
responseId	M	Response Transaction ID
responseTimestamp	M	Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss
resultParam	M	Object of transaction result

Output resultParam Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Result Codes

Result Codes	Description	Next Steps
7015	Modify tariff success
7016	Modify tariff failure
10239	Operation has failure. Request has been received and it has failed. Please verify the request has been completed successfully or not.
10240	Operation has Time out. Request has been received and it has timeout. Please verify the request has been completed successfully or not.]

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{  
   "Request":{  
      "requestParam":{  
         "tariffDetails":{  
            "tariffId":"12734",
            "ratingGroup":"1",
            "name":"NewTariffName",
            "ppu":"11",
            "pulse":"11"
         }
      }
   }
}

Response Examples

Modify Tariff - Failure

JSON

{
    "Response": {
        "responseId": "10147764526003929674",
        "responseTimestamp": "26/05/2020 01:59:44",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "7016",
            "resultDescription": "Modify tariff failure"
        }
    }
}

Modify Tariff - Failure - {Validation failed} — 200 — OK

JSON

{
    "Response": {
        "responseId": "46673747661377176",
        "responseTimestamp": "2020-05-13 11:00:05",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1417",
            "resultDescription": "Validation failed, special characters not allowed"
        }
    }
}

Modify Tariff - Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "46673585656897183",
        "responseTimestamp": "2020-05-13 10:57:23",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "7015",
            "resultDescription": "Modify tariff success"
        }
    }
}

Tariff - Modify Price

Path: Tariff / Tariff - Modify Price

Method: POST

URL: https://sft.bics.com/api/ModifyTariffPrice

Description

A ligthweigh, API used to modifying the price per unit of a specific tariff (only). Suitable for quick changes on the price only.

Tariff Modify API can still be used if more extended changes are reuqired (like pulse or unit Type)

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes	Only when custom tariff is ON

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
requestParam	M	Object of Tariff Details
tariffDetails	M	Object of Tariff Details

Input tariffDetails Parameters

Field	Optional/ Mandatory	Description
tariffDetails	M	Object Tariff Details

Input tariffDetails Parameters

Field	Optional/Mandatory	Description
tariffId	M	Tariff Id
ppu	O	Price per unit <br>Does not affect the pulse or the unit type already configured <br>This field is applicable for price against originating rate zone criteria.

Output

Output Parameters

Field	Optional/ Mandatory	Description
Response	M	Object of response details

Output Response Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Result code <br>0 – Success <br>1 – Failure
responseId	M	Response Transaction ID
responseTimestamp	M	Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss
resultParam	M	Object of transaction result

Output resultParam Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Result Codes

Result Codes	Description	Next Steps
10235	Modify tariff success
10236	Modify tariff failure

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{  
   "Request":{  
      "requestParam":{  
         "tariffDetails":{  
            "tariffId":"25870",
            "ppu":"0.00056641"
         }
      }
   }
}

Response Examples

Tariff - Modify Price- Failure

JSON

{
    "Response": {
        "responseId": "5240974878102381",
        "responseTimestamp": "08/11/2024 11:19:18",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10235",
            "resultDescription": "Tariff Price Updation Failure"
        }
    }
}

Tariff - Modify Price - Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "5240974878102381",
        "responseTimestamp": "08/11/2024 11:19:18",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "10235",
            "resultDescription": "Tariff Price Updation Success"
        }
    }
}

Tariff - Delete

Path: Tariff / Tariff - Delete

Method: POST

URL: https://sft.bics.com/api/DeleteTariff

Description

Delete Tariff API will be used to delete existing Tariff.

Account Access

Account Type	Access	Comments
Reseller	Yes
Enterprise	Yes

Input

Input Parameters

Field	Optional/ Mandatory	Description
Request	M	Object of request details

Input Request Parameters

Field	Optional/ Mandatory	Description
requestParam	M	Object of Tariff Details

Input tariffDetails Parameters

Field	Optional/ Mandatory	Description
tariffDetails	M	Object Tariff Details

Input tariffDetails Parameters

Field	Optional/Mandatory	Description
tariffId	M	Tariff Id

Output

Output Parameters

Field	Optional/ Mandatory	Description
Response	M	Object of response details

Output Response Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Result code <br>0 – Success <br>1 – Failure
responseId	M	Response Transaction ID
responseTimestamp	M	Response initiated time <br>Format: dd/mm/yyyy hh:mm:ss
resultParam	M	Object of transaction result

Output resultParam Parameters

Field	Optional/ Mandatory	Description
resultCode	M	Status/Error Code
resultDescription	M	Status/Error Description

Result Codes

Result Codes	Description	Next Steps
7017	Delete tariff success
7018	Delete tariff failure
8223	Tariff already attached to plan
10239	Operation has failure. Request has been received and it has failed. Please verify the request has been completed successfully or not.
10240	Operation has Time out. Request has been received and it has timeout. Please verify the request has been completed successfully or not.

Headers

Header	Value
`Content-Type`	`application/json`
`X-Requested-With`	`XMLHttpRequest`
`X-Authorization`	`Bearer {{Auth_Key}}`

Request Body

JSON

{  
   "Request":{  
      "requestParam":{  
         "tariffDetails":{  
            "tariffId":"11207"
         }
      }
   }
}

Response Examples

Delete Tariff - Success — 200 — OK

JSON

{
    "Response": {
        "responseId": "40189140819167984",
        "responseTimestamp": "2020-02-28 09:43:18",
        "resultCode": "0",
        "resultParam": {
            "resultCode": "7017",
            "resultDescription": "Delete tariff success"
        }
    }
}

Delete Tariff - Failure - {Wrong Input}

JSON

{
    "Response": {
        "responseId": "40189165425178788",
        "responseTimestamp": "2020-02-28 09:43:43",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "1001",
            "resultDescription": "Wrong input parameter - TariffId"
        }
    }
}

Delete Tariff - Failure

JSON

{
    "Response": {
        "responseId": "10147764526003929674",
        "responseTimestamp": "26/05/2020 01:59:44",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "7018",
            "resultDescription": "Delete tariff failure"
        }
    }
}

Delete Tariff - Failure - {Tariff attached to plan}

JSON

{
    "Response": {
        "responseId": "40189065490524544",
        "responseTimestamp": "2020-02-28 09:42:03",
        "resultCode": "1",
        "resultParam": {
            "resultCode": "8223",
            "resultDescription": "Tariff already attached to plan"
        }
    }
}