QRIS

Overview

QRIS is a payment method which allows customers to make purchases in Indonesia by scanning standardized QR codes with mobile banking applications and e-wallets. Payment processing by using this method involves the use of various applications supporting the QRIS standard (Quick Response Code Indonesian Standard). You can perform purchases through this method by using Payment Page and Gate.

General information

Payment method type	QR code payments
Payment instruments	bank accounts digital wallets
Countries and regions	ID
Payment currencies	IDR
Currency conversion	on the side of ecommpay
Purchases	+
Payouts	–
Credential-on-file (COF) purchase	–
Full refunds	–
Partial refunds	–
Chargebacks	+
Special considerations	For the IDR currency, payment processing of amounts with nonzero fractional part is not supported. If the IDR currency is specified in the request for payment processing, it is necessary to round the payment amount to an integer. If another currency is specified in the request, the payment amount is converted to an equivalent amount in the IDR currency on the ecommpay side and rounded up to an integer. For information about special aspects of rounding of amounts, refer to the ecommpay technical support specialists
Obtaining access to the payment method and access fee	Refer to your ecommpay Key Account Manager

Interaction diagram

Payment processing by using the QRIS payment method requires merchant's web service, one of ecommpay interfaces, and the ecommpay payment platform, as well as provider's the technical facilities.

Operations support

	Interfaces				Amounts, IDR		Timespans*
	Payment Page	CMS Plug-ins	Gate	Dashboard	minimum	maximum	basic time	threshold time
Purchases	+	–	+	–	10,000.00	2,000,000.00	–	–

* The basic and threshold times are defined as follows:

The basic time is an average time from the moment a payment is initiated in the payment platform to the moment the information about the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (where customer effort is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ecommpay technical support.

Processing scenarios

Payment processing by using the QRIS method involves scanning standardized QR codes with mobile banking applications and e-wallets.

Figure: Purchase by using Payment Page

Figure: Purchase by using Gate

The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchase by using Payment Page

General information

To process a purchase through Payment Page by using the QRIS method, the merchant web service needs to send a request with all the required parameters and signature to the ecommpay URL and receive a callback with the payment result from the payment platform. The QRIS method can also be set as preselected payment method when Payment Page opens. For more information about preselecting payment methods, see the Preselecting payment methods section. The full sequence and special aspects of the purchase processing are provided below.

Figure: Purchase processing by using Payment Page: Step-by-step description

Customer initiates a purchase in merchant's web service.
The web service sends the request for opening Payment Page to the specified ecommpay URL.
The request for opening Payment Page is sent to the payment platform.
The payment platform performs initial request processing which includes validation of the required parameters and signature.
In the ecommpay payment platform Payment Page is generated based on the project settings and parameters specified in the request.
Payment Page is displayed to the customer.
The customer selects the QRIS method.
The request for processing the payment is sent from Payment Page to the payment platform.
The payment platform processes the request.
The data for displaying the payment instructions to the customer is sent from the payment platform to Payment Page.
The payment instructions are displayed to the customer.
The customer completes all required payment steps.
The payment is processed on the side of the provider service.
The provider service sends a notification about the result to the payment platform.
The payment platform sends the callback with the payment result to the web service.
The payment platform sends the notification about the result to Payment Page.
Information about the payment result is displayed to the customer on Payment Page.

The following sections provide the detailed information about the request format and the Payment Page parameters to use in the QRIS payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when using the QRIS method:

You must provide values for the basic minimum of parameters. The following parameters are mandatory for any payment method:
- project_id—the project ID obtained from ecommpay
- payment_id—payment ID unique within the project
- payment_currency—payment currency in ISO-4217 alpha-3 format
- payment_amount—payment amount in minor units. If the IDR currency is specified in the request for payment processing, it is necessary to round the payment amount to an integer. If another currency is specified in the request, the payment amount is converted to an equivalent amount in the IDR currency on the ecommpay side and rounded up to an integer. For information about special aspects of rounding of amounts, refer to the ecommpay technical support specialists
- customer_id—customer ID unique within the project
If you need to have payment form displayed with the QRIS method selected, set the force_payment_method parameter to indonesia-qr.
If required, you can also add any other additional parameters Payment Page supports.
After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the QRIS method must include project, customer, and payment IDs, the currency and the amount of a payment in the appropriate currency, as shown in the following example:

    { payment_id: 'X03936', 
      payment_amount: 1000000, 
      payment_currency: 'IDR', 
      project_id: 123, 
      customer_id: 'customer1',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+5...ZzUCwX6R\/ekpZhkIQg=="
    }

For information about all parameters available in the QRIS method, see Parameters for opening payment form.

Callback format

The QRIS method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 100,000.00 IDR purchase made by the customer1 customer in the 1234 project.

Figure: Example of a successful purchase callback

{
        "project_id": 1234,
        "payment": {
            "id": "ABC12345",
            "type": "purchase",
            "status": "success",
            "date": "2021-06-03T09:18:49+0000",
            "method": "indonesia-qr",
            "sum": {
                "amount": 10000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 66524010061681,
            "type": "sale",
            "status": "success",
            "date": "2021-06-03T09:18:49+0000",
            "created_date": "2021-06-03T09:04:56+0000",
            "request_id": "312be99ad68be48100c724ce274e...066525",
            "sum_initial": {
                "amount": 10000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 10000000,
                "currency": "IDR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 5861,
                "payment_id": "32376801d1f6b6b6406...a02b4e45c",
                "auth_code": "",
                "date": "2021-06-03T09:18:39+0000"
            }
        },
        "signature": "LaWvR4EPqYRvsuU7Hl0H09l6uYR0dCIvFYSK...eiLtrjaJxLAhCBsxA=="
    }
}

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

{
            "id": "7890",
            "type": "purchase",
            "status": "decline",
            "date": "2021-06-04T06:19:47+0000",
            "method": "indonesia-qr",
            "sum": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 79864010068961,
            "type": "sale",
            "status": "decline",
            "date": "2021-06-04T06:19:47+0000",
            "created_date": "2021-06-03T06:19:31+0000",
            "request_id": "1504560d8c125cb12199c320ac41c...079865",
            "sum_initial": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 5861,
                "payment_id": "3237eceb715dc5ac46eb80edbde6fe2e24d4",
                "auth_code": ""
            }
        },
        "signature": "/NAM67hU7V7/tOQHaWOIRg68c...e8jhN6GIyC5idy9hiQ=="
    }

Purchase by using Gate

General information

To process a purchase through Gate by using the QRIS method, the merchant web service is required to do the following:

Send a request with all the required parameters and signature to the ecommpay URL.
Display the payment instructions to the customer.
Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

Figure: Purchase by using Gate: Step-by-step description

A customer initiates a purchase through QRIS on the merchant's web service side.
The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
The payment platform receives the request for processing the purchase from Gate.
The payment platform performs the initial request processing that includes validation of the required parameters and signature.
The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
The payment platform performs the internal payment request processing.
The payment platform sends the callback with the payment instructions data to the web service.
The payment instructions are displayed to the customer.
The customer completes all the payment steps required.
The payment is processed on the provider service side.
The provider service sends the payment result notification to the payment platform.
The payment platform sends a callback to the web service.
The customer receives the payment result on the web service.

The following sections provide the detailed information about the request format and the Gate parameters to use in the QRIS payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests in the QRIS method:

You send purchase requests by sending the request to /v2/payment/banks/indonesia-qr/sale by using the POST (HTTP) method. This request belongs to the following request group /v2/payment/banks/{payment_method}/sale.
The following objects and parameters must be specified in any request:
- Object general—general purchase information:
  - project_id—project ID obtained from ecommpay
  - payment_id—payment ID unique within the project
  - signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
- Object customer—customer information:
  - id—customer ID unique within the project
  - ip_address—customer IP address
- Object payment—purchase information:
  - amount—payment amount in minor units. If the IDR currency is specified in the request for payment processing, it is necessary to round the payment amount to an integer. If another currency is specified in the request, the payment amount is converted to an equivalent amount in the IDR currency on the ecommpay side and rounded up to an integer. For information about special aspects of rounding of amounts, refer to the ecommpay technical support specialists
  - currency—payment currency in the ISO-4217 alpha-3 format
If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the QRIS method must include project, payment and customer IDs, the currency and the amount of a payment in the appropriate currency, IP address of the customer and signature, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
      "project_id": 1234567,
      "payment_id": "12278b5d662764c9506...c5c35",
      "signature": "GINgwlggTvpF9AnkT8rUUVC7bmSCAa...JChDjj40xI5vOA7w=="
    },
    "customer": {
       
      "id": "customer1",
      "ip_address": "1.1.1.1"
    },
    "payment": {
      "amount": 1000000,
      "currency": "IDR"
  }
}

Formats of data for displaying the payment instructions

To display the payment instructions to the customer, you must receive and process a callback from the payment platform containing the payment data in the in the display_data array and display the customer the payment instructions to the customer.

The array display_data contains the following parameters:

type—data type (the value is always qr_data)
title—title of the data to be displayed to the customer (the value is always qr_code_data)
data—string which contains the coded image of the QR code.

The following is the callback fragment containing the payment data.

"display_data": [
            {
                "type": "qr_data",
                "title": "qr_code_data",
                "data": "00020101021226530012...40014ID.CO.QRIS.WWW0215ID20200311332370303URE5204323753033605405100005502015802ID5911TARGETWIRES6007jakarta61059999962470703A015036323777b2dadc0aa04fdb82a0cc2349be345c63048782"
            }
]

Callback format

The QRIS method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 100,000.00 IDR purchase made by the customer1 customer in the 1234 project.

Figure: Example of a successful purchase callback

{
        "project_id": 1234,
        "payment": {
            "id": "ABC12345",
            "type": "purchase",
            "status": "success",
            "date": "2021-06-03T09:18:49+0000",
            "method": "indonesia-qr",
            "sum": {
                "amount": 10000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 66524010061681,
            "type": "sale",
            "status": "success",
            "date": "2021-06-03T09:18:49+0000",
            "created_date": "2021-06-03T09:04:56+0000",
            "request_id": "312be99ad68be48100c724ce274e...066525",
            "sum_initial": {
                "amount": 10000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 10000000,
                "currency": "IDR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 5861,
                "payment_id": "32376801d1f6b6b6406...a02b4e45c",
                "auth_code": "",
                "date": "2021-06-03T09:18:39+0000"
            }
        },
        "signature": "LaWvR4EPqYRvsuU7Hl0H09l6uYR0dCIvFYSK...eiLtrjaJxLAhCBsxA=="
    }
}

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

{
            "id": "7890",
            "type": "purchase",
            "status": "decline",
            "date": "2021-06-04T06:19:47+0000",
            "method": "indonesia-qr",
            "sum": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "description": ""
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 79864010068961,
            "type": "sale",
            "status": "decline",
            "date": "2021-06-04T06:19:47+0000",
            "created_date": "2021-06-03T06:19:31+0000",
            "request_id": "1504560d8c125cb12199c320ac41c...079865",
            "sum_initial": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "sum_converted": {
                "amount": 1000000,
                "currency": "IDR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 5861,
                "payment_id": "3237eceb715dc5ac46eb80edbde6fe2e24d4",
                "auth_code": ""
            }
        },
        "signature": "/NAM67hU7V7/tOQHaWOIRg68c...e8jhN6GIyC5idy9hiQ=="
    }

Analysis of payment results

As with other payment methods ecommpay offers, when using the QRIS method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ecommpay technical support.

QRIS

Overview

General information

Interaction diagram

Operations support

Processing scenarios

Purchase by using Payment Page

General information

Request format

Callback format

Related topics

Purchase by using Gate

General information

Request format

Formats of data for displaying the payment instructions

Callback format

Related topics

Analysis of payment results