Shopee - Scenario 2. Purchase with a QR code

When performing a purchase, the customer scans the QR code displayed on the checkout page or in your system (when performing the purchase by using Gate).


Countries and regions	Indonesia, Malaysia
Payment currencies	IDR, MYR
Payment amount limits	Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time	Contact your key account manager at Monetix for details.
Currency conversion	On the Monetix side
Refund
Onboarding and access fee	Contact your key account manager at Monetix for details.
Special considerations The payment will be declined if the customer doesn't complete the purchase within 20 minutes. To extend or reduce the wait time, contact the Monetix technical support (support@monetix.pro).

Operations support


	Interfaces
	Payment Page	Gate	Dashboard
Purchase

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 then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the Shopee payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Accept the callback with the purchase result from the payment platform.

The following figure shows the complete purchase processing flow in the Shopee payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page

The customer initiates a purchase in your system.
Your system sends the request for the purchase through Payment Page to the Monetix URL.
The checkout page is displayed to the customer.
The customer chooses to make a purchase with the Shopee payment method.
The payment platform processes the request and forwards it to the provider service.
The provider service generates and sends the payment QR code data to the payment platform.
The checkout page displays the QR code to the customer.
The customer completes the purchase.
The customer is redirected back to the checkout page.
The provider service sends the purchase result information to the payment platform.
The payment platform sends a callback with the payment result to your system.
The payment platform displays the payment result to the customer on the checkout page.

Request

The following table lists the parameters that you need to include in the request for purchase through the checkout page with the Shopee payment method.

strictly required—the parameter must be in the initial request.

required—the parameter is required for purchase processing but using it in the initial request is optional. If you don't specify this parameter in your request, the checkout page will contain an additional field for the customer to enter the missing information. For more information on how to act in such cases, see Submission of additional payment information.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

Parameter Description

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_first_name
string
strictly required

Customer's first name.

Example: John

customer_last_name
string
strictly required

Customer's last name.

Example: Doe

customer_email
string
strictly required

Customer's email.

Example: johndoe@example.com

customer_account_number
string
required

Customer phone number.

Example: 491234567890

payment_currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: MYR

payment_amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 MYR must be sent as 10000

force_payment_method
string
optional

Parameter that allows you to enforce the Shopee payment method for your customer and skip the page with payment method selections.

To enforce the Shopee payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to shopee. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'shopee'

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Payment Page invocation parameters.

Here is an example of the data from a request to open the checkout page by using EPayWidget:

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',
		customer_account_number: '491234567890',
		payment_currency: 'MYR',
		payment_amount: 10000,
		force_payment_method: 'shopee',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Callback

In the Shopee payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.

The following is an example of a callback body with information about a successfully completed purchase.

Figure 2. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "shopee",
        "sum": {
            "amount": 10000,
            "currency": "MYR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "MYR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "MYR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "12345678901"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 3. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "shopee",
        "sum": {
            "amount": 10000,
            "currency": "MYR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "MYR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "MYR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "12345678901"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Testing

You can test payments with the Shopee payment method by using Payment Page.

To start performing test payments, reach out to the Monetix (support@monetix.pro) support team to get the test project ID and a secret key to it and then contact your key account manager at Monetix to set up the test environment for the payments to be performed with the Shopee payment method.

When performing test payments, keep in mind that:

for the project ID you have to submit the ID of the test project
for the payment ID and customer's data you can submit any random values
for the currency of the payment you should submit IDR
the interface of the test checkout page may be different from the one Monetix provides you with.

Statuses of test payments

To receive a certain final status when performing test payments with the Shopee payment method, your request has to contain a respective payment amount in it. The table below lists the payment amounts you can send in requests in order to get a certain status of a test payment.


Payment amount	Final status
40000 or 40400	decline—the payment is declined
Any other amount	success—the payment is successful. The payment amount passed to you in a callback matches the amount you submitted in the purchase request

Testing purchase by using Payment Page

To perform a test purchase by using Payment Page:

Send a request for opening the checkout page to the payment platform.
Choose the Shopee payment method on the test checkout page. If your request contains the force_payment_method parameter with the shopee value in it, there's no need to choose the payment method.
If necessary, specify any random values for the parameters you're requested to provide.
Wait for the QR code to be displayed to you.
Accept a callback containing the data about the result of performing a test payment.
Wait for a few seconds until the test checkout page displays the result of performing a test payment.

To learn more about performing purchases with the Shopee payment method by using Payment Page, see the Purchase by using Payment Page section.

Purchase by using Gate

General information

To perform a purchase by using Gate with the Shopee payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Show the screen with a payment QR code to the customer.
Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the Shopee payment method.

Figure 4. Purchase processing flow when performing a purchase by using Gate

The customer initiates a purchase in your system.
Your system sends the purchase request to the Monetix payment platform.
The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
The payment platform processes the request and forwards it to the provider service.
The provider service generates and sends the payment QR code data to the payment platform.
The payment platform sends the data to your system in the display_data array.
Your system displays the QR code to the customer.
The customer completes the purchase.
The customer is redirected to your system.
The provider service informs the payment platform about the purchase result.
The payment platform sends the callback with the payment result to your system.
Your system sends the payment result to the customer.

Request

This section provides the instructions on how to build the request for purchase with the Shopee payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/payment/wallet/shopee/sale`
Full API endpoint specification	/v2/payment/wallet/{payment_method}/sale

strictly required—the parameter must be in the initial request.

required—the parameter is required for purchase processing but using it in the initial request is optional. If you omit this parameter from the request, the payment platform will request the parameter by sending your system a callback with the list of all the missing parameters you are required to submit. For more information on how to act in such cases, see Submission of additional payment information.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

phone
string
required

Customer phone number.

Example: 491234567890

account
object
strictly required

number
string
strictly required

Customer e-wallet number.

Example: 12345678901

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: MYR

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

Example: 100.00 MYR must be sent as 10000

You can also add any other optional parameters to the purchase request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a purchase with the Shopee payment method:

Figure 5. Example of the purchase request body

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com",
        "phone": "491234567890"
    },
    "account": {
        "number": "12345678901"
    },
    "payment": {
        "currency": "MYR",
        "amount": 10000
    }
}

Displaying the payment QR code to the customer

After receiving and processing your purchase request, the payment platform sends you the callback with the data for displaying the payment QR code to the customer.

Use the data from the display_data array to display the QR code to the customer.

Table 3. Description of the display_data array
Element	Description
{ "type": "qr_data", "title": "qr_code_data", "data": "00020101com.359a71a-0cad-4cb2-a937-a3fa5319a5252070503***63042BBF" }	Data used for displaying the QR code. Example: `00020101com.359a71a-0cad-4cb2-a937-a3fa5319a5252070503***63042BBF`
{ "type": "add_info", "title": "expired_timestamp", "data": "1666858081" }	QR code lifetime (in seconds). Example: `1666858081`

The following is the callback fragment containing display_data array.

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

Callback

In the Shopee payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed purchase.

Figure 6. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "shopee",
        "sum": {
            "amount": 10000,
            "currency": "MYR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "MYR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "MYR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "12345678901"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 7. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "shopee",
        "sum": {
            "amount": 10000,
            "currency": "MYR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "MYR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "MYR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "12345678901"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Testing

You can test payments with the Shopee payment method by using Gate.

When performing test payments, keep in mind that:

for the project ID you have to submit the ID of the test project
for the currency of the payment you should submit IDR
for the payment ID and customer's data you can submit any random values

Statuses of test payments


Payment amount	Final status
40000 or 40400	decline—the payment is declined
Any other amount	success—the payment is successful. The payment amount passed to you in a callback matches the amount you submitted in the purchase request

Testing purchase by using Gate

To perform a test purchase by using Gate:

Send a correct test request for purchase to the payment platform.
Accept a callback with the data for displaying QR code. Your system will display the QR code to you after.
Accept a callback containing the data about the result of performing a test payment.

To learn more about performing purchases with the Shopee payment method by using Gate, see the Purchase by using Gate section.

Shopee - Scenario 2. Purchase with a QR code

Operations support

Purchase by using Payment Page

General information

Request

Callback

Testing

Related topics

Purchase by using Gate

General information

Request

Displaying the payment QR code to the customer

Callback

Testing

Related topics