Terminate a lead.

This endpoint allows you to terminate a lead by either revoking, rejecting or making it ineligible and supplying a corresponding reason.

Reject CodeDescription
RJ024Partner Reject: Application Incomplete
RJ025Partner Reject: Unsupported Business
RJ026Partner Reject: Volume Trending Downwards
RJ027Partner Reject: Increased Chargebacks
RJ028Partner Reject: Other Adverse Event
RJ029Partner Reject: Technical Limitations
RJ030Partner Reject: Existing Financing
Revoke CodeDescription
RS001The customer did not want to proceed with the offered funding amount
RS002The customer did not want to proceed with the offered factor rate
RS003The customer was unable/unwilling to re-route
RS004The customer was not able to finalise the personal guarantee
RS005The customer did not want to proceed with the offered sweep
RS006The customer did not want to proceed with the offered repayment period
RS007Accepted funding elsewhere
RS008No longer requires funding
RS009Unwilling/unable to provide extra documentation
RS010Applied to enquire how much they could be eligible for
RS012Customer is unresponsive despite having been previously contactable.
RS013Customer is unresponsive to Broker
RS014Partner Revoke: Application Incomplete
RS015Partner Revoke: Technical Error
RS016Started another application
RS017Customer is unresponsive after multiple attempts at contact
RS018Customer no longer wants to be contacted
RS019Customer does not want to proceed with current application but is still interested in future funding
Ineligible CodeDescription
EL017Partner Ineligible: Not within requirements
EL018Partner Ineligible: Existing funding with another partner

Path Params
uuid
required

The lead id.

Body Params

A Terminate Lead Reason model.

string
enum
required
length ≥ 1

Gets or sets the Reason Type of the Terminate Lead by Partner.

Allowed:
string
enum
required
length ≥ 1

Gets or sets the Reason of the Terminate Lead by Partner.

Headers
string
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json