SPS - Subscription Balance Management (v5)

Download OpenAPI specification:Download

The "Subscription Balance Management API" provides the ability to setup buckets, switch primary bucket, cancel bucket, query balances, update balances.

Operations

Provides the ability to add buckets for the given subscription

This method provides the capability to add buckets for the given subscription

Preconditions

Check whether Subscription is valid and active as per the input GPSI and Wholesale Customer Id

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

header Parameters

X-Correlation-Id	string <uuid> (CorrelationId) Example: TQA20210903155950999 Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes
wholesaleCustomerId	string (CustomerId) [ 1 .. 12 ] characters ^.*$ Example: 100000108464 Identifier of wholesale customer/partner

Request Body schema: application/json

This represents request model of Add Buckets.

gpsi required	string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$ GPSI/MSISDN of the active subscription
bucketRefId required	Array of strings[ items non-empty ]

Responses

Request samples

Payload

Content type

application/json

{"gpsi": "19459986891",
"bucketRefId": ["1000001"
]
}

Response samples

Content type

application/json

{"status": "Success"
}

Provides the ability to swap primary bucket for the given subscription

This method provides the capability to swap primary bucket for the given subscription

Preconditions

Check whether Subscription is valid and active as per the input GPSI and Wholesale Customer Id

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

header Parameters

X-Correlation-Id	string <uuid> (CorrelationId) Example: TQA20210903155950999 Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes
wholesaleCustomerId	string (CustomerId) [ 1 .. 12 ] characters ^.*$ Example: 100000108464 Identifier of wholesale customer/partner

Request Body schema: application/json

This represents request model of Swap Bucket.

gpsi required	string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$ GPSI/MSISDN of the active subscription
bucketRefId required	string Bucket Reference Id

Responses

Request samples

Payload

Content type

application/json

{"gpsi": "19459986891",
"bucketRefId": "1000002"
}

Response samples

Content type

application/json

{"status": "Success"
}

Provides the ability to cancel buckets for the given subscription (future*)

This method provides the capability to cancel buckets for the given subscription

Preconditions

Check whether Subscription is valid and active as per the input GPSI and Wholesale Customer Id

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

header Parameters

X-Correlation-Id	string <uuid> (CorrelationId) Example: TQA20210903155950999 Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes
wholesaleCustomerId	string (CustomerId) [ 1 .. 12 ] characters ^.*$ Example: 100000108464 Identifier of wholesale customer/partner

Request Body schema: application/json

This represents request model of Cancel Buckets.

gpsi required	string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$ GPSI/MSISDN of the active subscription
bucketRefId required	Array of strings[ items non-empty ]

Responses

Request samples

Payload

Content type

application/json

{"gpsi": "19459986891",
"bucketRefId": ["1000001"
]
}

Response samples

Content type

application/json

{"status": "Success"
}

Provides the ability to get balances of the given subscription

This method provides the capability to get balances of the given subscription

Preconditions

Check whether Subscription is valid and active as per the input GPSI and Wholesale Customer Id

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

query Parameters

gpsi

required

string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$

Example: gpsi=2812368903

GPSI/MSISDN

header Parameters

X-Correlation-Id	string <uuid> (CorrelationId) Example: TQA20210903155950999 Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes
wholesaleCustomerId	string (CustomerId) [ 1 .. 12 ] characters ^.*$ Example: 100000108464 Identifier of wholesale customer/partner

Responses

Response samples

Content type

application/json

{"balances": [{"balanceType": "Main",
"subBalances": [{"subBalanceInstId": "SubBalInst1",
"subBalanceType": "On-Net Voice",
"remainingBalance": 12,
"allocatedBalance": 90,
"rollOverBalance": 10,
"totalBalance": 100,
"unitType": "Min"
},
{"subBalanceInstId": "SubBalInst2",
"subBalanceType": "On-Net SMS",
"remainingBalance": 12,
"allocatedBalance": 90,
"rollOverBalance": 10,
"totalBalance": 100,
"unitType": "SMS"
},
{"subBalanceInstId": "SubBalInst3",
"subBalanceType": "On-Net MMS",
"remainingBalance": 12,
"allocatedBalance": 90,
"rollOverBalance": 10,
"totalBalance": 100,
"unitType": "MMS"
},
{"subBalanceInstId": "SubBalInst4",
"subBalanceType": "On-Net Data",
"remainingBalance": 12,
"allocatedBalance": 90,
"rollOverBalance": 10,
"totalBalance": 100,
"unitType": "MB"
}
]
}
]
}

Provides the ability to update balances of the given subscription

This method provides the capability to update balances of the given subscription

Preconditions

Check whether Subscription is valid and active as per the input GPSI and Wholesale Customer Id

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

header Parameters

X-Correlation-Id	string <uuid> (CorrelationId) Example: TQA20210903155950999 Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes
wholesaleCustomerId	string (CustomerId) [ 1 .. 12 ] characters ^.*$ Example: 100000108464 Identifier of wholesale customer/partner

Request Body schema: application/json

This represents request model of Update Balances.

gpsi required	string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$ GPSI/MSISDN of the active subscription
required	Array of objects (BalanceAction) [ items ] List of Balances

Responses

Request samples

Payload

Content type

application/json

{"gpsi": "19459986891",
"balances": [{"subBalanceInstId": "SubBalInst1",
"balanceType": "Main",
"subBalanceType": "On-Net Voice",
"action": "Add",
"quantity": 12,
"unitType": "Min"
},
{"subBalanceInstId": "SubBalInst2",
"balanceType": "Main",
"subBalanceType": "On-Net SMS",
"action": "Subtract",
"quantity": 12,
"unitType": "SMS"
},
{"subBalanceInstId": "SubBalInst3",
"balanceType": "Main",
"subBalanceType": "On-Net MMS",
"action": "Subtract",
"quantity": 12,
"unitType": "MMS"
},
{"subBalanceInstId": "SubBalInst4",
"balanceType": "Main",
"subBalanceType": "On-Net Data",
"action": "Add",
"quantity": 12,
"unitType": "MB"
}
]
}

Response samples

Content type

application/json

{"status": "Success"
}