Payment

Entry point for purchasing digital goods.

API that permits BlackBerry device users to initiate the purchase of digital goods from within your application. For example, this API can be used to allow users to purchase additional levels in a gaming application, music from a radio application, or any other digital good registered on the Vendor Portal for BlackBerry App World. The digital good being purchased must be associated with the calling application in the Vendor Portal for BlackBerry App World.

Purchases are initiated via the purchase method. The amount of time that elapses before a response is returned depends on how quickly the user completes the purchase process (which may include steps such as signing in to their BlackBerry ID account and setting up their preferred billing method). The purchase method dispatches a callbackOnSuccess on success, or dispatches a callbackOnFailure on failure.

When calling the purchase method only the ID or SKU of the digital good to be purchased is required; it is not necessary to provide both, and all other arguments are optional. If both the ID and SKU are provided, then the ID takes precedence; the SKU is only used if the digital good could not be located on the Payment Service server based on the ID.

If an application requires a list of its digital goods that have already been purchased by the user (for example, to avoid offering for sale a digital good the user already owns), such a list can be obtained with the blackberry.payment.getExistingPurchases method. This method requires the same user interaction as the purchase method, so it can also be a long-running method.

[{
"transactionID": "00000001",
"digitalGoodID": "123",
"date": "1234567891011",
"digitalGoodSKU": "SKU_1",
"licenseKey": null,
"metaData": "My Metadata"
},
{
"transactionID": "00000002",
"digitalGoodID": "456",
"date": "1234567891011",
"digitalGoodSKU": "SKU_2",
"licenseKey": null,
"metaData": "My Metadata"
}]

<script type="text/javascript">
  function pay() {
    try{
      blackberry.payment.purchase({
      "digitalGoodID":"123",
      "digitalGoodSKU":"someSKU",
      "digitalGoodName":"SomeName",
      "metaData":"metadata",
      "purchaseAppName":"WebWorks APP",
      "purchaseAppIcon":null},
      success,failure);
   }catch (e){
     alert ("Error" + e);
   }
 }

 function success(purchase) {
   var purchasedItem = JSON.parse(purchase);
   var transId = purchasedItem.transactionID;
   var sku = purchasedItem.digitalGoodSKU;
   var dgId = purchasedItem.digitalGoodID;
   alert("Purchased Item: " + transId + "," + sku +  "," + dgId);
 }

 function failure(errorText, errorId) {
   alert("Error occured: " + errorText + ", " + errorId);
 }
</script>