This section describes the top-level properties and the properties of subobjects sent in the JSON request body for cash transactions.
Top-level properties
The following table describes the top-level properties that Oracle Commerce Cloud Service 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. |
transactionType | For a cash payment gateway, this must be one of the following strings:
|
transactionTimestamp | The timestamp of the transaction, expressed as an ISO 8601 value in the following format:
|
channel | The area of the system where the payment-processing request originated. Valid values are:
|
paymentMethod | For a cash payment gateway, the value must be |
orderId | The ID of the order associated with the payment. |
amount | The amount to be authorized, as a positive, 12-digit number that is expressed in base currency. For example, $125.75 is represented as |
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. |
gatewayId | The ID of the payment gateway. |
profile properties
The following table describes the properties of the profile object in the request. These values are associated with the customer purchasing the order.
Property | Description |
|---|---|
id | The ID of the customer profile. |
phoneNumber | The phone number from the customer profile. |
The email address from the customer profile. |
Sample authorization request
The following is an example of an authorization request sent by the Generic Payment webhook to a cash payment gateway:
{
"transactionId": "o30446-pg30417-1458555741310",
"currencyCode": "USD",
"paymentId": "pg30417",
"locale": "en",
"gatewaySettings": {
"paymentMethodTypes": "cash",
"filteredFields": ["paymentMethodTypes"]
},
"amount": ""000000122526",",
"transactionType": "CASH REQUEST",
"transactionTimestamp": "2016-03-21T10:22:21+0000",
"channel": "storefront",
"orderId": "o30446",
"paymentMethod": "cash",
"gatewayId": "gatewayDemo",
"profile": {
"id": "110454",
"phoneNumber": "617-555-1977",
"email": "tshopper@example.com"
}
}
