Payment Requested

Payload
string
required

The unique identifier for the job associated with this payment

number
required

The unique identifier for the trade company

float
required

The amount of the payment in the specified currency

string
required

The currency code for the payment (ISO 4217 format)

string
required

A unique reference identifier for this payment

string
required

A reference identifier for the job associated with this payment

string
required

The first name of the homeowner making the payment

string
required

The last name of the homeowner making the payment

date-time
required

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

string
required

A description of what the payment is for

float
required

The percentage of the trade fee including VAT

float
required

The amount of the trade fee including VAT

float
required

The percentage of the trade fee excluding VAT

float
required

The amount of the trade fee excluding VAT

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

LoadingLoading…