genericPayment
post
/ccadmin/v1/webhook/genericPayment
Integrates custom payment gateways that let your store accept various payment types
Request
Supported Media Types
- application/json
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
-
amount(optional):
string
The monetary amount.
-
auxiliaryProperties(optional):
object auxiliaryProperties
Map additional properties like authenticationMethod(local or guest) and paymentAccountFirstUseDate
-
billingAddress(optional):
object billingAddress
The billing address.
-
cardDetails(optional):
object cardDetails
The details of card used for transaction.
-
channel(optional):
string
The channel of this payment. For example preview, agent, store
-
currencyCode(optional):
string
The three character currency code. For example: USD.
-
customProperties(optional):
object customProperties
Additional Properties Allowed: additionalPropertiesAdditional key/value pairs from the submitted order to be sent to the payment provider.
-
gatewayId(optional):
string
The name of the gateway.
-
gatewaySettings(optional):
object gatewaySettings
Additional Properties Allowed:
true
The settings of the gateway. -
items(optional):
array items
Information about the item in order
-
locale(optional):
string
The locale of the request
-
order(optional):
object order
The current order representation.
-
orderId(optional):
string
Id of the order
-
organizationId(optional):
string
The ID of the organization for the account to be invoiced.
-
organizationName(optional):
string
The name of the organization for the account to be invoiced.
-
originOfOrder(optional):
string
Origin Of Order
-
paymentId(optional):
string
The Id of the payment group
-
paymentMethod(optional):
string
The payment method eg cash, invoice etc.
-
paymentRequests(optional):
array paymentRequests
Gift card payment requests. Applicable only for Gift cards.
-
PONumber(optional):
string
The purchase order number for the account to be invoiced. This attribute is only for invoice payments.
-
profile(optional):
object profile
The basic profile details.
-
profileDetails(optional):
object profile
-
referenceInfo(optional):
object referenceInfo
Additional Properties Allowed: additionalPropertiesFor void/refund transactions
-
referenceInfos(optional):
array referenceInfos
An array for void/refund transactions
-
referenceNumber(optional):
string
Payment Id for cash transaction
-
retryPaymentCount(optional):
number
The number of times payment has been retried for order
-
shippingAddress(optional):
object shippingAddress
The shipping address
-
siteId(optional):
string
Site ID associated with this request
-
siteURL(optional):
string
site url where order is being placed
-
storeCreditNumber(optional):
string
Store Credit Number
-
transactionId(optional):
string
Transaction id of payment transaction, generated by OCC.
-
transactionTimestamp(optional):
string
The timestamp of the transaction.
-
transactionType(optional):
string
The transaction type e.g. auth, void etc.
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
-
authenticationMethod(optional):
string
Whether registered shopper or guest
-
shopperAccountPaymentAccountFirstUseDate(optional):
string(date-time)
Date, when card was saved
Nested Schema : billingAddress
Type:
object
The billing address.
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
dynamicProperties(optional):
array dynamicProperties
Dynamic properties list
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
state(optional):
string
State.
-
suffix(optional):
string
Name suffix.
Nested Schema : cardDetails
Type:
object
The details of card used for transaction.
Show Source
-
additionalSavedCardProperties(optional):
object additionalSavedCardProperties
Any custom properties received along with token
-
cvv(optional):
string
Card Verification Value.
-
expirationMonth(optional):
string
Two digit month when the credit card expires.
-
expirationYear(optional):
string
Two or four digit year when the credit card expires.
-
holderName(optional):
string
The name of the card holder.
-
maskedCardNumber(optional):
string
The masked card number.
-
number(optional):
string
The credit card number.
-
saveCard(optional):
boolean
Whether to save card or not.
-
storedCardUsed(optional):
boolean
Whether a saved card is used or not
-
token(optional):
string
Token for the saved card
-
tokenExpiryDate(optional):
string
Expiry date for saved card token.
-
type(optional):
string
The type of the credit card e.g. Visa.
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 : order
Type:
object
The current order representation.
Show Source
-
cartName(optional):
string
Cart name for this order.
-
discountInfo(optional):
object discountInfo
Discount Information
-
dynamicProperties(optional):
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
giftWithPurchaseInfo(optional):
array giftWithPurchaseInfo
The gift information.
-
giftWithPurchaseOrderMarkers(optional):
array giftWithPurchaseOrderMarkers
giftWithPurchaseOrderMarker information.
-
orderAction(optional):
string
The action performed on the order.
-
orderId(optional):
string
Order ID of the order to remove.
-
priceInfo(optional):
object priceInfo
Price information of the order.
-
priceListGroup(optional):
object priceListGroup
The price list group object.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
shippingGroups(optional):
array shippingGroups
The shipping groups for the order.
-
shippingMethod(optional):
object shippingMethod
Shipping Method information of the order.
-
shoppingCart(optional):
object shoppingCart
Shopping cart information.
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
-
customerContactId(optional):
string
The external customer contact id.
-
email(optional):
string
Email associated with the profile.
-
id(optional):
string
The profile id.
-
phoneNumber(optional):
string
Phone number associated to the profile.
Nested Schema : profile
Type:
Show Source
object
-
currentOrganization(optional):
object organization
-
email(optional):
string
The email address of the profile
-
firstName(optional):
string
The first name of the profile
-
id(optional):
string
Id
-
lastName(optional):
string
The last name of the profile
-
lastPasswordUpdate(optional):
string(date-time)
Password update date
-
middleName(optional):
string
The middle name of the profile
-
parentOrganization(optional):
object organization
-
profileType(optional):
string
The type of profile
-
receiveEmail(optional):
string
The string representation of whether the user wants to recieve email or not
-
registrationDate(optional):
string(date-time)
Registration date
-
secondaryOrganizations(optional):
array secondaryOrganizations
List of secondary organizations that need to associate with the user.
-
taxExempt(optional):
boolean
if tax is exempted
-
taxExemptionCode(optional):
string
Tax exemption code
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
-
Array of:
object items
Additional Properties Allowed: additionalProperties
Nested Schema : shippingAddress
Type:
object
The shipping address
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
dynamicProperties(optional):
array dynamicProperties
Dynamic properties list
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
state(optional):
string
State.
-
suffix(optional):
string
Name suffix.
-
transactionType(optional):
string
The transaction type e.g. auth, void etc. The following are the allowed transaction types and its codes: |Transaction Type|Transaction Code| |------------------|------------------| |AUTHORIZE|0100| |VOID|0110| |DEBIT|0200| |REDEEM|0300| |REFUND|0400| |REVERSAL|0500| |BALANCE_INQUIRY|0600| |ADD_VALUE|0700| |INITIATE|0800| |RETRIEVE|0900| |TOKENIZE|1000|
Nested Schema : additionalSavedCardProperties
Type:
object
Any custom properties received along with token
Nested Schema : items
Type:
Show Source
object
-
catRefId(optional):
string
The catalog ref id.
-
description(optional):
string
The description of the item.
-
displayName(optional):
string
The display name of item.
-
id(optional):
string
The id of the item.
-
options(optional):
array options
The option values
-
price(optional):
number
The price
-
productId(optional):
string
The id of the product
-
quantity(optional):
number
The quantity ordered.
-
rawTotalPrice(optional):
number
The monetary raw total price.
-
unitPrice(optional):
number
The price of each unit
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The option name
-
optionValue(optional):
string
The option value
Nested Schema : discountInfo
Type:
object
Discount Information
Show Source
-
claimedCouponMultiPromotions(optional):
object claimedCouponMultiPromotions
The coupons that were claimed.
-
orderCouponsMap(optional):
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount(optional):
number
Order Discount
-
orderImplicitDiscountList(optional):
array orderImplicitDiscountList
Implicit Promotions for the order
-
shippingDiscount(optional):
number
Shipping Discount
-
unclaimedCouponMultiPromotions(optional):
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap(optional):
object unclaimedCouponsMap
The coupons that were not claimed
Nested Schema : dynamicProperties
Type:
array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type:
array
giftWithPurchaseOrderMarker information.
Show Source
Nested Schema : priceInfo
Type:
object
Price information of the order.
Show Source
-
amount(optional):
number
Amount of order.
-
currencyCode(optional):
string
Currency code.
-
primaryCurrencyTotal(optional):
number
The current total in loyalty points in case of multi currency
-
secondaryCurrencyShippingAmount(optional):
number
The current total shipping amount in monetry currency
-
secondaryCurrencyShippingSurchargeValue(optional):
number
Extra handling costs for shipping the products in monetry currency.
-
secondaryCurrencyTaxAmount(optional):
number
The current total tax amount in monetry currency
-
secondaryCurrencyTotal(optional):
number
The current total (sum of shipping and tax)amount in monetry currency
-
shipping(optional):
number
Shipping price of order.
-
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.
-
subTotal(optional):
number
Sub total.
-
tax(optional):
number
Tax.
-
taxExclusiveAmount(optional):
number
Total excluding shipping and tax in monetary currency
-
total(optional):
number
Total amount of order.
Nested Schema : priceListGroup
Type:
object
The price list group object.
Show Source
-
repositoryId(optional):
string
Repository ID of the price list group.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.
-
subTotal(optional):
number
The sub-total price of the recurring charge.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
number
The total price of the recurring charge.
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.
Nested Schema : shippingMethod
Type:
object
Shipping Method information of the order.
Show Source
-
cost(optional):
number
Cost of shipping method.
-
secondaryCurrencyShipingAmount(optional):
number
shipping amount in monetry currency
-
secondaryCurrencyTaxAmount(optional):
number
Shipping tax amount in monetry currency
-
value(optional):
string
Shipping method value.
Nested Schema : shoppingCart
Type:
object
Shopping cart information.
Show Source
-
items(optional):
array items
Items in the cart.
-
numberOfItems(optional):
integer
Number of items in the cart.
Nested Schema : claimedCouponMultiPromotions
Type:
object
The coupons that were claimed.
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
object
The coupons that were claimed.
Show Source
-
couponCode(optional):
object couponCode
Coupon Code.
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
Type:
object
The coupons that were not claimed
Show Source
-
couponCode(optional):
object couponCode
Coupon Code.
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.
Nested Schema : couponCode
Type:
object
Coupon Code.
Show Source
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : couponCode
Type:
object
Coupon Code.
Show Source
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
giftWithPurchaseDetail(optional):
string
String identifying the free gift, usually the repository id of the gift type.
-
giftWithPurchaseIdentifier(optional):
integer
An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
giftWithPurchaseQuantityAvailableForSelection(optional):
number
gift quantity available for selection
-
giftWithPurchaseType(optional):
string
The type of the gift. (sku, product)
-
promotionId(optional):
string
The gift with purchase promotion id
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity(optional):
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove(optional):
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data(optional):
integer
Identifier to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
failedQuantity(optional):
number
The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
-
giftDetail(optional):
string
String identifying the free gift, usually the repository id of the gift type.
-
giftType(optional):
string
The type of the gift. (sku, product)
-
key(optional):
string
atg.gwp
-
quantity(optional):
number
The total quantity of sku for this gift selection.
-
removedQuantity(optional):
number
The amount of free quantity that has since been manually removed by a Shopper.
-
selectedQuantity(optional):
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity(optional):
number
The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
-
value(optional):
string
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:
Show Source
object
-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.
-
total(optional):
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.
-
tax(optional):
string
The tax amount for the frequency.
Nested Schema : items
Type:
Show Source
object
-
email(optional):
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName(optional):
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
items(optional):
array items
The array of products in the shipping group.
-
lastName(optional):
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
middleName(optional):
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber(optional):
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
shippingAddress(optional):
object shippingAddress
The shipping address details.
-
shippingMethod(optional):
object shippingMethod
The shipping method details for the order.
-
store(optional):
object store
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
type(optional):
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup
Nested Schema : shippingAddress
Type:
object
The shipping address details.
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
selectedCountry(optional):
string
Country code.
-
selectedState(optional):
string
State code.
-
state(optional):
string
State.
-
state_ISOCode(optional):
string
State ISO code.
-
suffix(optional):
string
Name suffix.
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
Show Source
-
cost(optional):
number
The total cost of shipping.
-
shippingMethodDescription(optional):
string
The description of the shipping method.
-
shippingTax(optional):
number
The shipping tax.
-
value(optional):
string
The shipping method applied to the order.
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
-
address1(optional):
string
Address line 1 of the store.
-
address2(optional):
string
Address line 2 of the store.
-
address3(optional):
string
Address line 3 of the store.
-
city(optional):
string
The city in which the store resides.
-
country(optional):
string
The country in which the store resides.
-
county(optional):
string
The county in which the store resides.
-
email(optional):
string
The email address of the store.
-
faxNumber(optional):
string
The fax number of the store.
-
hours(optional):
string
The opening hours of the store.
-
locationId(optional):
string
The location id of the store.
-
name(optional):
string
Name of the store.
-
phoneNumber(optional):
string
The phone number of the store.
-
postalCode(optional):
string
The postal code of the store.
-
stateAddress(optional):
string
The state in which the store resides.
Nested Schema : items
Type:
Show Source
object
-
availablePickupDate(optional):
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
catRefId(optional):
string
The product variant Id.
-
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
preferredPickupDate(optional):
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product in this shipping group.
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
state(optional):
string
state of the commerce Item
-
variant(optional):
array variant
List of variants for the product.
Nested Schema : dynamicProperties
Type:
array
Array of custom properties at order line item level.
Show Source
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the Dynamic SKU Property.
-
name(optional):
string
Name of the Dynamic SKU Property.
-
propertyType(optional):
string
Type that indicates whether it is a base or a custom SKU property,
-
value(optional):
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The variant option name.
-
optionValue(optional):
string
The variant option value.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetId(optional):
string
The asset ID corresponding to the current item.
-
assetKey(optional):
string
The assetKey ID associated to the current item.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Sku reference id.
-
childItems(optional):
array childItems
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.
-
commerceItemId(optional):
string
The unique line item ID distinguisher.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice(optional):
number
A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
-
externalPriceQuantity(optional):
integer
The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
giftWithPurchaseCommerceItemMarkers(optional):
array giftWithPurchaseCommerceItemMarkers
giftWithPurchaseCommerceItemMarker information.
-
id(optional):
string
Repository id of the commerce item.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey ID associated to the current item.
-
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
price(optional):
number
Price of the items.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
Quantity of the items.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
rootAssetKey(optional):
string
The rootAssetKey ID associated to the current item.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
state(optional):
string
state of the commerce Item
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
variant(optional):
array variant
List of variants for the product.
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
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
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 : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (externally configured) or not (externally configured).
-
amount(optional):
integer
The total amount of this item including its child items amounts.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetId(optional):
string
The asset ID corresponding to the current item.
-
assetKey(optional):
string
The assetKey ID associated to the current item.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
skuid of the item.
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
displayName(optional):
string
The name of the product.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice(optional):
number
A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
-
externalPriceQuantity(optional):
integer
The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
id(optional):
string
Repository id of the commerce item.
-
parentAssetKey(optional):
string
The parentAssetKey ID associated to the current item.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product.
-
rawTotalPrice(optional):
integer
The raw price of the product.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
rootAssetKey(optional):
string
The rootAssetKey ID associated to the current item.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
state(optional):
string
state of the commerce Item
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice(optional):
integer
The unit price of the product.
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
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:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.
-
data(optional):
integer
The gift hash code for this gift with purchase promotion.
-
key(optional):
string
atg.gwp
-
remainingQuantity(optional):
number
The quantity of the commerce item that is not affected by gift with purchase.
-
selectedQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.
-
targetedQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.
-
value(optional):
string
The gift with purchase promotion id.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the Dynamic SKU Property.
-
name(optional):
string
Name of the Dynamic SKU Property.
-
propertyType(optional):
string
Type that indicates whether it is a base or a custom SKU property,
-
value(optional):
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The variant option name.
-
optionValue(optional):
string
The variant option value.
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
string
The amount paid
-
billingAddress(optional):
object billingAddress
The billing address
-
cardDetails(optional):
object cardDetails
Gift card information.
-
gatewayId(optional):
string
The gateway id
-
gatewaySettings(optional):
object gatewaySettings
Additional Properties Allowed:
true
The gateway settings. -
paymentId(optional):
string
The Id of the payment group
-
paymentMethod(optional):
string
The payment method
-
referenceInfo(optional):
object referenceInfo
Additional Properties Allowed: additionalPropertiesFor void/refund transactions
-
referenceInfos(optional):
array referenceInfos
An array for void/refund transactions
-
shippingAddress(optional):
object shippingAddress
The shipping address
-
transactionId(optional):
string
The transaction ID.
-
transactionTimestamp(optional):
string
The timestamp of the transaction.
Nested Schema : billingAddress
Type:
object
The billing address
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
dynamicProperties(optional):
array dynamicProperties
Dynamic properties list
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
state(optional):
string
State.
-
suffix(optional):
string
Name suffix.
Nested Schema : cardDetails
Type:
object
Gift card information.
Show Source
-
giftCardNumber(optional):
string
Gift card number.
-
giftCardPin(optional):
string
Gift card pin.
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
-
Array of:
object items
Additional Properties Allowed: additionalProperties
Nested Schema : shippingAddress
Type:
object
The shipping address
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
state(optional):
string
State.
-
suffix(optional):
string
Name suffix.
Nested Schema : organization
Type:
Show Source
object
-
contract(optional):
object contract
-
description(optional):
string
Description of the Organization
-
id(optional):
string
The Organization Id
-
name(optional):
string
Name of the Organization
Nested Schema : secondaryOrganizations
Type:
array
List of secondary organizations that need to associate with the user.
Show Source
Nested Schema : contract
Type:
Show Source
object
-
description(optional):
string
Description name of the contract
-
displayName(optional):
string
Display name of the contract
-
id(optional):
string
The contract Id
Response
Supported Media Types
- application/json
200 Response
Integrates custom payment gateways that let your store accept various payment types
Root Schema : genericPayment_response
Type:
object
The generic payment response from external service
Show Source
Nested Schema : response
Type:
Show Source
object
-
addBalanceResponse(optional):
array addBalanceResponse
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.
-
additionalProperties(optional):
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey/value pairs for additional properties sent by the merchant
-
amount(optional):
number
The monetary amount. Mandatory for gift cards and generic payment type.
-
authorizationResponse(optional):
array authorizationResponse
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.
-
billingAddress(optional):
object billingAddress
The billing address
-
captureResponse(optional):
array captureResponse
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.
-
channel(optional):
string
The channel of this order. Echoed from request. Mandatory for gift cards.
-
creditResponse(optional):
array creditResponse
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.
-
currencyCode(optional):
string
The three character currency code. For example: USD. Mandatory for cash, gift cards and generic payment type.
-
externalOrganizationId(optional):
string
External id of the organization.
-
externalProperties(optional):
array externalProperties
External properties.
-
gatewayId(optional):
string
The name of the gateway.
-
hostTransactionId(optional):
string
The transaction ID returned by the gateway.
-
hostTransactionTimestamp(optional):
string
The host timestamp of the transaction. Mandatory for generic payment type.
-
inquireBalanceResponse(optional):
array inquireBalanceResponse
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.
-
items(optional):
object items
Information about the item
-
locale(optional):
string
The locale echoed from request. Mandatory attribute.
-
merchantTransactionId(optional):
string
The transaction ID returned by the merchant. Mandatory for cash and generic payment type.
-
merchantTransactionTimestamp(optional):
string
The merchant timestamp of the transaction. Mandatory for cash.
-
orderId(optional):
string
Id of the order. Echoed from request. Mandatory attribute.
-
organizationId(optional):
string
The ID of the organization for the invoiced account.
-
organizationName(optional):
string
The name of the organization for the invoiced account.
-
paymentId(optional):
string
The Id of the payment group. Mandatory attribute.
-
paymentMethod(optional):
string
The payment method eg cash, invoice etc, echoed from request. Mandatory for cash and invoice.
-
PONumber(optional):
string
The purchase order number for the invoiced account.
-
profile(optional):
object profile
The basic profile details
-
referenceNumber(optional):
string
Payment Id for cash transaction.
-
response(optional):
object response
The received response. Applicable for generic payment type.
-
shippingAddress(optional):
object shippingAddress
The shipping address
-
tokenizeResponse(optional):
array tokenizeResponse
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.
-
transactionId(optional):
string
Transaction id of payment transaction, generated by OCC. Mandatory for cash and invoice.
-
transactionTimestamp(optional):
string
The timestamp of the transaction.
-
transactionType(optional):
string
The transaction type eg auth, void etc, echoed from request. Mandatory attribute. The following are the allowed transaction types and its codes: |Transaction Type|Transaction Code| |------------------|------------------| |AUTHORIZE|0100| |VOID|0110| |DEBIT|0200| |REDEEM|0300| |REFUND|0400| |REVERSAL|0500| |BALANCE_INQUIRY|0600| |ADD_VALUE|0700| |INITIATE|0800| |RETRIEVE|0900| |TOKENIZE|1000|
-
voidResponse(optional):
array voidResponse
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.
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 : billingAddress
Type:
object
The billing address
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
state(optional):
string
State.
-
suffix(optional):
string
Name suffix.
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
-
Array of:
string
the item
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
-
catRefId(optional):
string
The catalog ref id.
-
description(optional):
string
The description
-
displayName(optional):
string
The display name
-
id(optional):
string
The id of the item.
-
options(optional):
array options
The options values.
-
price(optional):
number
The price
-
productId(optional):
string
The id of the product
-
quantity(optional):
number
The quantity
-
rawTotalPrice(optional):
number
The monetary raw total price.
-
unitPrice(optional):
number
The price of each unit
Nested Schema : profile
Type:
object
The basic profile details
Show Source
-
email(optional):
string
Email associated with the profile.
-
id(optional):
string
The profile id.
-
phoneNumber(optional):
string
Phone number associated to the profile.
Nested Schema : response
Type:
object
The received response. Applicable for generic payment type.
Show Source
-
code(optional):
string
The code of the response.
-
description(optional):
string
The description of the response.
-
reason(optional):
string
The reason of the response.
-
success(optional):
boolean
Boolean value on basis of success or failure of transaction. Mandatory attribute
-
type(optional):
string
The type of the response. use 'sale' to settle/capture for the 'generic' payment type
Nested Schema : shippingAddress
Type:
object
The shipping address
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
state(optional):
string
State.
-
suffix(optional):
string
Name suffix.
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:
Show Source
object
-
additionalProperties(optional):
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey/value pairs for additional properties sent by the merchant
-
amount(optional):
number
The monetary amount. Mandatory attribute.
-
currencyCode(optional):
string
The three character currency code. For example: USD.
-
gatewayId(optional):
string
Reflects the same gateway ID of the corresponding request. Mandatory attribute.
-
hostTransactionId(optional):
string
The transaction ID returned by the gateway
-
hostTransactionTimestamp(optional):
string
The host timestamp of the transaction.
-
merchantTransactionId(optional):
string
The transaction ID returned by the merchant. Mandatory attribute.
-
merchantTransactionTimestamp(optional):
string
The merchant timestamp of the transaction. Mandatory attribute.
-
paymentId(optional):
string
Reflects the same paymentId of the corresponding request. Mandatory attribute.
-
paymentMethod(optional):
string
Reflects the same payment method of the corresponding request. Mandatory attribute.
-
responseCode(optional):
string
Returned response code. Mandatory attribute. The following are the valid response codes based on the response types |Response Type|Response Code| |------------------|------------------| |AUTHORIZE|0100| |AUTHORIZE_SUCCESS|1000| |AUTHORIZE_DECLINE|9000| |VOID_ACCEPTED|2000| |VOID_REJECTED|8000| |REFUND_ACCEPTED|3000| |REFUND_REJECTED|7000| |SALE_COMPLETE|4000| |INQUIRE_BALANCE_SUCCESS|5000| |INQUIRE_BALANCE_DECLINE|6000| |DEBIT_ACCEPTED|11000| |DEBIT_REJECTED|12000| |ADD_BALANCE_SUCCESS|15000| |ADD_BALANCE_REJECTED|16000| |PAYER_AUTH_REQUIRED|10000| |TOKENIZE_SUCCESS|17000| |TOKENIZE_DECLINE|18000|
-
responseDescription(optional):
string
The description of the response. Optional attribute
-
responseReason(optional):
string
Response reason. Optional attribute
-
transactionId(optional):
string
Reflects the same transaction ID of the corresponding request. Mandatory attribute.
-
transactionTimestamp(optional):
string
Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.
-
transactionType(optional):
string
The transaction type eg auth,void etc. The following are the allowed transaction types and its codes: |Transaction Type|Transaction Code| |------------------|------------------| |AUTHORIZE|0100| |VOID|0110| |DEBIT|0200| |REDEEM|0300| |REFUND|0400| |REVERSAL|0500| |BALANCE_INQUIRY|0600| |ADD_VALUE|0700| |INITIATE|0800| |RETRIEVE|0900| |TOKENIZE|1000|
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : items
Type:
Show Source
object
-
additionalProperties(optional):
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey/value pairs for additional properties sent by the merchant
-
amount(optional):
number
The monetary amount. Mandatory attribute.
-
currencyCode(optional):
string
The three character currency code. For example: USD.
-
gatewayId(optional):
string
Reflects the same gateway ID of the corresponding request. Mandatory attribute.
-
hostTransactionId(optional):
string
The transaction ID returned by the gateway
-
hostTransactionTimestamp(optional):
string
The host timestamp of the transaction.
-
merchantTransactionId(optional):
string
The transaction ID returned by the merchant. Mandatory attribute.
-
merchantTransactionTimestamp(optional):
string
The merchant timestamp of the transaction. Mandatory attribute.
-
paymentId(optional):
string
Reflects the same paymentId of the corresponding request. Mandatory attribute.
-
paymentMethod(optional):
string
Reflects the same payment method of the corresponding request. Mandatory attribute.
-
responseCode(optional):
string
Returned code of response. Mandatory attribute. The following are the valid response codes based on the response types |Response Type|Response Code| |------------------|------------------| |AUTHORIZE|0100| |AUTHORIZE_SUCCESS|1000| |AUTHORIZE_DECLINE|9000| |VOID_ACCEPTED|2000| |VOID_REJECTED|8000| |REFUND_ACCEPTED|3000| |REFUND_REJECTED|7000| |SALE_COMPLETE|4000| |INQUIRE_BALANCE_SUCCESS|5000| |INQUIRE_BALANCE_DECLINE|6000| |DEBIT_ACCEPTED|11000| |DEBIT_REJECTED|12000| |ADD_BALANCE_SUCCESS|15000| |ADD_BALANCE_REJECTED|16000| |PAYER_AUTH_REQUIRED|10000| |TOKENIZE_SUCCESS|17000| |TOKENIZE_DECLINE|18000|
-
responseDescription(optional):
string
The description of the response. Optional attribute
-
responseReason(optional):
string
Response reason. Optional attribute
-
token(optional):
string
Represents the token
-
transactionId(optional):
string
Reflects the same transaction ID of the corresponding request. Mandatory attribute.
-
transactionTimestamp(optional):
string
Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.
-
transactionType(optional):
string
The transaction type eg auth,void etc. The following are the allowed transaction types and its codes: |Transaction Type|Transaction Code| |------------------|------------------| |AUTHORIZE|0100| |VOID|0110| |DEBIT|0200| |REDEEM|0300| |REFUND|0400| |REVERSAL|0500| |BALANCE_INQUIRY|0600| |ADD_VALUE|0700| |INITIATE|0800| |RETRIEVE|0900| |TOKENIZE|1000|
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : items
Type:
Show Source
object
-
additionalProperties(optional):
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey/value pairs for additional properties sent by the merchant
-
amount(optional):
number
The monetary amount. Mandatory attribute.
-
currencyCode(optional):
string
The three character currency code. For example: USD.
-
gatewayId(optional):
string
Reflects the same gateway ID of the corresponding request. Mandatory attribute.
-
hostTransactionId(optional):
string
The transaction ID returned by the gateway
-
hostTransactionTimestamp(optional):
string
The host timestamp of the transaction.
-
merchantTransactionId(optional):
string
The transaction ID returned by the merchant. Mandatory attribute.
-
merchantTransactionTimestamp(optional):
string
The merchant timestamp of the transaction. Mandatory attribute.
-
paymentId(optional):
string
Reflects the same paymentId of the corresponding request. Mandatory attribute.
-
paymentMethod(optional):
string
Reflects the same payment method of the corresponding request. Mandatory attribute.
-
responseCode(optional):
string
Returned code of response. Mandatory attribute. The following are the valid response codes based on the response types |Response Type|Response Code| |------------------|------------------| |AUTHORIZE|0100| |AUTHORIZE_SUCCESS|1000| |AUTHORIZE_DECLINE|9000| |VOID_ACCEPTED|2000| |VOID_REJECTED|8000| |REFUND_ACCEPTED|3000| |REFUND_REJECTED|7000| |SALE_COMPLETE|4000| |INQUIRE_BALANCE_SUCCESS|5000| |INQUIRE_BALANCE_DECLINE|6000| |DEBIT_ACCEPTED|11000| |DEBIT_REJECTED|12000| |ADD_BALANCE_SUCCESS|15000| |ADD_BALANCE_REJECTED|16000| |PAYER_AUTH_REQUIRED|10000| |TOKENIZE_SUCCESS|17000| |TOKENIZE_DECLINE|18000|
-
responseDescription(optional):
string
The description of the response. Optional attribute
-
responseReason(optional):
string
Response reason. Optional attribute
-
transactionId(optional):
string
Reflects the same transaction ID of the corresponding request. Mandatory attribute.
-
transactionTimestamp(optional):
string
Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.
-
transactionType(optional):
string
The transaction type eg auth,void etc. The following are the allowed transaction types and its codes: |Transaction Type|Transaction Code| |------------------|------------------| |AUTHORIZE|0100| |VOID|0110| |DEBIT|0200| |REDEEM|0300| |REFUND|0400| |REVERSAL|0500| |BALANCE_INQUIRY|0600| |ADD_VALUE|0700| |INITIATE|0800| |RETRIEVE|0900| |TOKENIZE|1000|
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : items
Type:
Show Source
object
-
additionalProperties(optional):
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey/value pairs for additional properties sent by the merchant
-
amount(optional):
number
The monetary amount. Mandatory attribute.
-
currencyCode(optional):
string
The three character currency code. For example: USD.
-
gatewayId(optional):
string
Reflects the same gateway ID of the corresponding request. Mandatory attribute.
-
hostTransactionId(optional):
string
The transaction ID returned by the gateway
-
hostTransactionTimestamp(optional):
string
The host timestamp of the transaction.
-
merchantTransactionId(optional):
string
The transaction ID returned by the merchant. Mandatory attribute.
-
merchantTransactionTimestamp(optional):
string
The merchant timestamp of the transaction. Mandatory attribute.
-
paymentId(optional):
string
Reflects the same paymentId of the corresponding request. Mandatory attribute.
-
paymentMethod(optional):
string
Reflects the same payment method of the corresponding request. Mandatory attribute.
-
responseCode(optional):
string
Returned code of response. Mandatory attribute. The following are the valid response codes based on the response types |Response Type|Response Code| |------------------|------------------| |AUTHORIZE|0100| |AUTHORIZE_SUCCESS|1000| |AUTHORIZE_DECLINE|9000| |VOID_ACCEPTED|2000| |VOID_REJECTED|8000| |REFUND_ACCEPTED|3000| |REFUND_REJECTED|7000| |SALE_COMPLETE|4000| |INQUIRE_BALANCE_SUCCESS|5000| |INQUIRE_BALANCE_DECLINE|6000| |DEBIT_ACCEPTED|11000| |DEBIT_REJECTED|12000| |ADD_BALANCE_SUCCESS|15000| |ADD_BALANCE_REJECTED|16000| |PAYER_AUTH_REQUIRED|10000| |TOKENIZE_SUCCESS|17000| |TOKENIZE_DECLINE|18000|
-
responseDescription(optional):
string
The description of the response. Optional attribute
-
responseReason(optional):
string
Response reason. Optional attribute
-
transactionId(optional):
string
Reflects the same transaction ID of the corresponding request. Mandatory attribute.
-
transactionTimestamp(optional):
string
Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.
-
transactionType(optional):
string
The transaction type eg auth,void etc. The following are the allowed transaction types and its codes: |Transaction Type|Transaction Code| |------------------|------------------| |AUTHORIZE|0100| |VOID|0110| |DEBIT|0200| |REDEEM|0300| |REFUND|0400| |REVERSAL|0500| |BALANCE_INQUIRY|0600| |ADD_VALUE|0700| |INITIATE|0800| |RETRIEVE|0900| |TOKENIZE|1000|
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
Key/value pairs for additional properties sent by the merchant
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The options name.
-
optionValue(optional):
string
The options value.
Nested Schema : items
Type:
Show Source
object
-
additionalProperties(optional):
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey/value pairs for additional properties sent by the merchant
-
additionalSavedCardProperties(optional):
object additionalSavedCardProperties
Any custom properties received along with token
-
customPaymentProperties(optional):
array customPaymentProperties
Custom payment properties can be sent here.
-
gatewayId(optional):
string
Reflects the same gateway ID of the corresponding request. Mandatory attribute.
-
hostTransactionId(optional):
string
The transaction ID returned by the gateway
-
hostTransactionTimestamp(optional):
string
The host timestamp of the transaction.
-
merchantTransactionId(optional):
string
The transaction ID returned by the merchant. Mandatory attribute.
-
merchantTransactionTimestamp(optional):
string
The merchant timestamp of the transaction. Mandatory attribute.
-
paymentMethod(optional):
string
Reflects the same payment method of the corresponding request. Mandatory attribute.
-
responseCode(optional):
string
Returned code of response. Mandatory attribute. The following are the valid response codes based on the response types |Response Type|Response Code| |------------------|------------------| |AUTHORIZE|0100| |AUTHORIZE_SUCCESS|1000| |AUTHORIZE_DECLINE|9000| |VOID_ACCEPTED|2000| |VOID_REJECTED|8000| |REFUND_ACCEPTED|3000| |REFUND_REJECTED|7000| |SALE_COMPLETE|4000| |INQUIRE_BALANCE_SUCCESS|5000| |INQUIRE_BALANCE_DECLINE|6000| |DEBIT_ACCEPTED|11000| |DEBIT_REJECTED|12000| |ADD_BALANCE_SUCCESS|15000| |ADD_BALANCE_REJECTED|16000| |PAYER_AUTH_REQUIRED|10000| |TOKENIZE_SUCCESS|17000| |TOKENIZE_DECLINE|18000|
-
responseDescription(optional):
string
The description of the response. Optional attribute
-
responseReason(optional):
string
Response reason. Optional attribute
-
token(optional):
string
Represents the token
-
tokenExpiryDate(optional):
string
Represents the token
-
transactionId(optional):
string
Reflects the same transaction ID of the corresponding request. Mandatory attribute.
-
transactionTimestamp(optional):
string
Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.
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:
Show Source
object
-
additionalProperties(optional):
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey/value pairs for additional properties sent by the merchant
-
amount(optional):
number
The monetary amount. Mandatory attribute.
-
currencyCode(optional):
string
The three character currency code. For example: USD.
-
gatewayId(optional):
string
Reflects the same gateway ID of the corresponding request. Mandatory attribute.
-
hostTransactionId(optional):
string
The transaction ID returned by the gateway
-
hostTransactionTimestamp(optional):
string
The host timestamp of the transaction.
-
merchantTransactionId(optional):
string
The transaction ID returned by the merchant. Mandatory attribute.
-
merchantTransactionTimestamp(optional):
string
The merchant timestamp of the transaction. Mandatory attribute.
-
paymentId(optional):
string
Reflects the same paymentId of the corresponding request. Mandatory attribute.
-
paymentMethod(optional):
string
Reflects the same payment method of the corresponding request. Mandatory attribute.
-
responseCode(optional):
string
Returned code of response. Mandatory attribute. The following are the valid response codes based on the response types |Response Type|Response Code| |------------------|------------------| |AUTHORIZE|0100| |AUTHORIZE_SUCCESS|1000| |AUTHORIZE_DECLINE|9000| |VOID_ACCEPTED|2000| |VOID_REJECTED|8000| |REFUND_ACCEPTED|3000| |REFUND_REJECTED|7000| |SALE_COMPLETE|4000| |INQUIRE_BALANCE_SUCCESS|5000| |INQUIRE_BALANCE_DECLINE|6000| |DEBIT_ACCEPTED|11000| |DEBIT_REJECTED|12000| |ADD_BALANCE_SUCCESS|15000| |ADD_BALANCE_REJECTED|16000| |PAYER_AUTH_REQUIRED|10000| |TOKENIZE_SUCCESS|17000| |TOKENIZE_DECLINE|18000|
-
responseDescription(optional):
string
The description of the response. Optional attribute
-
responseReason(optional):
string
Response reason. Optional attribute
-
transactionId(optional):
string
Reflects the same transaction ID of the corresponding request. Mandatory attribute.
-
transactionTimestamp(optional):
string
Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.
-
transactionType(optional):
string
The transaction type eg auth,void etc. The following are the allowed transaction types and its codes: |Transaction Type|Transaction Code| |------------------|------------------| |AUTHORIZE|0100| |VOID|0110| |DEBIT|0200| |REDEEM|0300| |REFUND|0400| |REVERSAL|0500| |BALANCE_INQUIRY|0600| |ADD_VALUE|0700| |INITIATE|0800| |RETRIEVE|0900| |TOKENIZE|1000|
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
}