REST Object Definitions Work Order Activity Related Objects Payment Processor Webhook Object

Payment Processor Webhook Object Formats

JSON Format

{
	"Amount": 1075,
	"MerchantID": "8f946192-3c9c-11ea-b77f-2e728ce88125",
	"PaymentUTC": "2020-01-17T15:02:24.907Z",
	"RefNum": "ORD-4534",
	"Source": "Terminal|Link",
	"TransactionID": "f0d11466-3937-11ea-b02e-81175d3c3c27",
	"TransactionStatus": "Approved|Declined",
	"TransactionType": "Sales|Authorization|Void|Refund|Cancel",
	"Type": "Card|Check|Phone"
}

Payment Processor Webhook Object Properties

Required properties are in bold

Property	Type	Description
`Amount`	`number`	The amount of the transaction (e.g. dollars and cents, pounds and pence, etc.) The currency is determined by the `LanguageID` value of the site associated with the work item for which the payment is associated.
`MerchantID`	`string`	The unique merchant ID value for the external payment processing system, as defined in the relevant Entity System Configuration Object's `Payment` > `MerchantID` value.
`PaymentUTC`	`datetime`	The date and time that the payment collection attempt was performed, in ISO-8601 format using pattern `YYYY-MM-DDTHH:mm:SS.sssZ`. The date and time must be in UTC.
`RefNum`	`string`	The reference number value (i.e. work order ID) as supplied to the external payment processing system when the request for payment collection was made by ServiceMobility.
`Source`	`string`	The method by which payment was made. Valid values: `Terminal`: Payment was made using a physical card and a card processing transaction terminal. `Link`: Payment was made online using a web link provided to the customer.
`TransactionID`	`string`	A unique transaction ID value for the payment collection attempt from the external processing system.
`TransactionStatus`	`string`	Was the payment collection attempt successful or not? Valid values: `Approved`: Payment collection was successful. `Declined`: Payment collection was not successful.
`TransactionType`	`string`	Indicates the type of transaction used by the external payment processing system when payment was processed. Valid values: `Sales` `Authorization` `Void` `Refund` `Cancel`
`Type`	`string`	The type of payment collection that was attempted. Valid values: `Card`: Payment was attempted via in-person use of a credit/debit card. `Check`: Payment was attempted via check/cheque. `Phone`: Payment was attempted via over-the-phone use of a credit/debit card.