1. REST API for Oracle Commerce Cloud 21A
  2. Tasks
  3. Webhook
  4. Generic Payment

genericPayment

post

/ccadmin/v1/webhook/genericPayment

Integrates custom payment gateways that let your store accept various payment types

Request

Supported Media Types
Body ()
Integrates custom payment gateways that let your store accept various payment types
Root Schema : genericPayment_request
Type: object
Integrates custom payment gateways that let your store accept various payment types
Show Source
Example:
{
    "amount":"000000003739",
    "orderId":"o60414",
    "profile":{
        "phoneNumber":"212-555-1977",
        "customerContactId":"externalId",
        "id":"se-570031",
        "email":"kim@example.com"
    },
    "channel":"storefront",
    "locale":"en",
    "transactionId":"o60414-pg60424-1509968593563",
    "transactionTimestamp":"2017-11-06T11:43:13+0000",
    "transactionType":"CASH REQUEST",
    "referenceNumber":"pg60424",
    "gatewaySettings":{
        "merchantId":"merchant id",
        "paymentMethodTypes":"cash",
        "selectedCountries":[
            "AR",
            "AU",
            "BD",
            "BR",
            "CA",
            "CL",
            "CO",
            "FO",
            "DE",
            "IN",
            "IE",
            "MX",
            "MC",
            "PA",
            "PE",
            "ES",
            "LK",
            "GB",
            "US"
        ]
    },
    "paymentMethod":"cash",
    "shippingAddress":{
        "country":"US",
        "lastName":"Anderson",
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "address2":"",
        "city":"Syracuse",
        "address1":"21 Cedar Ave",
        "postalCode":"13202",
        "state":"NY",
        "email":"kim@example.com"
    },
    "siteId":"siteUS",
    "billingAddress":{
        "country":"US",
        "lastName":"Anderson",
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "address2":"",
        "city":"Syracuse",
        "address1":"21 Cedar Ave",
        "postalCode":"13202",
        "state":"NY",
        "email":"kim@example.com"
    },
    "currencyCode":"USD",
    "gatewayId":"cashGatewayTest"
}
Nested Schema : auxiliaryProperties
Type: object
Map additional properties like authenticationMethod(local or guest) and paymentAccountFirstUseDate
Show Source
Nested Schema : billingAddress
Type: object
The billing address.
Show Source
Nested Schema : cardDetails
Type: object
The details of card used for transaction.
Show Source
Nested Schema : customProperties
Type: object
Additional Properties Allowed
Show Source
Additional key/value pairs from the submitted order to be sent to the payment provider.
Nested Schema : gatewaySettings
Type: object
Additional Properties Allowed: true
The settings of the gateway.
Nested Schema : items
Type: array
Information about the item in order
Show Source
Nested Schema : order
Type: object
Show Source
Nested Schema : paymentRequests
Type: array
Gift card payment requests. Applicable only for Gift cards.
Show Source
Nested Schema : profile
Type: object
The basic profile details.
Show Source
Nested Schema : profile
Type: object
Show Source
Nested Schema : referenceInfo
Type: object
Additional Properties Allowed
Show Source
For void/refund transactions
Nested Schema : referenceInfos
Type: array
An array for void/refund transactions
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address
Show Source
Nested Schema : dynamicProperties
Type: array
Dynamic properties list
Show Source
Nested Schema : additionalSavedCardProperties
Type: object
Any custom properties received along with token
Nested Schema : items
Type: object
Show Source
Nested Schema : options
Type: array
The option values
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: array
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 : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
The billing address
Show Source
Nested Schema : cardDetails
Type: object
Gift card information.
Show Source
Nested Schema : gatewaySettings
Type: object
Additional Properties Allowed: true
The gateway settings.
Nested Schema : referenceInfo
Type: object
Additional Properties Allowed
Show Source
For void/refund transactions
Nested Schema : referenceInfos
Type: array
An array for void/refund transactions
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address
Show Source
Nested Schema : dynamicProperties
Type: array
Dynamic properties list
Show Source
Nested Schema : items
Type: object
Additional Properties Allowed
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
Additional Properties Allowed
Show Source
Nested Schema : dynamicProperties
Type: array
Dynamic properties list
Show Source
Back to Top

Response

Supported Media Types

200 Response

Integrates custom payment gateways that let your store accept various payment types
Body ()
Root Schema : genericPayment_response
Type: object
The generic payment response from external service
Show Source
Nested Schema : response
Type: object
Show Source
Nested Schema : addBalanceResponse
Type: array
This response is recieved incase the transactionType is BAL_ADD. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse/tokenizeResponse will be present in 1 response. For gift card.
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : authorizationResponse
Type: array
This response is received incase the transactionType is AUTH. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse/tokenizeResponse will be present in 1 response. This field is an array only for Gift Cards. It is a single object for other payment types.
Show Source
Nested Schema : billingAddress
Type: object
The billing address
Show Source
Nested Schema : captureResponse
Type: array
This response is recieved incase the transactionType is CAPT. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse/tokenizeResponse will be present in 1 response. This field is an array only for Gift Cards. It is a single object for other payment types.
Show Source
Nested Schema : creditResponse
Type: array
This response is recieved incase the transactionType is RFND. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse/tokenizeResponse will be present in 1 response. This field is an array only for Gift Cards. It is a single object for other payment types.
Show Source
Nested Schema : externalProperties
Type: array
External properties.
Show Source
Nested Schema : inquireBalanceResponse
Type: array
This response is recieved incase the transactionType is BAL_INQ. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse/tokenizeResponse will be present in 1 response. For gift card.
Show Source
Nested Schema : items
Type: object
Information about the item
Show Source
Nested Schema : profile
Type: object
The basic profile details
Show Source
Nested Schema : response
Type: object
The received response. Applicable for generic payment type.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address
Show Source
Nested Schema : tokenizeResponse
Type: array
This response is received when the transactionType is TOKENIZE.Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse/tokenizeResponse will be present in 1 response. This field is an array only for Gift Cards. It is a single object for other payment types.
Show Source
Nested Schema : voidResponse
Type: array
This response is recieved incase the transactionType is VOID. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse/tokenizeResponse will be present in 1 response. This field is an array only for Gift Cards. It is a single object for other payment types.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : additionalSavedCardProperties
Type: object
Any custom properties received along with token
Nested Schema : customPaymentProperties
Type: array
Custom payment properties can be sent here.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : options
Type: array
The options values.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : additionalSavedCardProperties
Type: object
Any custom properties received along with token
Nested Schema : customPaymentProperties
Type: array
Custom payment properties can be sent here.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Example Response (application/json)
{
    "amount":3739,
    "orderId":"o60414",
    "authorizationResponse":{
        "responseReason":"1001",
        "merchantTransactionId":"MERCHANT-TRANSACTION-ID",
        "hostTransactionId":"HOST-TRANSACTION-ID",
        "responseCode":"1000",
        "hostResponse":"host-success",
        "token":"token-success"
    },
    "transactionId":"o60414-pg60431-1509968935219",
    "transactionTimestamp":"2017-11-06T11:48:55+0000",
    "transactionType":"CASH REQUEST",
    "customPaymentProperties":[
        "sample-addnl-property-key2"
    ],
    "referenceNumber":"pg60431",
    "paymentMethod":"cash",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/externalCashPayment"
        }
    ],
    "additionalProperties":{
        "sample-addnl-property-key2":"sample-payment-property-value2",
        "sample-addnl-property-key1":"sample-payment-property-value1"
    },
    "currencyCode":"USD",
    "gatewayId":"cashGatewayTest",
    "merchantTransactionTimestamp":1.447807667046E12
}
Back to Top