[Deprecated] Manage baskets (v1)
Submit basket information within your payment.
A basket is a collection of product information for each transaction. It is not a mandatory resource, but some payment methods require this information for risk analysis, such as Direct Debit Secured and Unzer Invoice.
- In your eCommerce site, the customer selects the items they want to purchase. You send a POST request to create the
basketresource. A unique basket ID is created.
basketIdcan now be used when the payment is initiated.
Once a basket has been created, it cannot be replaced or deleted. If you haven’t assigned a basket to a transaction yet, you can update it. This means you cannot change specific attributes, but you can provide new basket details. For example, you can add more items, remove items, but cannot update the basket ID.
To learn more about the baskets, see Basket section.
To create a new basket resource, send a POST request with your desired contents in the JSON format.
Unzer unzer = new Unzer("s-priv-xxxxxxxxxx"); BasketItem basketItem = new BasketItem() .setBasketItemReferenceId("Artikelnummer4711") .setQuantity(5) .setAmountPerUnit(new BigDecimal(100.1)) .setAmountNet(new BigDecimal(420.1)) .setTitle("Apple iPhone") .setSubtitle("Red case") .setImageUrl("https://url.to.the.basket.item.image") .setType(BasketItem.Type.GOODS); Basket basket = new Basket() .setAmountTotalGross(new BigDecimal("500")) .setCurrencyCode(Currency.getInstance("EUR")) .setOrderId("uniqueOrderId_1") .addBasketItem(basketItem); Basket basket = unzer.createBasket(basket);
- Although it’s possible to use any character combination for the
orderId, we recommend using the same
orderIdas for payments (created by
types/charge, and so on).
- The order ID must be unique.
The response contains a basket ID that is saved in your basket object.
To fetch a specific
basket resource, use your private key and send a GET request with the basket ID.
Unzer unzer = new Unzer("s-priv-xxxxxxxxxx"); Basket basket = unzer.fetchBasket("s-bsk-1");
fetchBasket method will return a
Basket Instance containing the Basket information from the Unzer API response.
Go to the API reference for more information.
Here you can see how to add a basket to a transaction, in our example a
charge request. You just have to add the basket ID to your
resources parameter list as shown in the following example:
Unzer unzer = new Unzer("s-priv-xxxxxxxxxx"); Charge charge = unzer.charge( BigDecimal.valueOf(12.99), Currency.getInstance("EUR"), "s-crd-9wmri5mdlqps", "https://your.return.url", null, "s-bsk-1", null, null )
In some cases, it might be necessary to change an already created basket, for example if the user added a voucher or shipping fees changed.
In that case, you have to change the whole content of the basket - it’s not possible to change individual parts of a basket resource. Either copy the contents of the old one, alter them and submit it using the
Unzer::updateBasket method, or create a new Basket.
String basketId = "s-bsk-1"; Unzer unzer = new Unzer("s-priv-xxxxxxxxxx"); Basket basket= unzer.fetchBasket(basketId); basket.setAmountTotalGross(BigDecimal.valueOf(4321)) basket.setAmountTotalDiscount(BigDecimal.valueOf(5432)); basket.setNote("This basket is updated!"); basket.getBasketItems().get(0).setTitle("This item is also updated!"); unzer.updateBasket(basket, basketId);