REST API for Oracle Commerce Cloud December 2017

genericCardPayment

post

/ccadmin/v1/webhook/genericCardPayment

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

Request

Supported Media Types

application/json

Body Parameter

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

Root Schema : genericCardPayment_request

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

Properties

request: Type: object request

Additional Properties Allowed:

Nested Schema : request

Type: object

Properties

amount: Type: number

The monetary amount.
billingAddress: Type: object billingAddress

Additional Properties Allowed:

The billing address.
cardDetails: Type: object cardDetails

Additional Properties Allowed:

The details of card used for transaction.
channel: Type: string

The channel of this payment. For example preview, agent, store
currencyCode: Type: string

The three character currency code. For example: USD.
gatewayId: Type: string

The name of the gateway.
gatewaySettings: Type: object gatewaySettings

Additional Properties Allowed: { "type":"string" }

The settings of the gateway.
locale: Type: string

The locale of the request
orderId: Type: string

Id of the order
paymentId: Type: string

The Id of the payment group
paymentMethod: Type: string

The payment method is card.
profile: Type: object profile

Additional Properties Allowed:

The basic profile details.
referenceInfo: Type: object referenceInfo

Additional Properties Allowed: { "type":"string" }

For void/refund transactions
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address
siteId: Type: string

Site ID associated with this request
transactionId: Type: string

Transaction id of payment transaction, generated by OCC.
transactionTimestamp: Type: string

The timestamp of the transaction.
transactionType: Type: string

The transaction type e.g. auth, void etc.

Nested Schema : billingAddress

Type: object

The billing address.

Properties

address1: Type: string

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
city: Type: string

City.
companyName: Type: string

Company name.
country: Type: string

Country.
county: Type: string

County.
email: Type: string

Email address.
faxNumber: Type: string

Fax number.
firstName: Type: string

First name
jobTitle: Type: string

Job title.
lastName: Type: string

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Postal code.
prefix: Type: string

Name prefix.
state: Type: string

State.
suffix: Type: string

Name suffix.

Nested Schema : cardDetails

Type: object

The details of card used for transaction.

Properties

cvv: Type: string

Card Verification Value.
expirationMonth: Type: string

Two digit month when the credit card expires.
expirationYear: Type: string

Two or four digit year when the credit card expires.
holderName: Type: string

The name of the card holder.
number: Type: string

The credit card number.
type: Type: string

The type of the credit card e.g. Visa.

Nested Schema : gatewaySettings

Type: object

Additional Properties Allowed

Type: string

The settings of the gateway.

Nested Schema : profile

Type: object

The basic profile details.

Properties

email: Type: string

Email associated with the profile.
id: Type: string

The profile id.
phoneNumber: Type: string

Phone number associated to the profile.

Nested Schema : referenceInfo

Type: object

Additional Properties Allowed

Type: string

For void/refund transactions

Nested Schema : shippingAddress

Type: object

The shipping address

Properties

address1: Type: string

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
city: Type: string

City.
companyName: Type: string

Company name.
country: Type: string

Country.
county: Type: string

County.
email: Type: string

Email address.
faxNumber: Type: string

Fax number.
firstName: Type: string

First name
jobTitle: Type: string

Job title.
lastName: Type: string

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Postal code.
prefix: Type: string

Name prefix.
state: Type: string

State.
suffix: Type: string

Name suffix.

Response

Supported Media Types

application/json

200 Response

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

Body

The generic card payment response from external service

Root Schema : genericCardPayment_response

The generic card payment response from external service

Properties

response: Type: object response

Additional Properties Allowed:

Nested Schema : response

Type: object

Properties

additionalProperties: Type: object additionalProperties

Additional Properties Allowed: { "type":"string" }

Key/value pairs for additional properties sent by the merchant
amount: Type: number

The monetary amount.
authorizationResponse: Type: array authorizationResponse

Additional Properties Allowed:

This response is received incase the transactionType is AUTH. Only one of authorizationResponse/voidResponse/creditResponse will be present in 1 response.
channel: Type: string

The channel of this order. Echoed from request.
creditResponse: Type: array creditResponse

Additional Properties Allowed:

This response is recieved incase the transactionType is RFND. Only one of authorizationResponse/voidResponse/creditResponse will be present in 1 response.
currencyCode: Type: string

The three character currency code. For example: USD.
gatewayId: Type: string

The name of the gateway.
hostTransactionId: Type: string

The transaction ID returned by the gateway.
hostTransactionTimestamp: Type: string

The host timestamp of the transaction. Mandatory for generic payment type.
locale: Type: string

The locale echoed from request. Mandatory attribute.
orderId: Type: string

Id of the order. Echoed from request. Mandatory attribute.
paymentId: Type: string

The Id of the payment group. Mandatory attribute.
paymentMethod: Type: string

The payment method will be card.
transactionId: Type: string

Transaction id of payment transaction, generated by OCC. Mandatory attribute.
transactionTimestamp: Type: string

The timestamp of the transaction.
transactionType: Type: string

The transaction type eg auth, void etc, echoed from request. Mandatory attribute.
voidResponse: Type: array voidResponse

Additional Properties Allowed:

This response is recieved incase the transactionType is VOID. Only one of authorizationResponse/voidResponse/creditResponse will be present in 1 response.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Type: string

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.

Items

Type: object items

Additional Properties Allowed:

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.

Items

Type: object items

Additional Properties Allowed:

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.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

additionalProperties: Type: object additionalProperties

Additional Properties Allowed: { "type":"string" }

Key/value pairs for additional properties sent by the merchant
amount: Type: number

The monetary amount. Mandatory attribute.
authCode: Type: string

Returned code of authorization. Mandatory attribute.
customPaymentProperties: Type: array customPaymentProperties

Additional Properties Allowed:

Custom payment properties can be sent here.
gatewayId: Type: string

Reflects the same gateway ID of the corresponding request. Mandatory attribute.
hostTransactionId: Type: string

The transaction ID returned by the gateway
hostTransactionTimestamp: Type: string

The host timestamp of the transaction.
merchantTransactionId: Type: string

The transaction ID returned by the merchant. Mandatory attribute.
merchantTransactionTimestamp: Type: string

The merchant timestamp of the transaction. Mandatory attribute.
paymentId: Type: string

Reflects the same paymentId of the corresponding request. Mandatory attribute.
paymentMethod: Type: string

Reflects the same payment method of the corresponding request. Mandatory attribute.
responseCode: Type: string

Returned code of response. Mandatory attribute.
responseDescription: Type: string

The description of the response. Mandatory attribute
responseReason: Type: string

Response reason. Mandatory attribute
token: Type: string

Represents the token
transactionId: Type: string

Reflects the same transaction ID of the corresponding request. Mandatory attribute.
transactionTimestamp: Type: string

Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Type: string

Key/value pairs for additional properties sent by the merchant

Nested Schema : customPaymentProperties

Type: array

Custom payment properties can be sent here.

Items

Type: string

Nested Schema : items

Type: object

Properties

additionalProperties: Type: object additionalProperties

Additional Properties Allowed: { "type":"string" }

Key/value pairs for additional properties sent by the merchant
amount: Type: number

The monetary amount. Mandatory attribute.
gatewayId: Type: string

Reflects the same gateway ID of the corresponding request. Mandatory attribute.
hostTransactionId: Type: string

The transaction ID returned by the gateway
hostTransactionTimestamp: Type: string

The host timestamp of the transaction.
merchantTransactionId: Type: string

The transaction ID returned by the merchant. Mandatory attribute.
merchantTransactionTimestamp: Type: string

The merchant timestamp of the transaction. Mandatory attribute.
paymentId: Type: string

Reflects the same paymentId of the corresponding request. Mandatory attribute.
paymentMethod: Type: string

Reflects the same payment method of the corresponding request. Mandatory attribute.
responseCode: Type: string

Returned code of response. Mandatory attribute.
responseDescription: Type: string

The description of the response. Mandatory attribute
responseReason: Type: string

Response reason. Mandatory attribute
transactionId: Type: string

Reflects the same transaction ID of the corresponding request. Mandatory attribute.
transactionTimestamp: Type: string

Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Type: string

Key/value pairs for additional properties sent by the merchant

Nested Schema : items

Type: object

Properties

additionalProperties: Type: object additionalProperties

Additional Properties Allowed: { "type":"string" }

Key/value pairs for additional properties sent by the merchant
amount: Type: number

The monetary amount. Mandatory attribute.
gatewayId: Type: string

Reflects the same gateway ID of the corresponding request. Mandatory attribute.
hostTransactionId: Type: string

The transaction ID returned by the gateway
hostTransactionTimestamp: Type: string

The host timestamp of the transaction.
merchantTransactionId: Type: string

The transaction ID returned by the merchant. Mandatory attribute.
merchantTransactionTimestamp: Type: string

The merchant timestamp of the transaction. Mandatory attribute.
paymentId: Type: string

Reflects the same paymentId of the corresponding request. Mandatory attribute.
paymentMethod: Type: string

Reflects the same payment method of the corresponding request. Mandatory attribute.
responseCode: Type: string

Returned code of response. Mandatory attribute.
responseDescription: Type: string

The description of the response. Mandatory attribute
responseReason: Type: string

Response reason. Mandatory attribute
transactionId: Type: string

Reflects the same transaction ID of the corresponding request. Mandatory attribute.
transactionTimestamp: Type: string

Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Type: string

Key/value pairs for additional properties sent by the merchant