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.

Status
colourGreen
title4.4.0
 

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.


Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

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

API Specific Parameters

ParameterDescription

${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.

Include Page
_Default HTTP Headers
_Default HTTP Headers


API Specifics


Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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.