1. REST API for Oracle Commerce Cloud 21B
  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
The current order representation.
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 : 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 : coupon code
Type: array
Coupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coupon code
Type: object
Coupon Code
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coupon code
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 : 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