Payment Paid

webhook

paymentPaid

This webhook is triggered when a payment has been successfully processed and paid for a job. It confirms the payment completion with all relevant details.

Payload

jobId

string

required

The unique identifier for the job associated with this payment

companyId

number

required

The unique identifier for the trade company

paymentAmount

float

required

The amount of the payment in the specified currency

paymentCurrency

string

required

The currency code for the payment (ISO 4217 format)

paymentReference

string

required

A unique reference identifier for this payment

jobReference

string

required

A reference identifier for the job associated with this payment

homeownerFirstName

string

required

The first name of the homeowner making the payment

homeownerLastName

string

required

The last name of the homeowner making the payment

dateCreated

date-time

required

The date and time when the payment event was created in ISO 8601 format

description

string

required

A description of what the payment is for

tradeFeeIncludingVatPercent

float

required

The percentage of the trade fee including VAT

tradeFeeIncludingVatAmount

float

required

The amount of the trade fee including VAT

tradeFeeExcludingVatPercent

float

required

The percentage of the trade fee excluding VAT

tradeFeeExcludingVatAmount

float

required

The amount of the trade fee excluding VAT

tradeAmount

float

required

The total amount that will be paid to the trade (payment amount plus fees)

Response

201

Return a 201 status to indicate that the data was received successfully

Loading…