Richer webhook payloads: APR, cash price and commission
Partner webhooks now include the APR, total cash price, subsidy and broker commission for each application.
A webhook should tell you everything you need to act on an update. To save you an extra lookup after each one, partner webhooks now include the cost of credit and commission details.
New fields
Cost of credit
- apr: the APR of the customer’s agreement.
- totalCashPrice: the loan amount plus the deposit.
Subsidy
- subsidyPercentage and subsidyFee: any retailer subsidy applied to the application.
Commission
- brokerCommission and brokerCommissionAmount: the commission due on the application, as a rate and as an amount.
When fields are included
APR and total cash price are included once the offer is known: on approved and approved-with-conditions applications, and from the documents stage onwards. Subsidy and commission fields are only populated when they apply to the application.
Handle null values
Fields that don’t apply are sent as null rather than left out, so your parser always sees the same shape. Check for null before using a value, as in the example above, rather than treating it as zero.
Where to find every field
The full webhook body, including which fields are optional and from which status they appear, is documented under the webhookUrl field of the applications endpoint.
Existing fields are unchanged, so current integrations keep working.
