1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Webhook
  4. Custom Currency

customCurrency

post

/ccadmin/v1/webhook/customCurrency

This webhook is used for Custom currency Payments

Request

Supported Media Types
Body ()
This webhook is used for Custom currency Payments
Root Schema : customCurrency_request
Type: object
This webhook is used for Custom currency Payments
Show Source
Example:
{
    "loyaltyDetails":[
        {
            "programName":"programForFlyer",
            "membershipId":"member0002",
            "programId":"prg10002",
            "status":"Enrolled"
        },
        {
            "programName":"programForYoungster",
            "membershipId":"member0001",
            "programId":"prg10001",
            "status":"Enrolled"
        }
    ],
    "orderId":"o30417",
    "profile":{
        "phoneNumber":"1234512345",
        "id":"110072",
        "email":"a@a.com"
    },
    "channel":"storefront",
    "locale":"en",
    "transactionId":"o30417-pg30418-1504691722253",
    "transactionTimestamp":"2017-09-06T09:55:22+0000",
    "transactionType":"0600",
    "customProperties":{
        "cust-prop2":"cust-prop2",
        "cust-prop1":"cust-prop1"
    },
    "paymentId":"pg30418",
    "gatewaySettings":{
        "paymentMethodTypes":"loyaltyPoints"
    },
    "paymentMethod":"loyaltyPoints",
    "shippingAddress":{
        "lastName":"a",
        "country":"US",
        "firstName":"a",
        "phoneNumber":"1234512345",
        "address2":null,
        "city":"cambridge",
        "address1":"1 main st",
        "postalCode":"02142",
        "state":"MA",
        "email":"a@a.com"
    },
    "siteId":"siteUS",
    "currencyCode":"PTS",
    "gatewayId":"demoLoyaltyPointsPaymentGateway"
}
Nested Schema : billingAddress
Type: object
billing address details
Show Source
Nested Schema : customProperties
Type: object
key value pair of custom attributes
Show Source
Nested Schema : gatewaySettings
Type: object
Additional Properties Allowed: true
key value pair of gateway settings
Nested Schema : loyaltyDetails
Type: array
profile loyalty programs
Show Source
Nested Schema : order
Type: object
Show Source
Nested Schema : profile
Type: object
Basic profile information.
Show Source
Nested Schema : profile
Type: object
Show Source
Nested Schema : referenceInfo
Type: object
Show Source
Nested Schema : referenceInfos
Type: array
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address
Show Source
Nested Schema : dynamicProperties
Type: array
Dynamic properties list
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : commerceItems
Type: array
The commerce items (sometimes referred to as "line items") represent which actual skus are included in the order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
Nested Schema : priceInfo
Type: object
Pricing information, an instance of OrderPriceInfo.
Show Source
Nested Schema : profile
Type: object
Basic profile information. (read-only)
Show Source
Nested Schema : quoteInfo
Type: object
the quote information of the order
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingGroups
Type: array
Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address. Depending on the shippingMethod i.e. hardgoodShippingGroups, inStorePickupShippingGroup different proporties will be defined with shippingGroups.
Show Source
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : commerceItems
Type: array
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a third party system.
Show Source
Nested Schema : externalPriceDetails
Type: object
Details about external pricing
Show Source
Nested Schema : priceInfo
Type: object
Details about pricing.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
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 : commerceItems
Type: array
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 : externalPriceDetails
Type: object
Details about external pricing
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 : values
Type: object
The array of values associated with an externalData item.
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 : values
Type: object
The array of values associated with an externalData item.
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 : values
Type: object
The array of values associated with an externalData item.
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 : values
Type: object
The array of values associated with an externalData item.
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 : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The map values associated with an externalData item.
Show Source
Nested Schema : currentPriceDetailsSorted
Type: array
The current price details.
Show Source
Nested Schema : itemDiscountInfos
Type: array
Array of item promotions affecting this item.
Show Source
Nested Schema : orderDiscountInfos
Type: array
Array of order promotions affecting this item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : range
Type: object
Represents which specific items are covered by this price info.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCodes
Type: array
One or more coupon codes used to grant the item promotion providing the discount.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCodes
Type: array
One or more coupon codes used to grant the order promotion providing the discount.
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 : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
Nested Schema : parentOrganization
Type: object
Parent organization of the profile
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : errorInfo
Type: array
the array of errors, if any
Show Source
Nested Schema : notes
Type: array
the notes (history) for the order
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 : commerceItemRelationships
Type: array
The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.
Show Source
Nested Schema : handlingInstructions
Type: array
Handling instructions. Currently read-only.
Show Source
Nested Schema : priceInfo
Type: object
The pricing details about this shipping group.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address for this shipping group.
Show Source
Nested Schema : specialInstructions
Type: object
Special instructions for the shipping group. Keys and values are strings.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a third party system.
Show Source
Nested Schema : range
Type: object
The range covered by these commerce items
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The map values associated with an externalData item.
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 : organization
Type: object
Show Source
Nested Schema : secondaryOrganizations
Type: array
List of secondary organizations that need to associate with the user.
Show Source
Nested Schema : contract
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : dynamicProperties
Type: array
Dynamic properties list
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : customCurrency_response
Type: object
Show Source
Nested Schema : authorizationResponse
Type: object
Show Source
Nested Schema : creditResponse
Type: object
Show Source
Nested Schema : inquireBalanceResponse
Type: object
Show Source
Nested Schema : voidResponse
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
key value pair of additional attributes
Show Source
Nested Schema : customPaymentProperties
Type: array
custom attributes
Show Source
Nested Schema : additionalProperties
Type: object
key value pair of additional attributes
Show Source
Nested Schema : customPaymentProperties
Type: object
key value pair of custom attributes
Show Source
Nested Schema : additionalProperties
Type: object
key value pair of additional attributes
Show Source
Nested Schema : customPaymentProperties
Type: object
key value pair of custom attributes
Show Source
Nested Schema : loyaltyPrograms
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
key value pair of additional attributes
Show Source
Nested Schema : loyaltyPointDetails
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
key value pair of additional attributes
Show Source
Nested Schema : additionalProperties
Type: object
key value pair of additional attributes
Show Source
Nested Schema : customPaymentProperties
Type: object
key value pair of custom attributes
Show Source
Example Response (application/json)
{
    "transactionType":"0600",
    "orderId":"o30417",
    "paymentId":"pg30418",
    "channel":"storefront",
    "paymentMethod":"loyaltyPoints",
    "siteId":"siteUS",
    "locale":"en",
    "inquireBalanceResponse":{
        "hostTransactionTimestamp":"1504691722267",
        "responseReason":"inquireBalanceResponseReason",
        "customPaymentProperties":[
            "5000addnl-property-key5",
            "cust-prop2",
            "5000addnl-property-key2",
            "cust-prop1"
        ],
        "responseDescription":"inquireBalanceResponseDescription",
        "loyaltyPrograms":[
            {
                "loyaltyPointDetails":[
                    {
                        "membershipType":"blue",
                        "pointsBalance":"2000",
                        "pointsType":"bluePoints",
                        "additionalProperties":{
                            "propertyName1":"value1",
                            "propertyName2":"value2"
                        }
                    },
                    {
                        "membershipType":"red",
                        "pointsBalance":"6000",
                        "pointsType":"redPoints",
                        "additionalProperties":{
                            "propertyName4":"value4",
                            "propertyName3":"value3"
                        }
                    },
                    {
                        "membershipType":"green",
                        "pointsBalance":"6000",
                        "pointsType":"PTS",
                        "additionalProperties":{
                            "propertyName4":"value4",
                            "propertyName3":"value3"
                        }
                    }
                ],
                "programName":"programForYoungster",
                "membershipId":"member0001",
                "additionalProperties":{
                    "propertyName5":"value5",
                    "validTill":"2029-11-26T15:57:55.631Z",
                    "propertyName6":"value6",
                    "validFrom":"2017-07-14T15:57:55.631Z"
                },
                "programId":"prg10001"
            },
            {
                "loyaltyPointDetails":[
                    {
                        "membershipType":"silver",
                        "pointsBalance":"2000",
                        "pointsType":"rewardPoints",
                        "additionalProperties":{
                            "propertyName7":"value7",
                            "propertyName8":"value8"
                        }
                    },
                    {
                        "membershipType":"gold",
                        "pointsBalance":"6000",
                        "pointsType":"skyMiles",
                        "additionalProperties":{
                            "propertyName10":"value10",
                            "propertyName9":"value9"
                        }
                    }
                ],
                "programName":"programForFlyer",
                "membershipId":"member0002",
                "additionalProperties":{
                    "validTill":"2030-12-26T15:57:55.631Z",
                    "propertyName12":"value12",
                    "propertyName11":"value11",
                    "validFrom":"2017-06-14T15:57:55.631Z"
                },
                "programId":"prg10002"
            }
        ],
        "merchantTransactionId":"MERCH-TX-1504691722267",
        "hostTransactionId":"HOST-TX-1504691722267",
        "additionalProperties":{
            "5000addnl-property-key5":"5000payment-property-value5",
            "5000addnl-property-key4":"5000payment-property-value4",
            "5000addnl-property-key3":"5000payment-property-value3",
            "cust-prop2":"cust-prop2",
            "5000addnl-property-key2":"5000payment-property-value2",
            "cust-prop1":"cust-prop1",
            "5000addnl-property-key1":"5000payment-property-value1"
        },
        "responseCode":"5000",
        "merchantTransactionTimestamp":"1504691722267"
    },
    "currencyCode":"PTS",
    "transactionId":"o30417-pg30418-1504691722253",
    "transactionTimestamp":"2017-09-06T09:55:22+0000",
    "gatewayId":"demoLoyaltyPointsPaymentGateway"
}
Back to Top