Use Case 4: Credit Card collections

Problem

Digitisation 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, such as using credit card payments, for premium collections has been limited for many Insurers. And, many enterprises lack experience and expertise in the payment arena, including the right technology to connect.

The complexity of accepting credit card payments is primarily linked to connecting new providers to existing IT infrastructure, embedding reporting into existing processes, updating the existing processes as well as navigating the provider and solution landscape in the payment ecosystem.

Solution

We oﬀer insurers a single integration to seamlessly and rapidly deploy credit card collection capabilities, regardless of which billing or ERP system you use and however 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 you can fully enhance your payment capabilities whilst saving time and resources.

Prerequisites

In order to work with Credit Card collection, 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 Credit Card Collections

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: Define your payment intention

For every collection, you need to set the value of direction property to Debit.

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_card_rfgt6d",
	"instructions": [
		{
			"instructionRef": "inst_payment_rfgt6d",
			"customerRef": "DEEPAK_004",
			"direction": "DEBIT",
			"financialInstrumentId": "",
			"amount": "110.00",
			"currency": "GBP",
			"country": "UK",
			"schemeId": "4E1E8D9F022E7A6A09FAEB71992E7F2F",
              "settledByDate": "2022-12-01",
			"metadata": {}
		}
	]
}

Step 3: Generate Checkout Session Token

The billing details of the customer are optional. However, we strongly recommend that you set the values to the billing details properties. The values of the orderRef and instructionRef properties should be the the same as in Step 2: Define your payment intention.

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 Create session token endpoint.

POST URL OrderRequest Header SampleRequest Body SampleResponse Body Sample

Copy

Copied

https://sandbox-api.imbursepayments.com/v2/whitelabel-customer/session/checkout

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_payout_Card", 
    "instructionRef": "inst_payment_rfgt6d",
    "expirySeconds": "6000",
    "billingStreet1": "45 Braemar Rd",
    "billingStreet2": "", 
    "billingCity": "Ballater", 
    "billingState": "Aberdeenshire", 
    "billingCountry": "UK", 
    "billingPostCode": "AB35 5RQ", 
    "customerEmail": "deepak.chopra@mymail.com", 
    "cardholderName": "Deepak Chopra"
}

Copy

Copied

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

When you make a successful call to the Imburse's Checkout token endpoint, you will receive a response with two properties - expires and sessionToken. The value shown next to the expires property is the date and time that the token will expire. This value is Unix (Epoch) timestamp. Use the handy form (below) to convert Unix timestamp to human-readable date.

Epoch

Step 4: Embed the Checkout token

The checkout session token can be used with Pay-By-Link object or with the Checkout web component that can be placed on your checkout page using an iFrame. To learn how to embed the checkout token into iFrame, see Embed Checkout Token.

To use the token as Pay-By-Link object, set the value of the sessionToken property as the value of token query string in your URL.

URL Syntax - https://sandbox-checkout.imbursepayments.com/?token=(sessionToken)
URL Example - https://sandbox-checkout.imbursepayments.com/?token=%2ff3kKKK...V6FmE

Step 5: 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

{
    ...
    "direction": "DEBIT",
    "status": "INCOMPLETE",
    "customerRef": "DEEPAK_004",
    "amount": 110.00,
    "currency": "GBP",
    "country": "UK",
    "settledByDate": "2022-12-01",
    "forecastedSettlementDate": null,
    "actualSettlementDate": null,
    ...    
    "transaction": {
      ...
      "status": "PROCESSING",
      ...
    },
    "failed": null,
    "cancelled": null
}

Troubleshooting

What should my customer expect?

After successfully loaded and initialized the web checkout form is shared with your customers, they will be presented a web form that should be like any other checkout screen. They can securely submit their Credit Card details through the checkout form.

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.