When ServiceMobility is integrated with an external payment processing system, it is possible for ServiceMobility to request the collection of payment for work orders.

Under these conditions, the Payment Processor Webhook REST API is the Webhook REST API which the external payment processing system will need to call to update the work order with the results of the payment request.

On this page:

Related pages:

Resource URL Summary

Update a work order with the results of a payment collection request

POST /seiapi/v3/webhooks/Payments/${paymentGatewayId}/Charge

API Specific Parameters

Parameter	Description
`${paymentGatewayId}`	The payment processing system's unique ID, as defined in the relevant REST Object Definitions Configuration Related Objects Entity System Configuration Object's `PayByLink` > `GatewayID` value.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.

API Specifics

Update a work order with the results of a payment collection request

Update a work order with the results (e.g. approved, declined) of a request to collect payment for that work order, after ServiceMobility has requested that payment be collected.

URL

POST /seiapi/v3/webhooks/Payments/${paymentGatewayId}/Charge

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Work Order Activity Related Objects Payment Processor Webhook Object.

HTTP Response Body

On success, an HTTP response code of 200 will be returned.

REST Webhook REST APIs Payment Processor Webhook REST API