QRIS

Introduction

QRIS is a payment method which allows to process payments in Indonesian rupiahs by using bank accounts and e-wallets in Indonesia. Payment processing by using this method involves the use of various applications supporting the QRIS standard (Quick Response Code Indonesian Standard). This method supports purchases.

This article provides information about working with the QRIS method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Interaction diagram

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

Operations support

Various platform interfaces can be used to process payments and perform operations using the QRIS method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links). At the same time, regardless of the interfaces used, the following limitations are applicable.

When working with the QRIS the following limitations are applicable.

Processing scenarios

To perform a purchase by using the QRIS method, the customer needs to scan QR code by using a mobile banking application.

Figure: Purchase by using Payment Page

Figure: Purchase by using Gate

General information

To process a purchase through Payment Page by using the QRIS method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.

Information about the formats of requests and callbacks used for processing payments by using the QRIS method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

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

1. The following parameters required for any payment must be specified:
   • project_id—project identifier obtained from ecommpay during integration
   • payment_id—payment identifier unique within the project
   • payment_currency—payment currency code in the ISO-4217 alpha-3 format
   • payment_amount—payment amount in the smallest currency unit. 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 identifier unique within the project
2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
3. It may be necessary to specify the first and last names of the customer in the customer_first_name and customer_last_name parameters. Refer to your ecommpay key account manager for more information on the necessity of using theses parameters.
4. If you need to have the payment form displayed with the QRIS method selected, set the force_payment_method parameter to indonesia-qr.
5. Additionally, any other parameters available for working with Payment Page can be used (details).
6. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the QRIS method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000000,
   "payment_currency": "IDR",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_first_name": "Doe",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000000,
   "payment_currency": "IDR",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_first_name": "Doe",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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 information about a 100,000.00 IDR purchase made in the 1234 project.

{
        "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 with information about a declined purchase.

{
            "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=="
    }

Useful links

The following articles can be useful when implementing purchases via Payment Page:

• Interaction concepts—about the interaction with the payment platform by using Payment Page.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.

General information

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

1. Send a request with all the required parameters and signature to the ecommpay URL.
2. Receive an intermediate callback from the payment platform and display the payment instructions to the customer.
3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.

Information about the formats of requests and callbacks used for processing payments by using the QRIS method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the QRIS method:

1. To initiate each purchase, send a separate POST request to the /v2/payment/banks/indonesia-qr/sale endpoint. This endpoint belongs to the group /v2/payment/banks/{payment_method}/sale.
2. Each request must include the following objects and parameters:
   • Object general—general purchase information:
     • project_id—project identifier obtained from ecommpay during integration
     • payment_id—payment identifier unique within the project
     • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
   • Object payment—payment information:
     • amount—payment amount in the smallest currency unit. 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 code in the ISO-4217 alpha-3 format
   • Object customer—customer information:
     • id—customer identifier unique within the project
     • ip_address—customer IP address relevant for the initiated payment
3. It may also be required to specify the first name and the last name of the customer in the corresponding parameters:
   • Object customer—customer information:
     • first_name—customer first name
     • last_name—customer last name
   • Object return_url—contains the URLs to which customer is redirected during or after payment processing:
     • return—URL to return customer to the web service during any step before the payment is completed

   Refer to your ecommpay key account manager for more information on the necessity of using theses parameters.

4. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the QRIS method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, URL for redirection, as well as signature.

{
    "general": {
      "project_id": 1234567,
      "payment_id": "12278b5d662764c9506...c5c35",
      "signature": "GINgwlggTvpF9AnkT8rUUVC7JChDjj40xI5vOA7w=="
    },
    "customer": {
      "id": "customer1",
      "ip_address": "192.0.2.0"
      "first_name": "John",
      "last_name": "Doe"
    },
    "payment": {
      "amount": 1000000,
      "currency": "IDR"
    },
    "return_url": {
      "return": "https://example.com/return"
    }
}

{
    "general": {
      "project_id": 1234567,
      "payment_id": "12278b5d662764c9506...c5c35",
      "signature": "GINgwlggTvpF9AnkT8rUUVC7JChDjj40xI5vOA7w=="
    },
    "customer": {
      "id": "customer1",
      "ip_address": "192.0.2.0"
      "first_name": "John",
      "last_name": "Doe"
    },
    "payment": {
      "amount": 1000000,
      "currency": "IDR"
    },
    "return_url": {
      "return": "https://example.com/return"
    }
}

Formats of intermediate callbacks containing data for displaying 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"
            }
]

Final 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 information about a 100,000.00 IDR purchase made in the 1234 project.

{
        "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 with information about a declined purchase.

{
            "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=="
    }

Useful links

The following articles can be useful when implementing purchases via Gate:

• Interaction concepts—about the interaction with the payment platform by using Gate.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.