1. Introduction

CX+ – Deep API allow merchants to complete their customers' payment journey through simplified steps.

The advantages of such an integration are to allow seamless customer experience to their customers, be it on the website or on an app. The merchant can manage checkout experience and define the workflows for various scenarios.

Refer BillDesk CX+ – Deep API documentation and complete their transactions.

2. Salient Features

• Manage end customer experience, be it on merchant's website or on merchant app
• Manage & control payment method
• Manage payment lifecycle post transaction through "Retrieve Transaction" or "Refund Transaction" API

3. Experience the Product

To get a first-hand experience of how the API works, BillDesk requests to go to API Playground.

4. Integration Steps

Depending on the payment method, the orchestration of the APIs/ workflow has been explained below:

4.1 For Card (PAN Based Transactions)

BillDesk presents a range of payment methods that cater to specific use cases, transaction amounts, and transaction process types. In this section, for payment_method_type as card the details of the workflow are defined as follows. These steps will help the merchant to understand how they can complete a payment journey.

Step 1. Create Transaction

To initiate payment transaction using card details, use the Create Transaction API. The steps explain how the cardholder can complete their transaction on merchant website/ app.

To provision token with the payment request, the Create Transaction API also allows merchant to save the card (post customer consent) or Card-on-File Tokenisation (CoFT) for the card details sent in the request object.

• Pass attributes such as tokenize & coft_consent. These attributes will help in creating token for the card passed in card object.

To create a transaction use, Create Transaction API. Here are some of the attributes required to initiate create transaction request.

Request Body (Sample)

Response Body (Sample)

Response of the Create Transaction API will essentially inform the merchants to follow the next step that is required.

📘

Call to action by merchant

From the response of Create Transaction API, merchant will receive the links array object:

• Pass the attributes & their corresponding values from the parameters object.
• Method attribute suggest 'GET/ POST', which the merchant should appropriately manage.
• Redirect the customer to the href URL basis the attributes/method mentioned above.

{
  //Sample code. Actual response will vary.
  "links": [
	{
		"href": "https://www.issueurl.com/page.jsp",
		"rel": "redirect",
		"method": "post",
		"parameters": {
      //BillDesk in response may send either "creq" or "bdcreq" as the attribute
			"creq": "eyJtZXNzYWdl2luZG93U2l6ZSI6IjA1In0="
		}
	}
],
"next_step":"3ds2_challenge",
"eci":"05",
"auth_status":"0002"
}

❗️

Note

The attributes and their values in parameters object are dynamic in nature. Please do not hard code these attributes/values at merchant's end.

Step 2. Update Transaction

Update Transaction is the second step, to authorize the payment. The step is essential for all card/token led transactions. Merchant should initiate update transaction API post authentication is successfully complete.

To update a transaction use, Update Transaction API. Here are some of the attributes required to initiate update transaction request.

4.2 For Card (using Network/ Issuer Token)

BillDesk supports network/ issue token-based transactions. In this section, for payment_method_type as card the details of the workflow are defined as follows:

Step 1. Create Transaction

To initiate payment transaction using network or issuer token, use the Create Transaction API. For one time transaction with network/ issuer token object.

Request Body (Sample)

Request body mentioned in section 4.1 above will be used with network token object for initiating a transaction.

Response Body (Sample)

Response body mentioned in section 4.1 above will be used by the merchant.

Understanding the various Create Transaction Status codes:

Step 2. Update Transaction

Update Transaction is the second step, to authorize the payment. The step is essential for all card/token led transactions. Merchant should initiate update transaction API post authentication is successfully complete.

To update a transaction use, Update Transaction API.

4.3 For Card (using Alt ID Token)

BillDesk supports Alt ID based transactions (referred as Guest Checkout Transactions). The Alt ID can be fetched using BillDesk API. To know more about Fetch Alt ID API, click here.

In this section, for payment_method_type as card the details of the workflow are defined as follows:

Step 1. Create Transaction

To initiate payment transaction using Alt ID token, use the Create Transaction API. Merchant needs to send Alt ID token details within the card object as part of request object. For one time transaction with Alt ID token object, please refer below sample. Click here to access the API.

Request Body (Sample)

Request body mentioned in section 4.1 above will be used with altid token object for initiating a transaction.

Response Body (Sample)

Response body mentioned in section 4.1 above will be used by the merchant.

Understanding the various Create Transaction Status codes:

Step 2. Update Transaction

Update Transaction is the second step, to authorize the payment. The step is essential for all card/token led transactions. Merchant should initiate update transaction API post authentication is successfully complete.

To update a transaction use, Update Transaction API.

4.4 For UPI

BillDesk offers UPI payment method with three variations such as Collect, QR and Intent. In this section, for payment_method_type as upi the details of the workflow are defined as follows:

Step 1. Create Transaction (with UPI)

Merchant can initiate payment transaction using UPI. BillDesk supports different processing types for upi like, collect, qr or intent. For one time transaction with UPI, please refer below sample. Click here to access the API.

Request Body (Sample)

Request body mentioned in section 4.1 above will be used with upi object for initiating a transaction.

Response Body (Sample)

Response body mentioned in section 4.1 above will be used by the merchant.

Understanding the various Create Transaction Status codes

Step 2. Transaction Status via Webhook

UPI transactions are asynchronous transaction, thus the status update by the network scheme happens after sometime (usually response is received within a few milliseconds).

BillDesk will update the merchant for the payment method upi via Webhook.

4.5 For NetBanking, Wallet & Cashcard

BillDesk also offers NetBanking as payment method. In this section, for payment_method_type as netbanking the details of the workflow are defined as follows:

Step 1. Create Transaction

Merchant can also initiate payment transaction using netbanking. For one time transaction with netbanking, please refer below sample. Click here to access the API.

Request Body (Sample)

Request body mentioned in section 4.1 above will be used with netbanking object for initiating a transaction.

Response Body (Sample)

Response body mentioned in section 4.1 above will be used by the merchant.

Understanding the various Create Transaction Status codes

📘

Note

Merchant can make use of below mentioned APIs to complete the transaction lifecycle at their end.

5. Next Steps

6. API Orchestration

The orchestration of the API/s workflow has been explained below:

Transaction Use cases: