Basic information
PUT /{shopId}/carts/{cartId}/payment-data
Modifies the payment data for a cart.
Please note that by providing the attribute name in the request body, the attributes paymentMethod and transactionId included in paymentData will be set to null. The provided name will not be included in the response. Instead, it will be displayed as the payment method used for the related order in the administration area of the merchant.
If the attribute priceAmount is provided in the request, the price included in paymentData will be changed to the given amount. If the attribute priceAmount is not provided in the request, the price will be set to 0.
Authorisation
OAuth 2.0 Token required with scopes:
carts_price_write
URI parameters
| Name | Type | Description |
|---|---|---|
shopId |
string |
The unique identifier of the shop. Required:
true
Example:
DemoShop
|
cartId |
string |
The unique identifier of the cart. Required:
true
Example:
5858FD17-147C-661C-9C33-D5809AB3C8BA
|
Request attributes
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the payment method. |
priceAmount |
number |
The costs or the discount for the payment method. |
Request body
Media type application/json
{
"name": "Credit card",
"priceAmount": 1.95
}
Response attributes
| Name | Type | Description |
|---|---|---|
|
object of cart |
Response
HTTP 200
Media type application/json
{
"cartId": "5858FD17-147C-661C-9C33-D5809AB3C8BA",
"billingAddress": null,
"shippingAddress": {
"company": "Boehm-Jacobs",
"salutation": null,
"firstName": "Walter",
"lastName": "Ankunding",
"street": "Barrows Mountain 8",
"streetDetails": null,
"zipCode": "W11 1ET",
"city": "London",
"state": null,
"country": "GB",
"title": null,
"vatId": null,
"birthday": null,
"addressExtension": "1.Floor",
"bankAccountHolder": "Walter Ankunding",
"bankAccountNumber": "UK2677379838510",
"bankName": "Lunaview Bank",
"bankSortCode": "XXLUNBB",
"businessEmailAddress": "Ankunding@bj.com",
"businessPhoneNumber": "0045099906567",
"department": null,
"displayName": null,
"doorCode": null,
"faxNumber": "0045099906568",
"fiscalCode": null,
"gender": "MALE",
"jobTitle": "Manager",
"middleName": null,
"mobilePhoneNumber": "0045099906567",
"phoneNumber": "0045099906567",
"privateEmailAddress": null,
"privatePhoneNumber": null,
"websiteUrl": "http://bj.com",
"emailAddress": "Ankunding@bj.com"
},
"lineItemContainer": {
"grandTotal": {
"taxType": "GROSS",
"formatted": "26.35 €",
"amount": 26.35,
"currency": "EUR"
},
"totalBeforeTax": {
"taxType": "NET",
"formatted": "22.14 €",
"amount": 22.14,
"currency": "EUR"
},
"totalTax": {
"taxType": "NONE",
"formatted": "4.21 €",
"amount": 4.21,
"currency": "EUR"
},
"lineItemsSubTotal": {
"taxType": "GROSS",
"formatted": "25.98 €",
"amount": 25.98,
"currency": "EUR"
},
"productLineItems": [
{
"lineItemId": "5858FD17-79EB-9148-E5B3-D5809AB3C842",
"sku": "Acc-001",
"name": "Connector 6.3 mm",
"productId": "54E72E1F-746A-8B6E-8E41-0A0C05E64669",
"quantity": {
"amount": 2,
"unit": "yd³"
},
"lineItemPrice": {
"taxType": "GROSS",
"formatted": "25.98 €",
"amount": 25.98,
"currency": "EUR"
},
"singleItemPrice": {
"taxType": "GROSS",
"formatted": "12.99 €",
"amount": 12.99,
"currency": "EUR"
},
"lineItemCouponDiscount": {
"taxType": "GROSS",
"formatted": "1.70 €",
"amount": 1.7,
"currency": "EUR"
},
"images": [
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_h.jpg",
"classifier": "HotDeal",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6.jpg",
"classifier": "Large",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_m.jpg",
"classifier": "Medium",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_s.jpg",
"classifier": "Small",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_xs.jpg",
"classifier": "Thumbnail",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
}
],
"additionalInformation": {
"bulkPriceInfo": [
{
"quantity": {
"amount": 1,
"unit": "piece(s)"
},
"price": {
"taxType": "GROSS",
"formatted": "9.00 €",
"amount": 9,
"currency": "EUR"
},
"basePrice": null,
"priceSavings": {
"percent": {
"formatted": "10 %",
"percentage": 10.0
},
"regularBulkPrice": {
"taxType": "GROSS",
"formatted": "10.00 €",
"amount": 10,
"currency": "EUR"
}
}
}
]
},
"links": [
{
"rel": "product",
"href": "https://pm.epages.com/rs/shops/apidocu/products/54E72E1F-746A-8B6E-8E41-0A0C05E64669"
},
{
"rel": "taxClass",
"href": "https://pm.epages.com/rs/shops/apidocu/tax-classes/5446685F-A8AF-0E18-9B4F-D5809AB30FBF"
}
],
"variationString": null,
"essentialFeatures": null,
"taxClass": {
"taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
"name": "standard",
"percentage": 19.0
},
"deliveryWeight": {
"amount": 100,
"unit": "oz"
},
"energyLabelsString": "C",
"energyLabelsMaxEfficiencyString": "A+++",
"energyLabelSourceFile": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/Products/be_40401/label-1-9dee85f24e1.png",
"productDataSheetSourceFile": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/Products/be_40401/data.pdf"
}
],
"couponLineItem": null,
"shippingPrice": {
"taxType": "GROSS",
"formatted": "10.37 €",
"amount": 10.37,
"currency": "EUR"
},
"deposits": [],
"ecoParticipations": [],
"shippingOptions": [],
"basketDiscount": {
"name": "cart discount",
"lineItemPrice": {
"taxType": "GROSS",
"formatted": "-10.00 €",
"amount": -10,
"currency": "EUR"
},
"links": []
}
},
"shippingData": {
"shippingMethod": {
"id": "6082DDF8-6DE7-68C1-CB4A-D5809847CBD0",
"name": "Standard delivery"
},
"price": {
"taxType": "GROSS",
"formatted": "10.37 €",
"amount": 10.37,
"currency": "EUR"
},
"taxes": [
{
"taxClass": {
"taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
"name": "standard",
"percentage": 19.0
},
"price": {
"taxType": "NONE",
"formatted": "1.66 €",
"amount": 1.66,
"currency": "EUR"
}
}
]
},
"paymentData": {
"paymentMethod": null,
"transactionId": null,
"price": {
"taxType": "GROSS",
"formatted": "1.95 €",
"amount": 1.95,
"currency": "EUR"
},
"status": null,
"taxes": null
},
"minimumCart": {
"status": true,
"code": "SumDiscount",
"amount": null
},
"pickupToken": "NTI3MDE0NTYyNDI2NzM4NWVjMzAzZjk2N2VjOWU2OTIyMjk4ZjU1NDE5NDUxYmMzNGJjZjE1MzIyMWUzNjg1Ml8xNDgyMjI3NDc1",
"creationDate": "2018-12-17T21:07:29Z",
"checkoutUrl": "https://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/AnonymousUsers/2/Baskets/46072&ChangeAction=PickupBasket&PickupToken=NTI3MDE0NTYyNDI2NzM4NWVjMzAzZjk2N2VjOWU2OTIyMjk4ZjU1NDE5NDUxYmMzNGJjZjE1MzIyMWUzNjg1Ml8xNDgyMjI3NDc1",
"registerSessionUrl": "https://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/AnonymousUsers/2/Baskets/46072&ChangeAction=PickupBasket&PickupToken=NTRjZWJmNjdhNzNlYTUzNDAxZTgyZTc4ODYwYTliMDUxMDIzNDQ2OWY2NWQ5NWRmN2Q2YmVjZjVjNzljOTQ2N18xNDgyMjI3OTE3",
"cartValidation": {
"possibleShippingMethods" : [
"Standard delivery",
"Express delivery",
"Customer pickup"
]
},
"potentialBasketDiscounts": [
{
"absolute": {
"taxType": "GROSS",
"formatted": "10.00 €",
"amount": 10,
"currency": "EUR"
},
"minimumAmount": {
"taxType": "GROSS",
"formatted": "30.00 €",
"amount": 30,
"currency": "EUR"
},
"percent": null
},
{
"absolute": null,
"minimumAmount": {
"taxType": "GROSS",
"formatted": "50.00 €",
"amount": 50,
"currency": "EUR"
},
"percent": {
"percentage": 10.0,
"formatted": "10 %"
}
}
],
"links": [
{
"rel": "self",
"href": "https://pm.epages.com/rs/shops/apidocu/carts/5858FD17-147C-661C-9C33-D5809AB3C8BA"
},
{
"rel": "shipping-method",
"href": "https://pm.epages.com/rs/shops/apidocu/shipping-methods/5171DD86-C077-0726-C448-AC14145F9026"
},
{
"rel": "add-coupon",
"href": "https://pm.epages.com/rs/shops/apidocu/carts/5858FD17-147C-661C-9C33-D5809AB3C8BA/coupon"
}
]
}