REST API for Oracle Commerce Cloud December 2017

genericPayment

post

/ccadmin/v1/webhook/genericPayment

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

Request

Supported Media Types

application/json

Body Parameter

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

Root Schema : genericPayment_request

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

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.
customProperties: Type: object customProperties

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

Additional key/value pairs from the submitted order to be sent to the payment provider.
gatewayId: Type: string

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

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

The settings of the gateway.
items: Type: array items

Additional Properties Allowed:

Information about the item in order
locale: Type: string

The locale of the request
orderId: Type: string

Id of the order
organizationId: Type: string

The ID of the organization for the account to be invoiced.
organizationName: Type: string

The name of the organization for the account to be invoiced.
paymentId: Type: string

The Id of the payment group
paymentMethod: Type: string

The payment method eg cash, invoice etc.
paymentRequests: Type: array paymentRequests

Additional Properties Allowed:

Gift card payment requests. Applicable only for Gift cards.
PONumber: Type: string

The purchase order number for the account to be invoiced. This attribute is only for invoice payments.
profile: Type: object profile

Additional Properties Allowed:

The basic profile details.
referenceInfo: Type: object referenceInfo

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

For void/refund transactions
referenceInfos: Type: array referenceInfos

Additional Properties Allowed:

An array for void/refund transactions
referenceNumber: Type: string

Payment Id for cash transaction
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 : customProperties

Type: object

Additional Properties Allowed

Type: string

Additional key/value pairs from the submitted order to be sent to the payment provider.

Nested Schema : gatewaySettings

Type: object

Additional Properties Allowed

Type: string

The settings of the gateway.

Nested Schema : items

Type: array

Information about the item in order

Items

Type: object items

Additional Properties Allowed:

Nested Schema : paymentRequests

Type: array

Gift card payment requests. Applicable only for Gift cards.

Items

Type: object items

Additional Properties Allowed:

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 : referenceInfos

Type: array

An array for void/refund transactions

Items

Type: object items

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

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.

Nested Schema : items

Type: object

Properties

catRefId: Type: string

The catalog ref id.
description: Type: string

The description of the item.
displayName: Type: string

The display name of item.
id: Type: string

The id of the item.
options: Type: array options

Additional Properties Allowed:

The option values
price: Type: number

The price
productId: Type: string

The id of the product
quantity: Type: number

The quantity ordered.
rawTotalPrice: Type: number

The monetary raw total price.
unitPrice: Type: number

The price of each unit

Nested Schema : options

Type: array

The option values

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

optionName: Type: string

The option name
optionValue: Type: string

The option value

Nested Schema : items

Type: object

Properties

amount: Type: number

The amount paid
billingAddress: Type: object billingAddress

Additional Properties Allowed:

The billing address
cardDetails: Type: object cardDetails

Additional Properties Allowed:

Gift card information.
gatewayId: Type: string

The gateway id
gatewaySettings: Type: object gatewaySettings

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

The gateway settings.
paymentId: Type: string

The Id of the payment group
paymentMethod: Type: string

The payment method
referenceInfo: Type: object referenceInfo

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

For void/refund transactions
referenceInfos: Type: array referenceInfos

Additional Properties Allowed:

An array for void/refund transactions
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address
transactionId: Type: string

The transaction ID.
transactionTimestamp: Type: string

The timestamp of the transaction.

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

Gift card information.

Properties

giftCardNumber: Type: string

Gift card number.
giftCardPin: Type: string

Gift card pin.

Nested Schema : gatewaySettings

Type: object

Additional Properties Allowed

Type: string

The gateway settings.

Nested Schema : referenceInfo

Type: object

Additional Properties Allowed

Type: string

For void/refund transactions

Nested Schema : referenceInfos

Type: array

An array for void/refund transactions

Items

Type: object items

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

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.

Nested Schema : items

Type: object

Additional Properties Allowed

Type: string

Nested Schema : items

Type: object

Additional Properties Allowed

Type: string

Response

Supported Media Types

application/json

200 Response

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

Body

The generic payment response from external service

Root Schema : genericPayment_response

The generic payment response from external service

Properties

response: Type: object response

Additional Properties Allowed:

Nested Schema : response

Type: object

Properties

addBalanceResponse: Type: array addBalanceResponse

Additional Properties Allowed:

This response is recieved incase the transactionType is BAL_ADD. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse will be present in 1 response. For gift card.
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 for gift cards and generic payment type.
authorizationResponse: Type: array authorizationResponse

Additional Properties Allowed:

This response is received incase the transactionType is AUTH. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse 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: Type: object billingAddress

Additional Properties Allowed:

The billing address
captureResponse: Type: array captureResponse

Additional Properties Allowed:

This response is recieved incase the transactionType is CAPT. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse 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: Type: string

The channel of this order. Echoed from request. Mandatory for gift cards.
creditResponse: Type: array creditResponse

Additional Properties Allowed:

This response is recieved incase the transactionType is RFND. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse 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: Type: string

The three character currency code. For example: USD. Mandatory for cash, gift cards and generic payment type.
externalProperties: Type: array externalProperties

Additional Properties Allowed:

External properties.
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.
inquireBalanceResponse: Type: array inquireBalanceResponse

Additional Properties Allowed:

This response is recieved incase the transactionType is BAL_INQ. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse will be present in 1 response. For gift card.
items: Type: object items

Additional Properties Allowed:

Information about the item
locale: Type: string

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

The transaction ID returned by the merchant. Mandatory for cash and generic payment type.
merchantTransactionTimestamp: Type: string

The merchant timestamp of the transaction. Mandatory for cash.
orderId: Type: string

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

The ID of the organization for the invoiced account.
organizationName: Type: string

The name of the organization for the invoiced account.
paymentId: Type: string

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

The payment method eg cash, invoice etc, echoed from request. Mandatory for cash and invoice.
PONumber: Type: string

The purchase order number for the invoiced account.
profile: Type: object profile

Additional Properties Allowed:

The basic profile details
referenceNumber: Type: string

Payment Id for cash transaction.
response: Type: object response

Additional Properties Allowed:

The received response. Applicable for generic payment type.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address
transactionId: Type: string

Transaction id of payment transaction, generated by OCC. Mandatory for cash and invoice.
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 inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse 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 will be present in 1 response. For gift card.

Items

Type: object items

Additional Properties Allowed:

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 inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse will be present in 1 response. This field is an array only for Gift Cards. It is a single object for other payment types.

Items

Type: object items

Additional Properties Allowed:

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 : captureResponse

Type: array

This response is recieved incase the transactionType is CAPT. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse will be present in 1 response. This field is an array only for Gift Cards. It is a single object for other payment types.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : creditResponse

Type: array

This response is recieved incase the transactionType is RFND. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse will be present in 1 response. This field is an array only for Gift Cards. It is a single object for other payment types.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalProperties

Type: array

External properties.

Items

Type: 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 will be present in 1 response. For gift card.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Information about the item

Properties

catRefId: Type: string

The catalog ref id.
description: Type: string

The description
displayName: Type: string

The display name
id: Type: string

The id of the item.
options: Type: array options

Additional Properties Allowed:

The options values.
price: Type: number

The price
productId: Type: string

The id of the product
quantity: Type: number

The quantity
rawTotalPrice: Type: number

The monetary raw total price.
unitPrice: Type: number

The price of each unit

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 : response

Type: object

The received response. Applicable for generic payment type.

Properties

code: Type: string

The code of the response.
description: Type: string

The description of the response.
reason: Type: string

The reason of the response.
success: Type: boolean

Boolean value on basis of success or failure of transaction. Mandatory attribute

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.

Nested Schema : voidResponse

Type: array

This response is recieved incase the transactionType is VOID. Only one of inquireBalanceResponse/addBalanceResponse/authorizationResponse/voidResponse/captureResponse/creditResponse will be present in 1 response. This field is an array only for Gift Cards. It is a single object for other payment types.

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.
currencyCode: Type: string

The three character currency code. For example: USD.
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 response code. Mandatory attribute.
responseDescription: Type: string

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

Response reason. Optional 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.
transactionType: Type: string

The transaction type eg auth,void etc.

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.
authCode: Type: string

Returned code of authorization. Mandatory attribute for 3DS.
currencyCode: Type: string

The three character currency code. For example: USD.
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. Optional attribute
responseReason: Type: string

Response reason. Optional 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.
transactionType: Type: string

The transaction type eg auth,void etc.

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.
currencyCode: Type: string

The three character currency code. For example: USD.
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. Optional attribute
responseReason: Type: string

Response reason. Optional 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.
transactionType: Type: string

The transaction type eg auth,void etc.

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.
currencyCode: Type: string

The three character currency code. For example: USD.
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. Optional attribute
responseReason: Type: string

Response reason. Optional 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.
transactionType: Type: string

The transaction type eg auth,void etc.

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.
currencyCode: Type: string

The three character currency code. For example: USD.
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. Optional attribute
responseReason: Type: string

Response reason. Optional 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.
transactionType: Type: string

The transaction type eg auth,void etc.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Type: string

Key/value pairs for additional properties sent by the merchant

Nested Schema : options

Type: array

The options values.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

optionName: Type: string

The options name.
optionValue: Type: string

The options value.

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.
currencyCode: Type: string

The three character currency code. For example: USD.
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. Optional attribute
responseReason: Type: string

Response reason. Optional 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.
transactionType: Type: string

The transaction type eg auth,void etc.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Type: string

Key/value pairs for additional properties sent by the merchant