CancelProduct
Jump to navigation
Jump to search
Description
Cancel product purchase by product Id
Should be used by logged user.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- productId (int, required)
- A product id for the product that wants to cancel.
- productTypeId (productType, required)
- Type id of the product that wants to cancel the purchase.
- pin (String, required)
- PurchasePin to authenticate the purchase.
Returns
Returns a JSON object containing a user product information.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": ""
}
Exceptions
- AuthenticationRequiredException
- UserPurchasePinValueNoMatchException
- UserHasNoRightsToThisProductException
- PurchaseNotFoundException
- NonRenewableUserRightException
- PurchaseAlreadyCancelledException
- PurchaseAlreadyInCancellingException
- PurchaseAlreadyInPendingOBCancellationException
Caching
This method is not cached.
Known issues
- None
Version history
API Version Number | Change description | Changes author |
---|---|---|
1.0 | Initial method design | Harley Cabral |