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


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.


With Imburse’s Pay-By-Link solution, Insurance customers take on average less than a minute to 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 link that customers get via SMS or Email. Once customers click on it, they are directed to a secure online payment page. Then, customers are prompted to add their payment details and submit them. They do not have to go through lengthy website checkouts or messy document exchanges with the Insurer.


  • Access to the Tenant Portal.
  • Valid API Keys.
  • Marketplace App installed and configured with the relevant credentials.
  • Collect Scheme created and configured.

Supported Apps

  • Stripe
  • Braintree
  • Global Payments
  • GoCardless
  • Worldline Saferpay


Step 1: Authenticate

The first step to using Imburse API is to authenticate yourself by generating an Access Token.

To learn more on how to authenticate, see Authentication.

Step 2: Create Order and Instruction

API: Try it out in our API sandbox!POST: v1/order-management
  1. After your Access Token is successfully generated, you can start using the remaining Imburse APIs.
  2. To integrate Card Payments, you need to create an Order and Instruction/s, defining the payment intention and related information. For example, the Amount and the SchemeID, which is fetched from the Tenant Portal after creating the Scheme.
  3. The direction of the payment is set during the creation of the instruction whether you want to debit or credit. For collections, always use the debit direction.

Request example:

  "orderRef": "order_Card_01",
  "instructions": [
      "instructionRef": "PAYMENT-01",
      "customerRef": "customer_01",
      "direction": "DEBIT",
      "FinancialInstrumentId": "",
      "amount": "10.00",
      "currency": "GBP",
      "country": "UK",
      "schemeId": "4E1E8D9F022E7A6A09FAEB71992E7F2F",
      "settledByDate": "2021-09-01",
      "metadata": {

The following table lists all properties along with their type and description:

orderRefstringYesA unique reference for an Order. Usually correlates to your customers order reference in you own internal systems.The orderRef property is set by Imburse client.
instructionRefstringYesA unique reference for an Instruction. For example, a month number.The instructionRef property is set by Imburse client.
customerRefstringYesA reference for your customer. If you are setting customerDefaults on the order then this will need to match a customerRef from the customerDefaults. The customerRef property is set by Imburse client.
directionstringYesThe direction the instruction is for. Available values are CREDIT and DEBIT. Use DEBIT for Collections.
schemeIdstringYesThe schemeId this order should use to filter available payment options.
settledByDatedateNoThe date in which a payment is to be settled by, or if automated, will be taken on. Date format is YYYY-MM-DD. After this date Imburse would send you missed payment webhook notifications.

Step 3: Generate Pay-by-link Session

API: Try it out in our API sandbox!POST: /v1/whitelabel-customer/session/checkout/pay-by-linkNow, you can add a financial instrument to the created instruction: 1. Imburse provides a checkout web form to collect the payment details, such as the card details. To load the Imburse checkout component, you need to generate a session token which is then used as the Customer Token on the checkout component. 2. To obtain the session token, make a POST API request to the /v1/whitelabel-customer/grants, referencing the order and instruction already created.

Request example:

    "orderRef": "order_Card_01",
    "instructionRef": "PAYMENT-01",
    "expirySeconds": "6000"

Response example:

    "payByLinkId": "5dc09dd1…2fd29c72dcbf",
    "link": ""


As a result, the customers get a link via SMS or Email. By following this link, they are directed to a secure online payment page where they provide their payment details and submit them.

Step 4: Check the payment status

To notify on the status of the payment, in addition to a synchronized response considering that Card Payments are synchronous, Imburse provides a webhook notification at each status change with the possibility to poll the status through the GET instruction endpoint.
Copyright © Imburse AG 2018-2022. All right reserved.