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

genericCardPayment

post

/ccadmin/v1/webhook/genericCardPayment

Integrates custom payment gateways that let your store accept card payment.

Request

Supported Media Types
Body ()
Integrates custom payment gateways that let your store accept card payment.
Root Schema : genericCardPayment_request
Type: object
Integrates custom payment gateways that let your store accept card payment.
Show Source
Example:
{
    "amount":"000000068148",
    "orderId":"o60411",
    "profile":{
        "phoneNumber":"212-555-1977",
        "id":"se-570031",
        "email":"kim@example.com"
    },
    "channel":"storefront",
    "locale":"en",
    "transactionId":"o60411-pg60414-1509966500257",
    "transactionTimestamp":"2017-11-06T11:08:20+0000",
    "transactionType":"0100",
    "paymentId":"pg60414",
    "cardDetails":{
        "expirationYear":"2018",
        "number":"4111111111111111",
        "holderName":"Kim",
        "cvv":"123",
        "expirationMonth":"03",
        "type":"visa"
    },
    "paymentMethod":"card",
    "shippingAddress":{
        "country":"US",
        "lastName":"Anderson",
        "address3":"",
        "address2":"",
        "city":"Syracuse",
        "address1":"21 Cedar Ave",
        "prefix":"",
        "companyName":"",
        "jobTitle":"",
        "postalCode":"13202",
        "county":"",
        "suffix":"",
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "faxNumber":"",
        "middleName":"",
        "state":"NY",
        "email":"kim@example.com"
    },
    "gatewaySettings":{
        "filteredFields":[
            "merchantId",
            "paymentMethodTypes"
        ],
        "merchantId":"merchant id",
        "paymentMethodTypes":"card"
    },
    "siteId":"siteUS",
    "billingAddress":{
        "country":"US",
        "lastName":"Anderson",
        "address3":"",
        "address2":"",
        "city":"Syracuse",
        "address1":"21 Cedar Ave",
        "prefix":"",
        "companyName":"",
        "jobTitle":"",
        "postalCode":"13202",
        "county":"",
        "suffix":"",
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "faxNumber":"",
        "middleName":"",
        "state":"NY",
        "email":"kim@example.com"
    },
    "currencyCode":"USD",
    "gatewayId":"gatewayTest"
}
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 : gatewaySettings
Type: object
Additional Properties Allowed: true
The settings of the gateway.
Nested Schema : order
Type: object
The current order representation.
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 : shippingAddress
Type: object
The shipping address
Show Source
Nested Schema : dynamicProperties
Type: array
Dynamic properties list
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 : 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 : 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 card payment.
Body ()
Root Schema : genericCardPayment_response
Type: object
The generic card payment response from external service
Show Source
Nested Schema : response
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 : authorizationResponse
Type: array
This response is received incase the transactionType is AUTH. Only one of authorizationResponse/voidResponse/creditResponse will be present in 1 response.
Show Source
Nested Schema : creditResponse
Type: array
This response is recieved incase the transactionType is RFND. Only one of authorizationResponse/voidResponse/creditResponse will be present in 1 response.
Show Source
Nested Schema : voidResponse
Type: array
This response is recieved incase the transactionType is VOID. Only one of authorizationResponse/voidResponse/creditResponse will be present in 1 response.
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 : 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
Example Response (application/json)
{
    "hostTransactionTimestamp":"1447807667046",
    "amount":"000000068148",
    "orderId":"o60411",
    "authorizationResponse":{
        "responseReason":"1001",
        "authCode":"AUTH-ACCEPT",
        "hostTransactionId":"HOST-TRANSACTION-ID",
        "responseCode":"1000",
        "hostResponse":"host-success",
        "token":"token-success"
    },
    "transactionId":"o60411-pg60414-1509966500257",
    "transactionTimestamp":"2017-11-06T11:08:20+0000",
    "transactionType":"0100",
    "customPaymentProperties":[
        "sample-addnl-property-key2"
    ],
    "paymentId":"pg60414",
    "paymentMethod":"card",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/externalPayment"
        }
    ],
    "additionalProperties":{
        "sample-addnl-property-key2":"sample-payment-property-value2",
        "acsUrl":"http://oracle.com",
        "delayinmillis":"100000",
        "sample-addnl-property-key1":"sample-payment-property-value1",
        "amex-card-number":"3711111111111111",
        "random-properties":"1234567890123456789",
        "termUrl":"http://localhost",
        "MD":"MyMDoracle.com",
        "visa-card-number":"4111111111111111",
        "PAReq":"oracle.com1234",
        "dispalyMessage":"Please WAIT.....",
        "maxRetryCount":"30"
    },
    "currencyCode":"USD",
    "gatewayId":"gatewayTest"
}
Back to Top