Versions Compared

Old Version 1

changes.mady.by.user Mickey Bushman

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Payment Processor Webhook object defines the object that must be passed into ServiceMobility by an external payment processing system when calling the Payment Processor Webhook REST API.


Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:


Payment Processor Webhook Object Formats

Include Page
_Payment Processor Webhook Object Formats
_Payment Processor Webhook Object Formats

Payment Processor Webhook Object Properties

(info) Required properties are in bold

PropertyTypeDescription

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

datetimeThe 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.