This section describes the top-level properties and the properties of subobjects sent in the JSON request body of the Generic Payment webhook for gift card transactions.
Top-level properties
The following table describes the top-level properties that Oracle Commerce Cloud sends in the webhook request.
Property | Description |
|---|---|
transactionType | A code indicating the type of transaction. This must be one of the following numeric values:
|
channel | The area of the system where the payment-processing request originated. Valid values are:
|
orderId | The ID of the order associated with the payment. |
currencyCode | The ISO 4217 currency code. |
locale | The shopper’s locale, taken from the order. If no locale is set, the default locale from the storefront is used. |
siteId | The ID of the site on which the order was placed. |
customProperties | Additional key/value pairs from the submitted order to be sent to the provider. |
paymentRequests properties
The following table describes the properties of paymentRequests objects that Oracle Commerce Cloud sends in the webhook request.
Property | Description |
|---|---|
paymentId | The ID of the internal payment group. |
transactionId | The unique ID of the transaction. Consists of the order ID, the payment ID, and the transaction timestamp (in milliseconds), separated by hyphens. |
transactionTimestamp | The timestamp of the transaction, expressed as an ISO 8601 value in the following format:
|
paymentMethod | The payment method. For a gift card, the value is |
amount | The expected amount of the transaction. The value of this property is a positive, 12-digit number that is expressed in base currency. For example, $125.75 is represented as |
gatewayId | The ID of the payment gateway. |
customProperties | Additional key/value pairs from the submitted order to be sent to the provider. |
cardDetails properties
The following table describes the properties of the cardDetails object sent in a gift card authorization request or balance inquiry.
Property | Description |
|---|---|
giftCardNumber | The number that uniquely identifies the gift card. |
giftCardPin | The security code for authenticating the gift card. |
referenceInfos properties
The following table describes the properties of the referenceInfos objects sent in a gift card void request or refund request. The values of these properties are taken from the original authorization transaction so the merchant can map the void or refund to it.
Property | Description |
|---|---|
merchantTransactionId | The transaction reference ID from the merchant. |
hostTransactionId | The transaction reference ID from the payment gateway. |
billingAddress properties
The following table describes the properties of the billingAddress object in the request. The billing address is the address of the shopper to whom the order is charged.
Property | Description |
|---|---|
lastName | The last name of the shopper. |
postalCode | The postal code in the address (for example, the zip code in the United States). |
phoneNumber | The phone number associated with the address. |
The email address associated with the address. | |
state | The state in the address. |
address1 | The first line of the address. Typically the street and number. |
address2 | The second line of the address. Included as an empty string in the JSON data if no value exists in the order. |
firstName | The first name of the shopper. |
city | The city in the address. |
country | The country in the address. |
shippingAddress properties
The following table describes the properties of the shippingAddress object in the request. The shipping address is the address of the person (not necessarily the shopper) receiving the order.
Property | Description |
|---|---|
lastName | The last name of the order recipient. |
postalCode | The postal code in the address (for example, the zip code in the United States). |
phoneNumber | The phone number associated with the address. |
The email address associate with the address. | |
state | The state in the address. |
address1 | The first line of the address. Typically the street and number. |
address2 | The second line of the address. Included as an empty string in the JSON data if no value exists in the order. |
firstName | The first name of the order recipient. |
city | The city in the address. |
country | The country in the address. |
profile properties
The following table describes the properties of the profile object in the request. These values are associated with the shopper purchasing the order.
Property | Description |
|---|---|
id | The ID of the shopper profile. |
phoneNumber | The phone number from the shopper profile. |
The email address from the shopper profile. |
Sample authorization request
The following is an example of a gift card authorization request:
{
"transactionType": "0100",
"currencyCode": "USD",
"locale": "en",
"customProperties": { },
"channel": "storefront",
"siteId": "siteUS",
"orderId": "o50415",
"paymentRequests": [
{
"transactionId": "o50415-pg50417-1464958982609",
"paymentId": "pg50417",
"customProperties": { },
"gatewaySettings": {
"paymentMethodTypes":"physicalGiftCard"
},
"cardDetails":{
"giftCardNumber": "12393678",
"giftCardPin": ""
},
"amount":"000000002499",
"billingAddress": { },
"transactionTimestamp": "2016-06-03T13:03:02+0000",
"referenceInfos": { },
"shippingAddress": { },
"paymentMethod": "physicalGiftCard",
"gatewayId": "demoGiftCardGateway",
}
],
"profile": {
"id":"120002",
"phoneNumber":"1234512345",
"email": "ab@abc.com"
}
}
