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.

In QRIS, payments are processed by using one of the two channels: channel 1—without customer redirection, or channel 2—with redirection of the customer to the provider service. For the information which of the channels to use, refer to your Monetix key account manager.

Download the logo in vector format here.

Payment method type Payments by using QR code
Countries and regions Indonesia
Payment currencies IDR
Currency conversion On the side of Monetix
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 Monetix side and rounded up to an integer. For information about special aspects of rounding of amounts, refer to the Monetix technical support specialists.
  • When making a purchase, the customer can specify a payment amount which is different from the one specified in the request. Information on how to handle such cases is provided in Handling payments with amount changed by customer.
Onboarding and access fee Refer to your Monetix key account manager

Interaction diagram

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

Operations support

Interfaces Amounts, IDR (channel 1) Amounts, IDR (channel 2)
Payment Page Gate Dashboard minimum maximum minimum maximum
Purchases 10,000.00 2,000,000.00 15,000.00 10,000,000.00

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section and click the Payment methods tab.

Processing scenarios

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

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

Purchase by using Payment Page. Channel 1: no customer redirection

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 Monetix 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 5. Purchase processing by using Payment Page: Step-by-step description
  1. Customer initiates a purchase in merchant's web service.
  2. The web service sends the request for opening Payment Page to the specified Monetix URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform performs initial request processing which includes validation of the required parameters and signature.
  5. In the Monetix payment platform Payment Page is generated based on the project settings and parameters specified in the request.
  6. Payment Page is displayed to the customer.
  7. The customer selects the QRIS method.
  8. The request for processing the payment is sent from Payment Page to the payment platform.
  9. The payment platform processes the request.
  10. The data for displaying the payment instructions to the customer is sent from the payment platform to Payment Page.
  11. The payment instructions are displayed to the customer.
  12. The customer completes all required payment steps.
  13. The payment is processed on the side of the provider service.
  14. The provider service sends a notification about the result to the payment platform.
  15. The payment platform sends the callback with the payment result to the web service.
  16. The payment platform sends the notification about the result to Payment Page.
  17. 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:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are required for any payment method:
    • project_id—the project ID obtained from Monetix
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor currency units without any decimal point or comma. 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 Monetix side and rounded up to an integer. For information about special aspects of rounding of amounts, refer to the Monetix technical support specialists.

      If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.

    • customer_id—the unique ID of the customer within your project
    • customer_email—customer email
    • customer_first_name—customer first name
    • customer_last_name—customer last name
  2. If you need to have payment form displayed with the QRIS method selected, set the force_payment_method parameter to indonesia-qr.
  3. If required, you can also add any other additional parameters Payment Page supports.
  4. 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.

Here is an example of data from a request for Payment Page opening:

EPayWidget.run(
    {
        project_id: 1234,
        payment_id: 'payment_47',
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@example.com',
        payment_currency: 'IDR',
        payment_amount: 1000000,    
        signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the QRIS method, see Payment Page invocation parameters.

Callback format

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

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 6. 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 7. 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=="
    }

Related topics

The following topics might be useful when implementing payments by using Payment Page:

Purchase by using Payment Page. Channel 2: customer redirection

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 Monetix 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 8. Purchase processing by using Payment Page: Step-by-step description
  1. Customer initiates a purchase in merchant's web service.
  2. The web service sends the request for opening Payment Page to the specified Monetix URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform performs initial request processing which includes validation of the required parameters and signature.
  5. In the Monetix payment platform Payment Page is generated based on the project settings and parameters specified in the request.
  6. Payment Page is displayed to the customer.
  7. The customer selects the QRIS method.
  8. The request for processing the payment is sent from Payment Page to the payment platform.
  9. The payment platform processes the request.
  10. The data for customer redirection is sent from the payment platform to Payment Page.
  11. The customer is redirected to the provider service.
  12. The customer completes all required payment steps.
  13. The payment is processed on the side of the provider service.
  14. The provider service sends a notification about the result to the payment platform.
  15. The payment platform sends the callback with the payment result to the web service.
  16. The payment platform sends the notification about the result to Payment Page.
  17. 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:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are required for any payment method:
    • project_id—the project ID obtained from Monetix
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor currency units without any decimal point or comma. If the IDR currency is specified in the request for payment processing, you are required to round the payment amount to an integer value. If another currency is specified in the request, the payment amount is converted to an equivalent amount in the IDR currency on the Monetix side and rounded up to an integer. For information about rounding of amounts, refer to the Monetix technical support specialists.

      If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.

    • customer_id—the unique ID of the customer within your project
    • customer_email—customer email
    • customer_first_name—customer first name
    • customer_last_name—customer last name
  2. If you need to have payment form displayed with the QRIS method selected, set the force_payment_method parameter to indonesia-qr.
  3. If required, you can also add any other additional parameters Payment Page supports.
  4. 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.

Here is an example of data from a request for Payment Page opening:

EPayWidget.run(
    {
        project_id: 1234,
        payment_id: 'payment_47',
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@example.com',
        payment_currency: 'IDR',
        payment_amount: 1000000,    
        signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the QRIS method, see Payment Page invocation parameters.

Callback format

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

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 9. 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 10. 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=="
    }

Related topics

The following topics might be useful when implementing payments by using Payment Page:

Purchase by using Gate. Channel 1: no customer redirection

General information

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

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

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

Figure 11. Purchase by using Gate: Step-by-step description
  1. A customer initiates a purchase through QRIS on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified Monetix URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response structure.
  6. The payment platform performs the internal payment request processing.
  7. The payment platform sends the callback with the payment instructions data to the web service.
  8. The payment instructions are displayed to the customer.
  9. The customer completes all the payment steps required.
  10. The payment is processed on the provider service side.
  11. The provider service sends the payment result notification to the payment platform.
  12. The payment platform sends a callback to the web service.
  13. 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:
  1. 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.
  2. The following objects and parameters must be specified in any request:
    • general—object with general request identification information:
      • project_id—project ID obtained from Monetix
      • 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
    • customer—object with customer information:
      • id—the unique ID of the customer within your project
      • ip_address—IP address of the customer's device
      • email—customer email
      • first_name—customer first name
      • last_name—customer last name
    • payment—object with purchase information:
      • amount—purchase amount in minor currency units without any decimal point or comma. 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 Monetix side and rounded up to an integer. For information about special aspects of rounding of amounts, refer to the Monetix technical support specialists.

        If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.

      • currency—code of purchase currency in the ISO-4217 alpha-3 format
  3. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a purchase request in the QRIS method.

Figure 12. Example of a purchase request
{
    "general": {
        "project_id": 1234567,
        "payment_id": "12278b5d662764c9506...c5c35",
        "signature": "GINgwlggTvpF9AnkT8rUUVC7bmSCAa...JChDjj40xI5vOA7w=="
    },
    "customer": {
        "id": "customer1",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "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 in Gate.

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 13. 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 14. 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=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Purchase by using Gate. Channel 2: customer redirection

General information

In the QRIS method, the merchant web service is required to do the following when processing a purchase by using Gate:

  1. Send request with all the required parameters and signature to the Monetix URL.
  2. Redirect the customer to the QRIS service.
  3. Accept the callback with the payment result from the payment platform.

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

Figure 15. Purchase by using Gate: Step-by-step description
  1. Customer initiates purchase with QRIS on the merchant's web service side.
  2. The web service sends a request for processing the purchase by using Gate to the Monetix URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs initial request processing that includes validation whether all required parameters are available and signature is correct.
  5. The payment platform sends the response with request receipt confirmation and validation result to the web service. For more information about the response format, see Response structure.
  6. The payment platform performs the internal payment request processing.
  7. The payment platform sends the callback with the redirection data inside the redirect_data object to the web service.
  8. The customer is redirected from the web service to the QRIS service.
  9. The customer completes all the payment steps required.
  10. The payment is processed on the QRIS service side.
  11. The result is displayed to the customer.
  12. The QRIS service sends the payment result notification to the payment platform.
  13. The payment platform sends the callback with the payment result to the web service.
  14. The web service sends the payment result to the customer.

The sections that follow discuss in more details the request format and the Gate parameters to use in the QRIS payment method and provide the information about the format of callbacks with purchase results. For the general information on how to use the Gate API, see API Description.

Request format

There are several things you need to consider when dealing with purchase requests in the QRIS method:

  1. You initiate purchase request by sending a request to the /v2/payment/banks/indonesia-qr/sale endpoint by using HTTP method POST. This request belongs to the following request group /v2/payment/banks/{payment_method}/sale.
  2. The following objects and parameters must be specified in any request:
    • general—object with general request identification information:
      • project_id—project ID obtained from Monetix
      • 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
    • customer—object with customer information:
      • id—the unique ID of the customer within your project
      • ip_address—IP address of the customer's device
      • email—customer email
      • first_name—customer first name
      • last_name—customer last name
    • payment—object with purchase information:
      • amount—purchase amount in minor currency units without any decimal point or comma. 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 Monetix side and rounded up to an integer. For information about special aspects of rounding of amounts, refer to the Monetix technical support specialists.

        If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.

      • currency—code of purchase currency in the ISO-4217 alpha-3 format
  3. The following parameters with the return URLs are optional, but we strongly advise you to specify them in the request to provide your customer a better user experience. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix.
    • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
      • success—the URL to redirect the customer to after the payment is successfully completed
      • decline—the URL to redirect the customer to after the payment is declined
      • return—the URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request.
  4. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a purchase request in the QRIS method.

Figure 16. Example of a purchase request
{
    "general": {
        "project_id": 1234567,
        "payment_id": "12278b5d662764c9506...c5c35",
        "signature": "GINgwlggTvpF9AnkT8rUUVC7bmSCAa...JChDjj40xI5vOA7w=="
    },
    "customer": {
        "id": "customer1",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "payment": {
        "amount": 1000000,
        "currency": "IDR"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

Format of customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect the customer to the QRIS service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

  • url—the URL to redirect the customer to
  • body—the data to be sent in the request body
  • method—the HTTP method to get an HTML page of the website (for example, POST or GET)
  • encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing the data to redirect the customer.

"redirect_data": {
    "method": "POST",
    "body": {
        "example_parameter_1": "value_1",
        "example_parameter_2": "value_2"
    },
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback format

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

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 17. 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 18. 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=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Testing

General information

You can perform test purchases with the QRIS payment method by using Payment Page and Gate in the first channel of purchase processing.

To perform test purchases, you'll need the test project ID and the secret key to it. To get them, contact the technical support team at support@monetix.pro.

When performing test payments, keep in mind that:

  • your requests must contain the test project ID
  • the payment currency that you send in requests can be only IDR
  • random values may be used as the payment ID and in the parameters with customer information
  • the interface of the test checkout page may be different from the production one.

Test payments statuses

To receive one of the following statuses in the callback with the test purchase result, use a particular value for the purchase amount in the request:

  • decline—when using 40000 or 40400 amount
  • success—when using any amount other than those mentioned above

Testing purchase by using Payment Page

To perform a test purchase by using Payment Page:

  1. Send a request for purchase through Payment Page to the payment platform.
  2. Choose a payment method on the test checkout page. If you've passed the force_payment_method parameter with the indonesia-qr value in the request, you won't have to choose the payment method.
  3. Wait for the QR code to display to you on the checkout page.
  4. Accept a callback with information about the test purchase result.
  5. Wait a few seconds until the result of the test purchase is displayed to you on the test checkout page.

See the detailed information about purchase processing through Payment Page in the QRIS payment method in the Purchase by using Payment Page. Channel 1: no customer redirection section.

Testing purchase by using Gate

To perform a test purchase by using Gate:

  1. Send a request for performing a test purchase to the payment platform.
  2. Accept a callback with the data for displaying the QR code. Your system will display the QR code to you after.
  3. Accept a callback with information about the test payment result.
  4. Wait a few seconds until your system shows you the result of the test purchase.

See the detailed information about purchase processing through Gate in the QRIS payment method in the Purchase by using Gate. Channel 1: no customer redirection section.

Analysis of payments results

As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.

You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com), for instance you can use the analytic panels in the Analytics section for this purpose.

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 format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
  • 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 means of sending requests to the /operations/get endpoint.

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