Use Case 1: Pay-by-Link to reduce insurance payment dropouts

Problem

Activating a new customer policy is a cumbersome process that requires multiple document exchanges. This process is inefficient and creates a lot of operational pains for insurers.

Yet, insurers are still requesting potential customers to print, fill, sign, scan, and email back a form before actually selling the policy. The complexity and length of activating a policy put customers off, increasing the likelihood of customers postponing this time-consuming task, or even dropping out.

Solution

With Imburse's Pay-By-Link solution, Insurance customers take on average less than a minute to renew or activate their policies, from the moment they receive the link. This is the most convenient and efficient way to onboard customers into a payment journey.

Pay-By-Link is a secure link that your customers get via SMS or Email. Once your customers click on it, they will be directed to a secure online payment page. There they are are prompted to submit their payment details which takes less than 5 minutes. They do not have to go through lengthy website checkouts or messy document exchanges with the Insurer, saving their time and making your customers comfortable.

Prerequisites

In order to work with Pay-By-Link, ensure the following.

You have access to the Tenant Portal
You have generated valid API Keys.
You have installed and configured the Marketplace Apps with the relevant credentials.
You have created and configured Collect Scheme.

Supported Apps

Stripe
Checkout.com
SIBS DPG
Braintree
Global Payments
GoCardless
Worldline Saferpay

Working with Pay-By-Link

Step 1: Authenticate

The first step to using Imburse API is to authenticate yourself by generating an Access Token. See Auhthenticate your API Requests for more information.

Step 2: Create Order and Instruction

Define your Order and Instruction and make a call to our create-order endpoint. See Define your payment intention for more information.

POST URL OrderRequest Header SampleRequest Body Sample

Copy

Copied

https://sandbox-api.imbursepayments.com/v2/order-management

Copy

Copied

Authorization: Bearer {eyJhbGciOiJIUzI1N...9UAUBNuyPN6Xg}
x-account-id: 49bder42-90d9-46b1-b120-f6b347d621a0
x-tenant-id: 60452f48-5d48-4bc0-ab6f-5cr3ee411f63
Content-Type: application/json

Copy

Copied

{
	"orderRef": "order_xnv6h1n",
	"instructions": [
		{
			"instructionRef": "inst_xnv6h1n",
			"customerRef": "MEGHAN_002",
			"direction": "DEBIT",
			"financialInstrumentId": "",
			"amount": "120.00",
			"currency": "GBP",
			"country": "UK",
			"schemeId": "F65A71F4EDAFBBBA7EA87706CBA113C3",
              "settledByDate": "2023-06-01",
			"metadata": {
                "paymentDescriptorField1": "InsurancePaymentFor",
                "FieldValue": "June 2023"
              }
		}
	]
}

Step 3: Generate Pay-by-link Session

Copy the value of orderRef and instructionRef properties from Step 2: Create Order and Instruction and use them to make create the request body of the Pay-By-Link endpoint. Set the value of the expirySeconds property to limit the time the secure link will be valid and the channels array to define the medium through which you can share the secure link with your customers.

POST URL WhitelabelRequest Header SampleRequest Body Sample

Copy

Copied

https://sandbox-api.imbursepayments.com/v1/whitelabel-customer/session/checkout/pay-by-link/

Copy

Copied

Authorization: Bearer {eyJhbGciOiJIUzI1N...9UAUBNuyPN6Xg}
x-account-id: 49bder42-90d9-46b1-b120-f6b347d621a0
x-tenant-id: 60452f48-5d48-4bc0-ab6f-5cr3ee411f63
Content-Type: application/json

Copy

Copied

{
  "orderRef": "order_xnv6h1n", 
  "instructionRef": "inst_xnv6h1n",
  "channels": [
    {
      "type": "SMS",
      "destination": "00447975777666"
    },
    {
      "type": "EMAIL",
      "destination": "meghan@acme.com"
    }
  ],
  "expirySeconds": "60000"
}

After you have completed constructing the request body, make a call to the API endpoint. The response of this call will include a link property, which holds the secure payment link. Your customers will also receive the link through the channel you have specified in the request body.

Copy

Copied

{
    "payByLinkId": "3b0aeddc-8723-4962-9de8-e73798a4bdc2",
    "link": "https://sandbox-checkout.imbursepayments.com/?token=3O0KOyOHYkmd6Oc3mKS9wvkYRWzOSFxHEpgZwJwUHDRPIB4qs%2f5U4R1R01RBxZQO"
}

Step 4: Check the payment status

After the Financial Instrument details of your customer has been submitted to the Imburse platform, Imburse will communicate with the Payment Service Provider (PSP) to handle the transaction. You can check the status of the transaction by polling our APIs. Alternatively, you can also set up a Webhook to notify you every time the transaction status changes.

URL to GET - SampleRequest Header SampleResponse Body Sample

Copy

Copied

https://sandbox-api.imbursepayments.com/v1/order-management/order_xnv6h1n/instruction/inst_xnv6h1n

Copy

Copied

Authorization: Bearer {eyJhbGciOiJIUzI1N...9UAUBNuyPN6Xg}
x-account-id: 49bder42-90d9-46b1-b120-f6b347d621a0
x-tenant-id: 60452f48-5d48-4bc0-ab6f-5cr3ee411f63
Content-Type: application/json

Copy

Copied

{
    ...
    "created": 1669167777450,
    "lastUpdated": 1669167777450,
    "direction": "DEBIT",
    "status": "INCOMPLETE",
    "customerRef": "MEGHAN_002",
    "amount": 120.00,
    "currency": "GBP",
    "country": "UK",
    "settledByDate": "2023-06-01",
    "forecastedSettlementDate": null,
    "actualSettlementDate": null,
    ...    
    "transaction": {
      ...
      "status": "PROCESSING",
      ...
    },
    "failed": null,
    "cancelled": null
}

Troubleshooting

What should my customer expect?

Your customers will only receive the secure link if you have specified their email address or phone number in the channels array of the Pay-By-Link endpoint. If you have missed to enter the email address or the phone number, manually share the link with you customers.

After you have called the Pay-By-Link endpoint, your customers will get a link via SMS or Email. If they follow this link, they will be taken to a secure online payment page where they can submit their payment details.

What should I expect?

After your customer has submitted their Financial Instrument details, the payment will be processed by the Payment Service Provider according to the defined Scheme. The time required to process and complete the transaction depends on the Payment Service Provider's network.

You can poll our API to get the status of payment or set up a Webhook to notify you once the transaction is complete.