Generate a prequalified offer

This endpoint returns indicative offers for a merchant in real time. This endpoint can therefore be used either:

As a scheduled bulk job to generate indicative financing offers for all of a partner's merchants, which is then used in marketing
Requested on demand either by a merchant or by a broker/ adviser "click here to request a prequalified offer"

Request body example

{
        "companyType": "Ltd",
        "countryISOCode": "GBR",
        "loanCurrencyISOCode": "GBP",
        "thirdPartyMerchantId": "abc123",
        "financialData": {
            "paymentData": [
                {
                    "paymentDate": "2024-03-01T10:55:09.307Z",
                    "amount": 100000,
                    "currencyISOCode": "GBP"
                },
                {
                    "paymentDate": "2024-04-01T10:55:09.307Z",
                    "amount": 12000,
                    "currencyISOCode": "GBP"
                },
                {
                    "paymentDate": "2024-05-01T10:55:09.307Z",
                    "amount": 100000,
                    "currencyISOCode": "GBP"
                },
                {
                    "paymentDate": "2024-06-01T10:55:09.307Z",
                    "amount": 12000,
                    "currencyISOCode": "GBP"
                },
                {
                    "paymentDate": "2024-07-01T10:55:09.307Z",
                    "amount": 100000,
                    "currencyISOCode": "GBP"
                },
                {
                    "paymentDate": "2024-08-01T10:55:09.307Z",
                    "amount": 100000,
                    "currencyISOCode": "GBP"
                },
                {
                    "paymentDate": "2024-09-01T10:55:09.307Z",
                    "amount": 12000,
                    "currencyISOCode": "GBP"
                },
                {
                    "paymentDate": "2024-10-01T10:55:09.307Z",
                    "amount": 100000,
                    "currencyISOCode": "GBP"
                },
                {
                    "paymentDate": "2024-11-01T10:55:09.307Z",
                    "amount": 12000,
                    "currencyISOCode": "GBP"
                },
                {
                    "paymentDate": "2024-12-01T10:55:09.307Z",
                    "amount": 100000,
                    "currencyISOCode": "GBP"
                },
                {
                    "paymentDate": "2025-01-01T10:55:09.307Z",
                    "amount": 100000,
                    "currencyISOCode": "GBP"
                },
                {
                    "paymentDate": "2025-02-01T10:55:09.307Z",
                    "amount": 100000,
                    "currencyISOCode": "GBP"
                },
                {
                    "paymentDate": "2025-03-01T10:55:09.307Z",
                    "amount": 100000,
                    "currencyISOCode": "GBP"
                }                
            ]
        }
    }

Parameter callouts

Parameter	Description
`companyType`	Should match one of the company types seen here . You can learn about which company types are associated with what country in our localisation guides, see the United Kingdom guide as an example
`paymentDate`	UTC format
`amount`	This is always returned in dollars/ pounds/ euros. For example, £100 should be sent as 100

Response body example

{
    "thirdPartyMerchantId": "abc123",
    "mid": null,
    "companyName": null,
    "overallCreditRiskScore": 3.8157894736842105263157894737,
    "overrideCreditRiskScore": 0.0,
    "loanOptions": [
        {
            "currencyISOCode": "GBP",
            "fee": 5808.0,
            "fundedAmount": 17600.0,
            "loanAmount": 23408.0,
            "sweep": 20.0
        },
        {
            "currencyISOCode": "GBP",
            "fee": 6440.0,
            "fundedAmount": 18400.0,
            "loanAmount": 24840.0,
            "sweep": 20.0
        },
        {
            "currencyISOCode": "GBP",
            "fee": 7030.0,
            "fundedAmount": 19000.0,
            "loanAmount": 26030.0,
            "sweep": 20.0
        }
    ]
}