Prequal
Overview#
You can use Sunbit's webhooks to do anything from getting notified when a customer makes a payment, to incorporating customer actions into your reporting, customer outreach, and/or marketing automation workflows. The following customer events are currently available:
Pre-qualification: Completed, aborted, failed
Body#
{ "eventType": "PREQUAL_COMPLETED", "payload": { "purchaseId": "123", "location": "retailer", "approvalAmount": 1000.0, "purchaseAmountEntered": 500.0, "referral": "referral", "validUntil": "2021-09-01", "representativeEMail": "jason@email.com", "merchantFeeAmount": 5 }}Definitions#
| Attribute | Type | Description |
|---|---|---|
| eventType | text | The type of event triggered by the customer action: PREQUAL_COMPLETED PREQUAL_FAILED PREQUAL_ABORTED PREQUAL_APPROVED |
| purchaseId | text | The purchase Id that is generated by Sunbit and returned after a successful Sunbit flow. This purchase ID should be used for transaction management -Lookup, Void and refund (add URL for each). |
| location | text | The same Location which was sent in the API. |
| approvalAmount | number | The max amount the customer was approved for. |
| purchaseAmountEntered | number | The purchase amount entered by the customer. |
| referral | text | An external transaction identifier sent by the integrator for Pre-Qualification or Text to Pay-Over-Time and used to match the webhook to the request. |
| validUntil | text | The date the offer expires. Format : YYYY-MM-DD. |
| representativeEmail | text | The email of the representative/advisor which was sent in the API. |
| merchantFeeAmount | number | The amount that was deducted as merchant fees from the total purchase amount. |