Acquisition Handover Journey
Learn how to begin or resume an acquisition journey, and smoothly transition it to our platform.
Overview
In addition, you can allow your applicant to drop off during their acquisition journey and subsequently return to it by logging back into the account they have with you.
Before handing over
Before handing over,
you’ll need to collect the applicants data on a 'check eligibility' form
and then use that data to perform an eligibility check by calling the Eligibility endpoint. The API documentation providse details on mandatory fields and required validations.
After reaching this stage, the application can be handed over to us.
The Handover Journey can take place two scenarios using the same process:
- After receiving a check eligibility response from the Acquisition API.
- If the customer drops off and wants to resume the journey at a later point.
To hand over control of the journey to us you'll have to generate a JWT token in your code and pass it to our endpoint.
Create a token
The JSON Web Token (JWT) you pass to us will need the below details. This will allow us to retrieve customers' information from our database and display the appropriate UI based on their application status.
The token Algorithm is HS256
and the token Header must contain the following:
Javascript
1{
2 "alg": "HS256",
3 "typ": "JWT"
4}
The payload information is as follows.
Parameter | Location | Description | Format |
---|---|---|---|
id | Payload | A 36-digit identifier that identifies the customer application in our databases. | guid |
customerRef | Payload | A 36-digit identifier that identifies your brand/product, this value will be provided to you. | guid |
exp | Payload | The token expiration date is formatted as a number of seconds elapsed since epoch. Tokens should be valid for 5 minutes. | integer |
orderRef | Payload | Mandatory for checkout journey. Required to authorise spend. | string |
offerIds | Payload | Optional. Allows NewDay to retrieve specific offers. | string[] |
basketAmountTotal | Payload | Mandatory for inside checkout. Total amount of customer basket. | integer |
basketAmountIndividual | Payload | Optional. Amount of each individual item in customer basket. | integer[] |
basketDescription | Payload | Optional. Higl level basket description. | string |
loyaltyProgram | Payload | Optional. The customer is purchasing a loyalty membership. | bool |
channel | Payload | MerchantCheckout if your customer is applying for credit as part of purchasing items from your platform. MerchantBrowsing otherwise | string |
Sign the token with the signature key provided by your Account Manager. This is secret key that should be kept secure and not shared with anyone. After creating and signing the JWT token, the customer should be redirected to our handover URL. If you are embedding our application, the base URL will be specific to your organisation and follows the below format.
Javascript
1https://apply.[your domain].com/[your brand]/online/[your product]/handover?token=<token>&iframe=<true/false>&analyticsCookieConsent=<true/false>"
Parameter | Description |
---|---|
iframe | Optional. Accepts values of true or false. If no value for the parameter then assumed to be false |
analyticsCookieConsent | Optional. Accepts values of true or false. If no value for the parameter then assumed to be false. If true it allows us to activate analytics cookies |
token | Mandatory. |
Once the application matching the id in the token is fetched, NewDay will show the appropriate page based on the application status. The status post check eligibility is usually one of: quoteAccept
, quoteDecline
or complexRefer
. If the customer is accepted they will be able to continue their journey on NewDay's website.
You may also like:
Was this page helpful?