DvPayLite Deep Linking Integration - URI Mode

Version History

Prerequisites

• iPOSpays-powered Dejavoo terminal
• Login credential to iPOSpays (opens in a new tab)
• The host application must be listed on DvStore. If you haven't done so already, please fill out the necessary form to list your application. List now

For Sandbox (UAT)

Users should be onboarded on iPOSpays sandbox(UAT) environment as a merchant and have a valid CloudPOS TPN.

For Production (Live)

Users should be onboarded on iPOSpays production environment as a merchant and have a valid CloudPOS TPN.

Set Up the Developer Environment

1. Android Studio IDE

Download and set up Android Studio from developer.android.com (opens in a new tab).

2. Develop an Android Application

• Create a new Android project or use an existing one.
• Follow the steps outlined below:
  • Set the scheme as "denovopay" when creating the URI.
  • Update the host based on the type of transaction.
  • Refer to the Perform Transaction API section in this document for transaction types and sample input requests.

Install DvPayLite Application

Ensure the DvPayLite application is installed on the payment terminal. If it is not installed, complete the installation before proceeding with the integration.

Version Control and Updates

Non-Breaking Changes

• We will continue to enhance the API by adding new functionality and fixing bugs over time.
• These updates may include:
  • New endpoints
  • Additional attributes for existing objects
• Such changes will not require a new API version. Ensure your code can handle new attributes gracefully and does not rely on the order of returned records unless explicitly specified in the documentation.

Breaking Changes

• We aim to maintain the current API version for the foreseeable future.
• In the event of changes that break the current API's functionality, a new version number will be released to ensure backward compatibility with existing integrations
• Refer to the Version History to review the version history of this document.

High-level flow

The following is a high-level flow to communicate with the DvPay Lite Application.

APIs

Device Register API

The Device Register API is used to download terminal and merchant configuration data from the backend application into the DvPayLite application.

Host: “register”

Intent will return transactionResult in the activity result.

Request Parameters:

Response Parameters:

Response(transactionResultJson) Details:

1. if success

2. if failure

Snippet code:

jsonRequest = {
    “tpn”:”123456789012”, 
    “applicationType”:”DVPAYLITE”
    }

sample - scheme + "://" + host + "?data=" + Request (Passing Request as Url encoded(UTF-8))

Perform Transaction API

This API is used to invoke the DvPayLite application to perform a transaction. It supports the following transaction types: SALE, REFUND, VOID, PRE_AUTH, INC_AUTH, TICKET, ACTIVATE, INQUIRE, REDEEM, REISSUE, REFUND, VOID.

Host: “pay”

The Intent will return transactionResult in the activity result.

Request parameters

Response Parameters:

Response(transactionResultJson) Details

{"dueAmnt":"0.00",
"approvedAmnt":"",
"isPartialApprovalTxn":false,
"voided":"false"}

Snippet Code:

const jsonRequest = {
  "type": "SALE",
  "amount": "10.00",
  "tip": "1.00",
  "applicationType": "DVPAYLITE",
  "refId": "1234567890",
  "isTxnStatusScreenRequired": "Yes",
  "IsvId": "124234234234",
  "showBreakupScreen": "Yes",
  "showTipScreen": "Yes",
  "reconId": "FSRV12345A",
  "MerchantId":"123456789012"
};

Example : scheme + "://" + host + "?data=" + Request (Passing Request as Url encoded)

Batch Settlement API

A batch is a group of transactions that have been processed but have yet to be settled. When a transaction is approved, it is added to the batch. When a batch hasn't been settled yet, it is called an open batch, and transactions in the batch can still be voided and reversed if needed.

Host: “settle”

The Intent will return transactionResult in the activity result.

Request parameters

Response Parameters:

Response(transactionResultJson) Details

Snippet Code

settleReq = {
    “type”:”SETTLE”, 
    “applicationType”:”DVPAYLITE”
    }

Example : scheme + "://" + host + "?data=" + Request (Passing Request as Url encoded)

Tip Adjust API

This API is used to perform a tip adjustment on a sale transaction.

Host: “pay” The intent will return transactionResult in the activity result.

Request parameters

Response Parameters

Same as Perform Transaction API

Snippet Code

jsonRequest = 
    {“type”:”TIP ADJUST”, 
    “amount”:”10.00”, 
    “tip”:”1.00”, 
    “applicationType”:”DVPAYLITE”, 
    “refId”:”1234567890”}

Example : scheme + "://" + host + "?data=" + Request (Passing Request as Url encoded)

Get TPN API

This API is used to retrieve the TPN (Terminal Processing Number) of a device.

Host: “get”

The intent will return transactionResult in the activity result.

Request parameters

Response Parameters

Response Details

Snippet Code

jsonRequest = 
            {"applicationType":"DVPAYLITE", 
            "type":"getTPN"}

Example: scheme + "://" + host + "?data=" + Request (Passing Request as Url encoded)

Device detail API

This API is used to obtain the details of the device.

Host: “get”

The intent will return transactionResult in the activity result.

Request parameters

Response Parameters

Response parameters

Snippet Code

jsonRequest = 
{"applicationType":"DVPAYLITE", 
"type":"getDevice"}

Example : scheme + "://" + host + "?data=" + Request (Passing Request as Url encoded)

Status Check API

This API is used to retrieve the current transaction status.

Host: “pay”

The intent will return transactionResult in the activity result.

Request parameters

Response Details

Same as Perform Transaction API

Snippet Code

jsonRequest = 
{“type”:” STATUS”,
“applicationType”:”DVPAYLITE”, 
“refId”:”1234567890”}

Example : scheme + "://" + host + "?data=" + Request (Passing Request as Url encoded)

Administrative Txn API

This API is used to retrieve card numbers.

Host: “pay” The intent will return transactionResult in the activity result.

Request parameters

Response Parameters:

Snippet Code

jsonRequest = 
{“type”:” ADMINISTRATIVE_TXN”,
“applicationType”:”DVPAYLITE”}

Example : scheme + "://" + host + "?data=" + Request (Passing Request as Url encoded)

Go Live Requirements

The following are the Go Live activities:

• All third-party app integrations with DvPay Lite via deep-linking will be hosted in our DvStore application, which is provided as a default app in the firmware of production terminals.
• To host an application in the app market, please contact the Dev Support team using the email provided below.
• Once the application is hosted in the DvStore app, it can be downloaded to terminals and updated by hosting newer versions of the app.
• Applications can be tested in test environments before being uploaded to production environments.

Help

For any questions or suggestions, email us directly at devsupport@dejavoo.io.