This section describes the top-level properties and the properties of subobjects sent in the JSON request body of the Generic Payment webhook for invoice transactions.
Top-level properties
The following table describes the top-level properties that Oracle Commerce Cloud sends in the webhook request.
Property | Description |
|---|---|
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 | The type of transaction. For an invoice payment gateway, this must be |
transactionTimestamp | The timestamp of the transaction, expressed as an ISO 8601 value in the following format:
|
organizationId | The ID of the organization to be invoiced. |
organizationName | The name of the organization to be invoiced. |
PONumber | The purchase order number for the account to be invoiced. |
referenceNumber | The ID of the internal payment group. |
channel | The area of the system where the payment-processing request originated. Valid values are:
|
paymentMethod | The payment method. For an invoice 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. |
siteId | The ID of the site on which the order was placed. |
gatewayId | The ID of the payment gateway. |
customProperties | Additional key/value pairs from the submitted order to be sent to the provider. |
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 a purchase order authorization request:
{
"transactionId": "o40426-pg40413-1466678343221",
"currencyCode": "USD",
"organizationName": "ABCD Corp",
"locale": "en",
"PONumber": "po22222",
"referenceNumber": "pg40413",
"customProperties": { },
"organizationId": "or-300007",
"siteId": "siteUS",
"gatewaySettings": {
"paymentMethodTypes": "invoice",
"filteredFields": [
"paymentMethodTypes"
]
},
"amount": "000000002999",
"transactionType": "AUTHORIZE",
"transactionTimestamp": "2016-06-23T10:39:03+0000",
"channel": "storefront",
"orderId": "o40426",
"paymentMethod": "invoice",
"profile": {
"id": "130000",
"phoneNumber": "2342342345",
"email": "a1@abcdcorp.com"
},
"gatewayId":"invoiceGateway"
}
