1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Agent
  4. Payment

voidPayments

post

/ccagent/v1/payment/void

Void PaymentGroups of an order.

Request

Supported Media Types
Query Parameters
Body ()
Root Schema : voidPayments_request
Type: object
Show Source
Example:
{
    "orderId":"o80413",
    "payments":[
        {
            "paymentGroupId":"pg80413",
            "customProperties":{
                "cust-prop2":"cust-prop2",
                "cust-prop1":"cust-prop1"
            },
            "cancelReason":"would like to use another gift card"
        },
        {
            "paymentGroupId":"pg80414",
            "customProperties":{
                "cust-prop2":"cust-prop2",
                "cust-prop1":"cust-prop1"
            },
            "cancelReason":"would like to use another credit card"
        }
    ]
}
Nested Schema : payments
Type: array
The array of Payment groups to be cancelled from the order.
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : voidPayments_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 from void payment endpoint
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
  • The quantity of free sku for this gift selection that has already been auto added to the order.
  • Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
  • Identifier to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
  • The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
  • String identifying the free gift, usually the repository id of the gift type.
  • The type of the gift. (sku, product)
  • atg.gwp
  • The total quantity of sku for this gift selection.
  • The amount of free quantity that has since been manually removed by a Shopper.
  • The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
  • The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
  • The gift with purchase promotion id
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
  • The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
  • The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
  • items
    The array of products in the shipping group.
  • The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
  • The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
  • The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
  • shippingAddress
    The shipping address details.
  • shippingMethod
    The shipping method details for the order.
  • store
    Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
  • The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup
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)
{
    "orderId":"o50419",
    "paymentResponses":[
        {
            "paymentGroupId":"pg50414",
            "customPaymentProperties":{
                "sample-addnl-property-key2":"sample-payment-property-value2",
                "cust-prop2":"cust-prop2",
                "cust-prop1":"cust-prop1"
            },
            "gatewayName":"PP-A",
            "paymentMethod":"onlinePaymentGroup",
            "paymentState":"REMOVED",
            "message":""
        }
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |51176|An error occurred canceling payment groups.| |51177|An error occurred canceling payment groups.| |51178|The cancellation of payment groups is not allowed.| |51179|The Payment Group is invalid and does not belong to order.|
Body ()
Root Schema : errorModel
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