VietQR

Overview

VietQR is a payment method that allows customers to perform payments in Vietnam by scanning QR codes with mobile banking applications. A payment is credited immediately after a customer confirms the withdrawal by entering OTP or predefined payment code within secure environment of the app. Purchases are performed by using Payment Page and Gate.

In VietQR, payments are processed by using one of the two channels: channel 1—with customer redirection, or channel 2—without redirection of the customer to the provider service. For the information on 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 Viet Nam
Payment currencies VND
Currency conversion On the Monetix side
Purchases
Payouts
COF payments
Full refunds
Partial refunds
Chargebacks
Notes
  • For VND, amounts are specified without decimals.
  • By using VietQR, any customer with an account with any Vietnamese bank can make no-commission payments.
  • If the customer enters an incorrect payment amount, the payment is processed in a specific way described in the section Handling payments with amount changed by customer.
  • For the purchase processing without customer redirection: The timer on the Payment Page displays the time limit of the QR code. For the individual setting of this time limit, contact the Monetix technical support specialists.
Onboarding and access fee Refer to your Monetix key account manager

Interaction diagram

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

Operations support

Interfaces Amounts, VND Times
Payment Page Gate Dashboard minimum maximum basic threshold
Purchases * 300 000 000 * *

* Refer to your Monetix key account manager for more information.

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

Depending on the channel you use, the purchase scenario in VietQR may be one of the following:

  • Channel 1—the customer is redirected to the provider service to complete the payment
  • Channel 2—the customer scans the received QR code with the mobile app

For the information on which of the channels to use, refer to your Monetix key account manager.

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: customer redirection

General information

In the VietQR method, to perform a purchase by using Payment Page, the merchant web service is required to send a request with all the required parameters and signature to the Monetix URL and accept the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the VietQR method pre-selected. (For more information about pre-selecting payment methods, see in Preselecting payment methods.)

Figure 5. Purchase by using Payment Page: steps description
  1. Customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified Monetix URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the Monetix payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the VietQR method and, depending on the payment processing provider, selects a bank for purchasing.
  8. The payment platform receives the purchase request for payment processing from Payment Page.
  9. The payment platform performs the internal purchase request processing and sends it to the VietQR service.
  10. The purchase request is processed on the VietQR service side.
  11. The VietQR service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the VietQR website.
  14. The customer completes all the payment steps required.
  15. The payment is processed on the VietQR side.
  16. The result is displayed to the customer on the VietQR website.
  17. The customer is redirected to Payment Page.
  18. The VietQR service sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the VietQR 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 VietQR 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—project ID obtained from Monetix
    • payment_id—payment ID unique within the project
    • 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
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—purchase amount in major currency units without any fractional part.

      If the currency does have minor units (that is, the number of digits for minor currency units is not zero), then you must set this parameter to the amount in minor currency units without any decimal point or comma . For the information on whether the currency has any minor units, see Currency codes.

  2. If you need to have payment form displayed with the VietQR method pre-selected, set the force_payment_method parameter to the code on the vietqr payment method.
  3. You can also add any other additional parameters Payment Page supports. For more information about parameters supported by Payment Page, see Payment Page invocation parameters.
  4. After you specify all the parameters you need, you need to generate signature for the request. For instructions on how to sign payment requests, 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: 'VND',
        payment_amount: 300000,    
        signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Callback format

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

Callbacks can include additional parameters with information about the customer in the account object:
  • number—customer's account number;
  • customer_name—customer's name;
  • bank_code—customer's bank code.

Please contact your Monetix key account manager to confirm whether this option is available to you.

The following is an example of a callback with an information about successful 300,000 VND purchase made in the 1234 project.

Figure 6. Example of data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "EPd3f4-9b1a",
        "type": "purchase",
        "status": "success",
        "date": "2020-11-06T13:16:50+0000",
        "method": "VietQR",
        "sum": {
            "amount": 300000,
            "currency": "VND"
        },
        "description": ""
    },
    "account": {
        "number": "123456789012",
        "customer_name": "John Doe",
        "bank_code": "Vietinbank"
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 233,
        "type": "sale",
        "status": "success",
        "date": "2020-11-06T13:16:50+0000",
        "created_date": "2020-11-06T13:16:36+0000",
        "request_id": "3fe344d57e581a37b16ddd8e7507a65f5bef7dfaafc-00000001",
        "sum_initial": {
            "amount": 300000,
            "currency": "VND"
        },
        "sum_converted": {
            "amount": 300000,
            "currency": "VND"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 2673,
            "payment_id": "160466859929",
            "auth_code": ""
        }
    },
    "signature": "fF9J+3OdjdGux9liAxvDk5/Fublg9sMqOvypzgcMLZXG09ptOg=="
}

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

Figure 7. Example of data from a declined purchase callback
 {
    "project_id": 1234,
    "payment": {
        "id": "EP9ab9-a3a4",
        "type": "purchase",
        "status": "decline",
        "date": "2020-11-06T13:26:48+0000",
        "method": "VietQR",
        "sum": {
            "amount": 300000,
            "currency": "VND"
        },
        "description": ""
    },
    "account": {
        "number": "123456789012",
        "customer_name": "John Doe",
        "bank_code": "Vietinbank"
    },
    "customer": {
        "id": "customer_456"
    },
    "operation": {
        "id": 236,
        "type": "sale",
        "status": "decline",
        "date": "2020-11-06T13:26:48+0000",
        "created_date": "2020-11-06T13:26:33+0000",
        "request_id": "2e084e9b6736091b032a78b86d6fbc46b18431-00000001",
        "sum_initial": {
            "amount": 300000,
            "currency": "VND"
        },
        "sum_converted": {
            "amount": 300000,
            "currency": "VND"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 2673,
            "payment_id": "160466919625",
            "auth_code": ""
        }
    },
    "signature": "H8F+m5SL3ZxjnzCrsvjPSqQ203NfvL5dXP50qJUXTOqqgKkHZA=="
}

Related topics

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

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

General information

In the VietQR method, when processing a purchase by using Payment Page, the merchant web service sends a request with all the required parameters and signature to the Monetix URL and accepts the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the VietQR method pre-selected. (For more information about pre-selecting payment methods, see Preselecting payment methods.)

The full sequence of the purchase workflow is provided below.

Figure 8. Purchase workflow when using Payment Page
  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for the Payment Page opening to the Monetix URL.
  3. The request for opening Payment Page is redirected to the payment platform.
  4. The payment platform performs the initial request processing that includes validation whether all required parameters are available and signature is correct.
  5. The requested Payment Page is generated by the Monetix payment platform as specified in the project settings and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects VietQR as a payment method.
  8. The payment platform receives the purchase request for the payment processing from Payment Page.
  9. The payment platform performs the internal purchase request processing and forwards it to the provider service.
  10. The provider service processes the purchase request.
  11. The provider service submits the data for displaying the QR code to the payment platform.
  12. The payment platform sends this data to Payment Page.
  13. The QR code is displayed to the customer.
  14. The customer completes the payment by scanning the QR code in the mobile app.
  15. The provider service processes the payment.
  16. The result is displayed to the customer.
  17. The provider service sends the result notification to the payment platform.
  18. The payment platform sends a callback with the payment result to the web service.
  19. The payment platform sends the result to Payment Page.
  20. The page with the payment result information is displayed to the customer on Payment Page.

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

Request format

There are several things you need to consider when dealing with purchase requests in the VietQR 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—project ID you obtained from Monetix
    • payment_id—payment ID unique within the project
    • 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
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—purchase amount in major currency units without any fractional part.

      If the currency does have minor units (that is, the number of digits for minor currency units is not zero), then you must set this parameter to the amount in minor currency units without any decimal point or comma . For the information on whether the currency has any minor units, see Currency codes.

  2. If you need to have payment form displayed with the VietQR method pre-selected, set the force_payment_method parameter to the code on the vietqr payment method.
  3. You can also add any other additional parameters Payment Page supports. For more information about parameters supported by Payment Page, see Payment Page invocation parameters.
  4. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign payment requests, see Signature generation and verification.

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

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

Callback format

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

Callbacks can include additional parameters with information about the customer in the account object:
  • number—customer's account number;
  • customer_name—customer's name;
  • bank_code—customer's bank code.

Please contact your Monetix key account manager to confirm whether this option is available to you.

The following is an example of a callback with an information about a successful 300,000 VND purchase.

Figure 9. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "VietQR",
        "sum": {
            "amount": 300000,
            "currency": "VND"
        },
        "description": ""
    },
    "account": {
        "number": "123456789012",
        "customer_name": "John Doe",
        "bank_code": "Vietinbank"
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 300000,
            "currency": "VND"
        },
        "sum_converted": {
            "amount": 300000,
            "currency": "VND"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 10. Example of data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "VietQR",
        "sum": {
            "amount": 300000,
            "currency": "VND"
        },
        "description": ""
    },
    "account": {
        "number": "123456789012",
        "customer_name": "John Doe",
        "bank_code": "Vietinbank"
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 31,
        "type": "sale",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 300000,
            "currency": "VND"
        },
        "sum_converted": {
            "amount": 300000,
            "currency": "VND"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 15923,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Related topics

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

Purchase by using Gate. Channel 1: customer redirection

General information

In the VietQR method, to perform a purchase by using Gate, 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. Redirect customer to the VietQR 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 11. Purchase by using Gate: steps description
  1. Customer initiates a purchase through VietQR payment method.
  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 processes the payment request and redirects the request to the VietQR service.
  7. The request is processed on the VietQR side.
  8. The VietQR service sends the data for redirecting the customer to the VietQR service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the VietQR service.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the VietQR side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The VietQR service sends the payment result notification to the payment platform.
  16. The payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the VietQR payment method and provide the information about formats of the data for redirecting customers and the information about the format of callbacks with payment results. For the general information about using the Gate API, see API Description.

Request format

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

  1. You perform purchases by sending the request to the /v2/payment/vietqr/sale endpoint by using POST (HTTP) method.
  2. The following objects and parameters must be specified in any request:
    • general—object with general request identification information:
      • project_id—the 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 major currency units without any fractional part.

        If the currency does have minor units (that is, the number of digits for minor currency units is not zero), then you must set this parameter to the amount in minor currency units without any decimal point or comma . 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 add any other additional parameters Gate supports.

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

Figure 12. Example of data from a purchase request
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3oXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "payment": {
        "amount": 300000,
        "currency": "VND"
    },
    "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 provider 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": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback format

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

Callbacks can include additional parameters with information about the customer in the account object:
  • number—customer's account number;
  • customer_name—customer's name;
  • bank_code—customer's bank code.

Please contact your Monetix key account manager to confirm whether this option is available to you.

The following is the example of a callback with an information about successful 300,000 VND purchase made in the 1234 project.

Figure 13. Example of data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "EPd3f4-9b1a",
        "type": "purchase",
        "status": "success",
        "date": "2020-11-06T13:16:50+0000",
        "method": "VietQR",
        "sum": {
            "amount": 300000,
            "currency": "VND"
        },
        "description": ""
    },
    "account": {
        "number": "123456789012",
        "customer_name": "John Doe",
        "bank_code": "Vietinbank"
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 233,
        "type": "sale",
        "status": "success",
        "date": "2020-11-06T13:16:50+0000",
        "created_date": "2020-11-06T13:16:36+0000",
        "request_id": "3fe344d57e581a37b16ddd8e7507a65f5bef7dfaafc-00000001",
        "sum_initial": {
            "amount": 300000,
            "currency": "VND"
        },
        "sum_converted": {
            "amount": 300000,
            "currency": "VND"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 2673,
            "payment_id": "160466859929",
            "auth_code": ""
        }
    },
    "signature": "fF9J+3OdjdGux9liAxvDk5/Fublg9sMqOvypzgcMLZXG09ptOg=="
}

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

Figure 14. Example of data from a declined purchase callback
{
    "project_id": 3514,
    "payment": {
        "id": "EP9ab9-a3a4",
        "type": "purchase",
        "status": "decline",
        "date": "2020-11-06T13:26:48+0000",
        "method": "VietQR",
        "sum": {
            "amount": 300000,
            "currency": "VND"
        },
        "description": ""
    },
    "account": {
        "number": "123456789012",
        "customer_name": "John Doe",
        "bank_code": "Vietinbank"
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 236,
        "type": "sale",
        "status": "decline",
        "date": "2020-11-06T13:26:48+0000",
        "created_date": "2020-11-06T13:26:33+0000",
        "request_id": "2e084e9b6736091b032a78b86d6fbc46b18431-00000001",
        "sum_initial": {
            "amount": 300000,
            "currency": "VND"
        },
        "sum_converted": {
            "amount": 300000,
            "currency": "VND"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 2673,
            "payment_id": "160466919625",
            "auth_code": ""
        }
    },
    "signature": "H8F+m5SL3ZxjnzCrsvjPSqQ203NfvL5dXP50qJUXTOqqgKkHZA=="
}

Related topics

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

Purchase by using Gate. Channel 2: no customer redirection

General information

In the VietQR 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. Show a QR code to the customer.
  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
  1. A customer initiates a purchase with VietQR 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 the initial request processing that includes validation whether all the required parameters are available and signature is correct.
  5. The payment platform sends the response with the 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 and redirects the request to the provider service.
  7. The provider service processes the request.
  8. The provider service submits the data for displaying the QR code to the payment platform.
  9. The payment platform sends the callback containing this data in the display_data object to the web service.
  10. The QR code is displayed to the customer.
  11. The customer completes the payment by scanning the QR code in the mobile app.
  12. The provider service processes the payment.
  13. The result is displayed to the customer.
  14. The provider service sends the payment result notification to the payment platform.
  15. The payment platform sends the callback with the payment result to the web service.
  16. 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 VietQR 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 VietQR method:

  1. You initiate purchase by submitting a purchase request to the /v2/payment/vietqr/sale endpoint by using the HTTP method POST.
  2. The following objects and parameters must be specified in any request:
    • general—object with general request identification information:
      • project_id—the project ID you 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 major currency units without any fractional part.

        If the currency does have minor units (that is, the number of digits for minor currency units is not zero), then you must set this parameter to the amount in minor currency units without any decimal point or comma . 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 add any other additional (optional) parameters Gate supports.

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

Figure 16. Example of the data from a purchase request
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "payment": {
        "amount": 300000,
        "currency": "VND"
    }
}

Format of the data for displaying a QR code to customers

In order to the customer is able to complete the payment, you are required to display the QR code on your web service. The payment platform sends the data for displaying the QR code in the callback inside the data parameter of the display_data array. The data should be displayed to the customer in the QR code. Therefore, before displaying the QR code, you need to accept and process such a callback.

There are two options the way the display_data array is structured. Both of them are described below. Refer to you Key Account Manager at Monetix to find out which one is relevant to you.

Option 1

The only element of the display_data array contains the following parameters:

  • type—element type (always qr_data)
  • title—the name of the data (always QR code)
  • data—the data that should be encoded in the QR code

The following is the callback fragment containing display_data array.

"display_data": [
            {
                "type": "qr_data",
                "title": "QR code",
                "data": "00020101com.359a71a-0cad-4cb2-a937-a3fa5319a5252070503***63042BBF"
            }
        ]

Option 2

Each element of the display_data array contains the following parameters:

  • type—element type, can take the following values:
    • qr_url—element with the link to display the QR code
    • add_info—element with information to display the timer for the QR code
  • title—the name of the data, can take the following values:
    • qr_img—the link to display the QR code
    • QR Code Timeout—QR code expiration time and date in the Unix time format
  • data—the data to display

The following is the callback fragment containing display_data array.

"display_data": [
            {
                "type": "qr_url",
                "title": "qr_img",
                "data": "http://example.com/images/qr-code.png"
            },
            {
                "type": "add_info",
                "title": "QR Code Timeout",
                "data": "1701851362"
            }
        ]

Callback format

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

Callbacks can include additional parameters with information about the customer in the account object:
  • number—customer's account number;
  • customer_name—customer's name;
  • bank_code—customer's bank code.

Please contact your Monetix key account manager to confirm whether this option is available to you.

The following is an example of a callback with the information about a successful 300,000 VND purchase.

Figure 17. Example of the data from a successful purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "VietQR",
        "sum": {
            "amount": 300000,
            "currency": "VND"
        },
        "description": ""
    },
    "account": {
        "number": "123456789012",
        "customer_name": "John Doe",
        "bank_code": "Vietinbank"
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 300000,
            "currency": "VND"
        },
        "sum_converted": {
            "amount": 300000,
            "currency": "VND"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 18. Example of the data from a declined purchase callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "VietQR",
        "sum": {
            "amount": 300000,
            "currency": "VND"
        },
        "description": ""
    },
    "account": {
        "number": "123456789012",
        "customer_name": "John Doe",
        "bank_code": "Vietinbank"
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 31,
        "type": "sale",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 300000,
            "currency": "VND"
        },
        "sum_converted": {
            "amount": 300000,
            "currency": "VND"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 15923,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Related topics

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

Testing

General information

You can perform test purchases with the VietQR payment method by using Payment Page and Gate.

To perform test purchases, you'll need the test project ID and the secret key to it. To get them, please contact the technical support team at support@monetix.pro and then contact your Monetix key account manager to set up a test environment to work with the VietQR payment method.

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 VND
  • 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:

  • 400 and 404—to receive a callback with the decline status
  • any other value—to receive a callback with the success status

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 vietqr value in the request, you won't have to choose the payment method.
  3. Specify a random first name and last name in the data entry fields. The payment instructions will be displayed to you after.
  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 VietQR payment method in the Purchase by using Payment Page 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 payment instructions. Your system will display the payment instructions 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 VietQR payment method in the Purchase by using Gate 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.