Use Case 4: Credit Card collections


Digitalisation and changes in customer preferences are putting pressures on large insurers to offer new and unfamiliar payment methods to their customers.

Exposure to certain payment methods has been limited for many Insurers, such as using credit card payments for premium collections. The complexity of accepting credit card payments is primarily linked to connecting new providers to existing IT infrastructure, embed reporting into existing processes, update the existing processes as well as navigating the provider and solution landscape in the payment ecosystem. Many enterprises lack experience and expertise in the payment arena as well as the right technology to connect.


We offer insurers a single integration to seamlessly and rapidly deploy credit card collection capabilities, regardless of which billing or ERP system they use and how old it is. Through Imburse, insurers have access to all payment providers and payment technologies around the globe without the need for direct integrations. Imburse also provides PCI DSS compliant IFrames that can be embedded into the client’s journey. We do all the heavy lifting and simplify many of the technical problems, so our clients can fully enhance their payment capabilities whilst saving time and resources.


  • Tenant Portal Access
  • Valid API Keys
  • Marketplace APP Installed and configured with relevant credentials
  • Collect Scheme Create and configure

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 Checkout Session Token

The checkout session token, can be created to be used via Pay-By-Link (check URL redirecting to Pay-by-link use case), or it could be created to be used on the checkout component that could be used via Iframe or on the Checkout URL page.

API: Try it out in our API sandbox!POST: /v1/whitelabel-customer/grants

Imburse offers the ability to provide a payment solution to your customers through use of our Imburse Checkout web component. This web component can be embedded within your own website, as you would with any standard HTML tag. Then, the instruction created above, needs a financial Instrument to be processed against. Imburse provides a checkout webform, to collect the payment details – in this case, the card details. To load the Imburse checkout component, firstly you will need to generate a session token which is then used as the Customer Token on the checkout component. This token can be obtained by posting to the /v1/whitelabel-customer/grants, referencing the order and instruction already created. For more details on how to load the Imburse checkout, please visit the Web Component Setup page.

Request example:

    "orderRef": "order_payout_Card", 
    "instructionRef": "PAYOUT-01",
    "expirySeconds": "6000",
    "billingStreet1": "billing street 1",
    "billingStreet2": "billing street 2", 
    "billingCity": "billing city", 
    "billingState": "billing state", 
    "billingCountry": "DE", 
    "billingPostCode": "post code", 
    "customerEmail": "", 
    "cardholderName": "Customer Name"

Once the Imburse Checkout is loaded and the card details have been submitted, the financial instrument will be created and used to execute the instruction created previously, submitting the payment to be processed by the desired PSP/Partner (defined on the Scheme).

Response example:

    "sessionToken": "73GMJdRQdkyselgaZ8z…………………….CMc0KBpMtY",
    "expires": 1660701819

The session token now could be used on the imburse-checkout token when loading the Iframe or it could be concatenated to the checkout URL{sessionToken} and be presented to the customer.

Copyright © Imburse AG 2018-2022. All right reserved.