Update payments
patch
/ccstore/v1/orders/current/payments
This API is used by the CX Commerce OSF Storefront. This API is currently not used by CX Commerce Classic Storefront but may be used in the future. It may be used in applications outside of CX Commerce Storefront.
Update Store Credit amount or Gift Card amount and/or billing address of one or more payments in the cart (current incomplete order). This will perform a balance enquiry and calculates the amount remaining to be applied. Plus retains the (yet to be authorised) payment in the cart for authorisation during submit.
This endpoint is part of a group of APIs used in conjunction with each other to perform granular actions on the cart (current incomplete order).
Request
Supported Media Types
- application/json
Header Parameters
-
X-CCOrganization(optional): string
Current organization context of the logged in user
-
X-CCVisitorId(optional): string
ID provided by the Oracle Commerce Visit Service to uniquely identify the current visitor. It is required for every request to enable full endpoint capabilities for all shopper types.
Root Schema : updatePayments_request
Type:
Show Source
object-
items(optional):
array items
Updates payments in the current order.
Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
Amount to be authorized from the payment.
-
billingAddress(optional):
object billingAddress
The billing address details. Payment type: physicalGiftCard, card, invoice, generic.
-
cardCVV(optional):
string
Credit/Debit card secret pin. Payment type:card.
-
cardNumber(optional):
string
Credit/Debit card number used for payment. Payment type:card.
-
cardType(optional):
string
Credit/Debit card type. e.g. visa. Payment type:card.
-
customProperties(optional):
object customProperties
Custom object with dynamic properties. This will be passed to the webhook request
-
endMonth(optional):
string
Credit/Debit card expiry month. Payment type:card.
-
endYear(optional):
string
Credit/Debit card expiry year. Payment type:card.
-
expiryMonth(optional):
string
Credit/Debit card expiry month. Payment type:card.
-
expiryYear(optional):
string
Credit/Debit card expiry year. Payment type:card.
-
nameOnCard(optional):
string
Name on the credit/debit card. Payment type:card.
-
PONumber(optional):
string
Purchase order number for invoice payment. Payment type:invoice
-
saveCard(optional):
boolean
Property that determines whether to save this card or not.
-
savedCardId(optional):
string
ID of the saved card
-
type(optional):
string
Payment type: card | invoice | physicalGiftCard | cash | storeCredit | generic | inStorePayment | loyaltyPoints.
Nested Schema : billingAddress
Type:
objectThe billing address details. Payment type: physicalGiftCard, card, invoice, generic.
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country code.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
state(optional):
string
State code.
-
suffix(optional):
string
Name suffix.
Nested Schema : customProperties
Type:
objectCustom object with dynamic properties. This will be passed to the webhook request
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : updatePayments_response
Type:
Show Source
object-
embedded(optional):
object embedded
The embedded holder property for the current order representation.
-
items(optional):
array items
The list of added payments after the update has been completed.
Nested Schema : embedded
Type:
objectThe embedded holder property for the current order representation.
Show Source
Nested Schema : items
Type:
arrayThe list of added payments after the update has been completed.
Show Source
Nested Schema : model_order
Type:
Show Source
object-
creationSiteId(optional):
string
The ID of the site on which the order was created. This may differ to siteId value if the site is part of a cart sharing group.
-
dynamicProperties(optional):
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
giftWithPurchaseInfo(optional):
array giftWithPurchaseInfo
The gift information.
-
giftWithPurchaseOrderMarkers(optional):
array giftWithPurchaseOrderMarkers
giftWithPurchaseOrderMarker information.
-
orderAction(optional):
string
The action performed on the order.Example:
order -
orderId(optional):
string
Order ID of the order.Example:
o10003 -
payments(optional):
array payments
Payment details for the order, including additional properties specific to the payment type.
-
priceListGroup(optional):
object priceListGroup
The price list group object.
-
shippingGroups(optional):
object shippingGroups
The shipping groups in the order.
-
shippingMethod(optional):
object shippingMethod
Shipping Method information of the order.
-
shoppingCart(optional):
object shoppingCart
Shopping cart information.
-
siteId(optional):
string
The ID of the site in which the order was createdExample:
siteUS
Nested Schema : dynamicProperties
Type:
arrayRead-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type:
arraygiftWithPurchaseOrderMarker information.
Show Source
Nested Schema : payments
Type:
arrayPayment details for the order, including additional properties specific to the payment type.
Show Source
Nested Schema : priceListGroup
Type:
objectThe price list group object.
Show Source
-
active(optional):
boolean
Active status of the price list group.Example:
true -
currency(optional):
object currency
The currency object.
-
deleted(optional):
boolean
Property to determine existence of the price list group.Example:
false -
displayName(optional):
string
Display name of the price list group.Example:
Default Price Group -
endDate(optional):
string
end dateExample:
oracle.doceng.json.BetterJsonNull@976042d -
isTaxIncluded(optional):
boolean
Whether tax is included.Example:
false -
locale(optional):
string
Locale of the price list group.Example:
en_US -
repositoryId(optional):
string
Repository ID of the price list group.Example:
defaultPriceGroup -
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
Shipping Surcharge PriceList object.
Nested Schema : shippingGroups
Type:
objectThe shipping groups in the order.
Show Source
-
discountInfo(optional):
object discountInfo
Discount Information
-
items(optional):
array items
The array of products in the shipping group.
-
priceInfo(optional):
object priceInfo
Price information of the order.
-
shippingAddress(optional):
object shippingAddress
The shipping address details.
-
shippingGroupId(optional):
string
The ID of the shipping group.Example:
sg10032 -
shippingMethod(optional):
object shippingMethod
The shipping method details for the order.
-
type(optional):
string
The type of shipping group e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroupExample:
hardgoodShippingGroup
Nested Schema : shippingMethod
Type:
objectShipping Method information of the order.
Show Source
-
cost(optional):
number
Cost of shipping method.Example:
6.5 -
shippingTax(optional):
number
The shipping tax.Example:
0.46 -
value(optional):
string
Shipping method value.Example:
ground
Nested Schema : shoppingCart
Type:
objectShopping cart information.
Show Source
-
items(optional):
array items
Items in the cart.
-
numberOfItems(optional):
integer
Number of items in the cart.Example:
1
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
The ID of the dynamic property.Example:
giftWrapMessage123 -
label(optional):
string
The label of the dynamic property.Example:
Gift Wrap Message123 -
value(optional):
string
The value of the dynamic property.Example:
newGSMessage45600
Nested Schema : items
Type:
Show Source
object-
giftWithPurchaseDetail(optional):
string
String identifying the free gift, usually the repository ID of the gift type.Example:
Product_6Dxyi -
giftWithPurchaseIdentifier(optional):
integer
An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.Example:
-2.3234234355E10 -
giftWithPurchaseQuantityAvailableForSelection(optional):
number
gift quantity available for selectionExample:
1 -
giftWithPurchaseType(optional):
string
The type of the gift. (sku, product)Example:
1 -
promotionId(optional):
string
The gift with purchase promotion IDExample:
promo40001
Nested Schema : items
Type:
Show Source
object-
automaticQuantity(optional):
number
The quantity of free sku for this gift selection that has already been auto added to the order.Example:
0 -
autoRemove(optional):
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.Example:
true -
data(optional):
integer
Identifier to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.Example:
-2.4564678912E10 -
failedQuantity(optional):
number
The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.Example:
0 -
giftDetail(optional):
string
String identifying the free gift, usually the repository ID of the gift type.Example:
Product_6Dxyi -
giftType(optional):
string
The type of the gift. (sku, product)Example:
product -
key(optional):
string
atg.gwpExample:
atg.gwp -
quantity(optional):
number
The total quantity of sku for this gift selection.Example:
1 -
removedQuantity(optional):
number
The amount of free quantity that has since been manually removed by a Shopper.Example:
1 -
selectedQuantity(optional):
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.Example:
0 -
targetedQuantity(optional):
number
The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
-
value(optional):
string
The gift with purchase promotion IDExample:
promo40001
Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
Amount authorized from the payment group.Example:
170 -
balance(optional):
number
Total available balance on the gift card.Example:
100 -
gatewayName(optional):
string
Payment gateway name. e.g. chaseCreditCard.Example:
chaseGiftCard -
giftCardNumber(optional):
string
Gift card number.Example:
6.0483478347347343E18 -
isAmountRemaining(optional):
boolean
A boolean to decide if more payment can be made from this payment group.Example:
true -
maskedCardNumber(optional):
string
Masked gift card number.Example:
xxxxxxxxxxxxxxxxxx1234 -
paymentGroupId(optional):
string
Payment group ID.Example:
pg70048 -
paymentMethod(optional):
string
Payment method. e.g. physicalGiftCard/ creditCard.Example:
creditCard -
paymentState(optional):
string
The state of the payment group. e.g. AUTHORIZED.Example:
INITIAL -
savedCardId(optional):
string
ID of the saved card associated with the payment group.Example:
sc1234 -
uiIntervention(optional):
string
This decides whether the client has to do some intervention for payment. e.g. SOP.Example:
oracle.doceng.json.BetterJsonNull@54201c6b
Nested Schema : currency
Type:
objectThe currency object.
Show Source
-
currencyCode(optional):
string
The currency code.Example:
USD -
displayName(optional):
string
Display name of the currency.Example:
US Dollar -
fractionalDigits(optional):
integer
Number of fractional digits for the currency.Example:
2 -
numericCode(optional):
string
Numeric code of the currency.Example:
840 -
repositoryId(optional):
string
Repository ID of the currency.Example:
currency -
symbol(optional):
string
The currency symbol.Example:
$
Nested Schema : shippingSurchargePriceList
Type:
objectShipping Surcharge PriceList object.
Show Source
-
repositoryId(optional):
string
Repository ID of the shipping surcharge price list.Example:
shippingSurchargePrices
Nested Schema : discountInfo
Type:
objectDiscount Information
Show Source
-
discountDescList(optional):
array discountDescList
The list of all the order discounts.
-
orderDiscount(optional):
number
Order DiscountExample:
0 -
orderImplicitDiscountList(optional):
array orderImplicitDiscountList
Implicit Promotions for the order
-
shippingDiscount(optional):
number
Shipping DiscountExample:
0
Nested Schema : priceInfo
Type:
objectPrice information of the order.
Show Source
-
amount(optional):
number
Amount of order.Example:
179 -
currencyCode(optional):
string
Currency code for currency being used.Example:
USD -
primaryCurrencyTotal(optional):
number
The current total in loyalty points in case of multi currencyExample:
204.06 -
shipping(optional):
number
Shipping price of order.Example:
6.5 -
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.Example:
0 -
subTotal(optional):
number
Sub total.Example:
179 -
tax(optional):
number
Tax.Example:
18.56 -
total(optional):
number
Total amount of order.Example:
204.06 -
totalWithoutTax(optional):
string
The total without including tax.Example:
185.5
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
Show Source
-
address1(optional):
string
Address snippet.Example:
76 Palm Drive -
address2(optional):
string
Address snippet.Example:
Florida -
address3(optional):
string
Address snippet.Example:
Florida -
alias(optional):
string
Address alias.Example:
Address03# -
city(optional):
string
City.Example:
Orlando -
companyName(optional):
string
Company name.Example:
Doctor's Place -
country(optional):
string
Country.Example:
US -
county(optional):
string
County.Example:
Florida -
email(optional):
string
Email address.Example:
john@email.com -
faxNumber(optional):
string
Fax number.Example:
330193316 -
firstName(optional):
string
First name.Example:
John -
jobTitle(optional):
string
Job title.Example:
Doctor -
lastName(optional):
string
Last name.Example:
Smith -
middleName(optional):
string
Middle name.Example:
Joe -
phoneNumber(optional):
string
Phone number.Example:
09345456345 -
postalCode(optional):
string
Postal code.Example:
32002 -
prefix(optional):
string
Name prefix.Example:
Mr -
selectedCountry(optional):
string
Country code.Example:
US -
state(optional):
string
State.Example:
FL -
suffix(optional):
string
Name suffix.Example:
John Smith
Nested Schema : shippingMethod
Type:
objectThe shipping method details for the order.
Show Source
-
cost(optional):
number
The total cost of shipping.Example:
6.5 -
shippingMethodDescription(optional):
string
The description of the shipping method.Example:
Ground -
shippingTax(optional):
number
The shipping tax.Example:
0.46 -
taxCode(optional):
string
Tax Code.Example:
PC00300 -
taxIncluded(optional):
boolean
Whether tax is includedExample:
true -
value(optional):
string
The shipping method applied to the order.Example:
ground
Nested Schema : items
Type:
Show Source
object-
coupon(optional):
string
The coupon code.Example:
FREETATTOO -
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions)Example:
false -
promotionDesc(optional):
string
This field returns name of the promotion. Retained for backward compatibilityExample:
Explicit Item Discount - FREETATTOO -
promotionId(optional):
string
The promotion ID.Example:
explicitItemFreeDiscount -
promotionLevel(optional):
string
The promotion level.Example:
item -
promotionName(optional):
string
The display name of the promotion.Example:
Free Tattoo
Nested Schema : items
Type:
Show Source
object-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions)Example:
false -
promotionDesc(optional):
string
This field returns name of the promotion. Retained for backward compatibilityExample:
Implicit Item Discount - 3PercentOff -
promotionId(optional):
string
Promotion IDExample:
implicitItemPercentDiscount -
promotionLevel(optional):
string
Promotion LevelExample:
item
Nested Schema : items
Type:
Show Source
object-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.Example:
false -
availabilityDate(optional):
string
The availability date of commerce Item.Example:
2020-06-30 -
availablePickupDate(optional):
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).Example:
2020-06-30 -
backOrderQuantity(optional):
number
Back Order Quantity of the Items.Example:
0 -
catRefId(optional):
string
The product variant ID.Example:
Sku_18Cxi -
commerceItemId(optional):
string
The ID of the commerce item.Example:
ci3000411 -
discountAmount(optional):
number
The value of the discount.Example:
0 -
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
inventoryLocationId(optional):
string
Defines the inventory location that services the referenced commerce item.Example:
SiteUS-GlenAllen187 -
onSale(optional):
boolean
Whether the item is on sale or not.Example:
false -
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.Example:
false -
preferredPickupDate(optional):
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).Example:
2020-06-30 -
preOrderQuantity(optional):
number
The pre order quantity of the items.Example:
0 -
productId(optional):
string
ID of the product in the cart.Example:
Product_18Cxi -
quantity(optional):
integer
The quantity of the product in this shipping group.Example:
5 -
rawTotalPrice(optional):
integer
The raw price of the product.Example:
29.99 -
relationshipType(optional):
string
The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.
-
returnedQuantity(optional):
integer
Number of referenced items that were returned.Example:
0 -
salePrice(optional):
string
Sale Price.Example:
0 -
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.Example:
0 -
siteId(optional):
string
The ID of the site on which the item was added.Example:
siteUS -
skuProperties(optional):
array skuProperties
Sku properties Information
-
state(optional):
string
state of the commerce ItemExample:
SUBMITTED -
unitPrice(optional):
number
The price of the item.Example:
29.99 -
variant(optional):
array variant
List of variants for the product.
Nested Schema : dynamicProperties
Type:
arrayArray of custom properties at order line item level.
Show Source
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
The ID of the dynamic property.Example:
dynamicPropertyMode -
label(optional):
string
The label of the dynamic property.Example:
Mode -
value(optional):
string
The value of the dynamic property.Example:
pickup
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
ID of the Dynamic SKU Property.Example:
upcCode -
name(optional):
string
Name of the Dynamic SKU Property.Example:
UPC Code -
propertyType(optional):
string
Type that indicates whether it is a base or a custom SKU property,Example:
sku-base -
value(optional):
string
Value of the Dynamic SKU Property.Example:
12345
Nested Schema : items
Type:
Show Source
object-
optionName(optional):
string
The variant option name.Example:
color -
optionValue(optional):
string
The variant option value.Example:
red
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.Example:
Add -
asset(optional):
boolean
The flag that determines if the current item is an asset or not.Example:
false -
catRefId(optional):
string
Sku reference ID.Example:
Sku_18Cxi -
childSkus(optional):
array childSkus
An array with single primary image url for this item's sku, or its default image.
-
commerceItemId(optional):
string
For stateless cart, can be used as a unique line item ID distinguisher.Example:
ci3000411 -
discountAmount(optional):
string
The discount amount.Example:
0 -
displayName(optional):
string
Display Name.Example:
Dora The Explorer -
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
giftWithPurchaseCommerceItemMarkers(optional):
array giftWithPurchaseCommerceItemMarkers
giftWithPurchaseCommerceItemMarker information.
-
id(optional):
string
Unique identifier for the line item.Example:
ci3000415 -
isItemValid(optional):
boolean
Whether item is valid or not.Example:
true -
itemDiscountInfos(optional):
array itemDiscountInfos
Item discount infos
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.Example:
ci3000411 -
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
price(optional):
number
Price of the items.Example:
21.99 -
primaryImageAltText(optional):
string
The product's primary image alternative text.
-
primaryImageTitle(optional):
string
The product's primary image title.Example:
Samsung - F90BN HD Flash Memory Camcorder -
primaryThumbImageURL(optional):
string
Product's Primary Thumb Image URL.Example:
ccstore/v1/images/?source=/file/v7023553219093550939/products/Book.jpg&height=100&width=100 -
productId(optional):
string
ID of the product in the cart.Example:
Product_18Cxi -
quantity(optional):
integer
Quantity of the items.Example:
5 -
rawTotalPrice(optional):
string
Raw Total Price.Example:
179 -
route(optional):
string
The UI route to display the product.
-
shippingSurchargeValue(optional):
number
shipping surcharge value.Example:
0 -
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
state(optional):
string
state of the commerce ItemExample:
SUBMITTED -
variant(optional):
array variant
List of variants for the product.
Nested Schema : childSkus
Type:
arrayAn array with single primary image url for this item's sku, or its default image.
Show Source
Nested Schema : dynamicProperties
Type:
arrayArray of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type:
arraygiftWithPurchaseCommerceItemMarker information.
Show Source
Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
The ID of the dynamic property.Example:
giftWrapMessage123 -
label(optional):
string
The label of the dynamic property.Example:
Gift Wrap Message123 -
value(optional):
string
The value of the dynamic property.Example:
newGSMessage45600
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object-
automaticQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.Example:
0 -
data(optional):
integer
The gift hash code for this gift with purchase promotion.Example:
-123345466 -
key(optional):
string
atg.gwpExample:
atg.gwp -
remainingQuantity(optional):
number
The quantity of the commerce item that is not affected by gift with purchase.Example:
0 -
selectedQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.Example:
0 -
targetedQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.Example:
0 -
value(optional):
string
The gift with purchase promotion ID.Example:
promo10002
Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
Discount amount for itemExample:
10 -
couponCodes(optional):
array couponCodes
Coupon codes applied to the items
-
promotionId(optional):
string
ID of the promotionExample:
promo1111
Nested Schema : couponCodes
Type:
arrayCoupon codes applied to the items
Show Source
-
Array of:
string
Example:
TestCouponCode
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
ID of the Dynamic SKU Property.Example:
displayName -
name(optional):
string
Name of the Dynamic SKU Property.Example:
name -
propertyType(optional):
string
Type that indicates whether it is a base or a custom SKU property,Example:
sku-base -
value(optional):
string
Value of the Dynamic SKU Property.Example:
Sku_18Cxi
Nested Schema : items
Type:
Show Source
object-
optionName(optional):
string
The variant option name.Example:
color -
optionValue(optional):
string
The variant option value.Example:
red
Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
Amount to be authorized from the gift card.
-
balance(optional):
number
Total available balance on the gift card or store credit.
-
cardType(optional):
string
Credit/Debit card type. e.g. visa. Payment type:card.
-
currencyCode(optional):
string
The currency code.
-
customProperties(optional):
object customProperties
Custom object with dynamic properties. This will be passed to the webhook request
-
expiryMonth(optional):
string
Credit/Debit card expiry month. Payment type:card.
-
expiryYear(optional):
string
Credit/Debit card expiry year. Payment type:card.
-
gatewayName(optional):
string
Payment gateway name. e.g. chaseGiftCard.
-
giftCardNumber(optional):
string
Gift card number used for payment. Payment type:physicalGiftCard.
-
giftCardPin(optional):
string
Gift card pin. Payment type:physicalGiftCard.
-
IIN(optional):
string
The issuer identification number (first 6 digits) of the IIN payment type card, e.g. credit card. This is normally used to allow any credit card type based promotions to be applied prior to final checkout. (iinPaymentType only)
-
isAmountRemaining(optional):
boolean
A boolean to decide if more payment can be made from this payment.
-
nameOnCard(optional):
string
Name on the credit/debit card. Payment type:card.
-
paymentExpired(optional):
boolean
True if cached payment details have expried.
-
paymentGroupId(optional):
string
The ID of the Payment Group.
-
paymentMethod(optional):
string
Payment method. e.g. physicalGiftCard/ store credit.
-
paymentState(optional):
string
The state of the payment group. e.g. INITIAL.
-
PONumber(optional):
string
Purchase order number for invoice payment. Payment type:invoice
-
savedCardId(optional):
string
ID of the saved card associated with the payment group.
-
storeCreditNumber(optional):
string
Store credit number used for payment. Payment type:storeCredit.
-
type(optional):
string
Payment type: physicalGiftCard, storeCredit, card, invoice, generic, inStorePayment, cash, loyaltyPoints.
Nested Schema : customProperties
Type:
objectCustom object with dynamic properties. This will be passed to the webhook request
Example Response (application/json)
{
"totalResults":"3",
"offset":"0",
"hasMore":"false",
"limit":"250",
"links":[
{
"method":"PATCH",
"rel":"/rels/updatePayments",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/payments"
},
{
"method":"GET",
"rel":"last",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/payments?offset=0&limit=3"
},
{
"method":"POST",
"rel":"/rels/addPayments",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/payments/add"
},
{
"method":"GET",
"rel":"self",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/payments"
},
{
"method":"GET",
"rel":"canonical",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/payments"
},
{
"method":"GET",
"rel":"first",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/payments?offset=0&limit=250"
}
],
"items":[
{
"paymentGroupId":"pg230431",
"amount":5,
"customPaymentProperties":{
},
"balance":"9.11",
"gatewayName":"demoGenericGiftCardGateway",
"giftCardNumber":"6035718888920014103",
"paymentMethod":"physicalGiftCard",
"isAmountRemaining":false,
"paymentState":"INITIAL",
"maskedCardNumber":"xxxxxxxxxxxxxxx4103"
},
{
"paymentGroupId":"pg230433",
"amount":5.88,
"customPaymentProperties":{
},
"balance":"28.61",
"gatewayName":"demoGenericGiftCardGateway",
"giftCardNumber":"987655432",
"paymentMethod":"physicalGiftCard",
"isAmountRemaining":false,
"paymentState":"INITIAL",
"maskedCardNumber":"xxxxx5432"
},
{
"paymentGroupId":"pg230434",
"amount":4.11,
"customPaymentProperties":{
},
"default_initial":"true",
"paymentMethod":"tokenizedCreditCard",
"isAmountRemaining":true,
"type":"CyberSource",
"paymentState":"INITIAL"
}
],
"embedded":{
"order":{
"orderId":"o10001"
}
}
}400 Response
The error response (which alternates to the default response depending on error reason).
Root Schema : errorModelSingleError
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
Default Response
The error response.
Root Schema : errorModelMultiErrors
Type:
Show Source
object-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
status(optional):
string
The HTTP status code
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code