1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Store
  4. Orders
  5. Current
  6. Payments

Apply payments

post

/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.

Add one or more Physical Gift Card or Store Credit payments to the cart. 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
Header Parameters
Body ()
Root Schema : applyPayments_request
Type: object
Show Source
Example:
{
    "items":[
        {
            "giftCardNumber":"6035718888920014103",
            "giftCardPin":"1234",
            "billingAddress":{
                "lastName":"Bloggs",
                "country":"United States",
                "address3":"",
                "address2":"",
                "city":"Florida City",
                "prefix":"",
                "address1":"111 Florida Dr",
                "postalCode":"33034",
                "jobTitle":"",
                "companyName":"",
                "county":"US",
                "suffix":"",
                "type":"",
                "firstName":"Joe",
                "phoneNumber":"",
                "alias":"",
                "faxNumber":"",
                "middleName":"",
                "state":"FL",
                "email":null,
                "state_ISOCode":"US-FL"
            },
            "type":"physicalGiftCard"
        }
    ]
}
Nested Schema : items
Type: array
Payment details for the order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
The billing address details.
Show Source
Nested Schema : customProperties
Type: object
Custom object with dynamic properties. This will be passed to the webhook request
Back to Top

Response

Supported Media Types

200 Response

Returned when the operation succeeds.
Body ()
Root Schema : addPayments_response
Type: object
Show Source
Nested Schema : embedded
Type: object
Property to return other embedded objects, like order. This gets included in the payload when query parameter includeOrder is passed as true.
Show Source
Nested Schema : paymentResponses
Type: array
The array of payment responses
Show Source
Nested Schema : order
Type: object
The current order representation.
Show Source
Nested Schema : discountInfo
Type: object
Discount Information
Show Source
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseInfo
Type: array
The gift information.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
giftWithPurchaseOrderMarker information.
Show Source
Nested Schema : priceInfo
Type: object
Price information of the order.
Show Source
Nested Schema : priceListGroup
Type: object
The price list group object.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
Show Source
Nested Schema : shippingMethod
Type: object
Shipping Method information of the order.
Show Source
Nested Schema : shoppingCart
Type: object
Shopping cart information.
Show Source
Nested Schema : claimedCouponMultiPromotions
Type: object
The coupons that were claimed.
Show Source
Nested Schema : orderCouponsMap
Type: object
The coupons that were claimed.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
Implicit Promotions for the order
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
The coupons that were not claimed
Show Source
Nested Schema : unclaimedCouponsMap
Type: object
The coupons that were not claimed
Show Source
Nested Schema : couponCode
Type: array
Coupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCode
Type: object
Coupon Code.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCode
Type: array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCode
Type: object
Coupon Code.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
The array of products in the shipping group.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
Nested Schema : store
Type: object
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
Nested Schema : skuProperties
Type: array
Sku properties Information
Show Source
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Items in the cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
The array of child items in the item, if the item is a configurable item. A child item can itself contain child item array if it is a configurable product in itself.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
giftWithPurchaseCommerceItemMarker information.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : skuProperties
Type: array
Sku properties Information
Show Source
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : customPaymentProperties
Type: object
Custom Payment Properties
Example Response (application/json)
{
    "totalResults":"2",
    "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=2"
        },
        {
            "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":9.11,
            "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":true,
            "paymentState":"INITIAL",
            "maskedCardNumber":"xxxxx5432"
        }
    ],
    "embedded":{
        "order":{
            "orderId":"o10001"
        }
    }
}

400 Response

The error response (which alternates to the default response depending on error reason).
Body ()
Root Schema : errorModelSingleError
Type: object
Show Source

Default Response

The error response.
Body ()
Root Schema : errorModelMultiErrors
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top