Shopee

Interaction diagram

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

Operations support

	Interfaces			Amounts		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases				10,000.00 IDR or 5.00 MYR	20,000,000.00 IDR or 4999.00 MYR	3 minutes	*
Payouts				10,000.00 IDR	20,000,000.00 IDR	2-3 minutes	24 hours

* Refer to your Monetix Key Account Manager to learn the threshold time.

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 the Shopee payment method 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 Shopee mobile app

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

To perform a payout:

1. Receive a request from the customer via your web service.
2. Send the request to the payment platform.
3. Notify the customer about the operation outcome.

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

General information

In the Shopee 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 Shopee method pre-selected. (For more information about pre-selecting payment methods, see in Preselecting payment methods.)

The full sequence of the purchase workflow is provided below.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Shopee payment method and provide the information about 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 Shopee 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—unique ID of the customer within your project
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • customer_email—customer email
   • payment_currency—payment currency in ISO-4217 alpha-3 format
   • payment_amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. 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.
2. It is recommended to specify the phone number of the customer in the customer_phone parameter. If the parameter is missing from the request, Payment Page will contain an additional field for the customer to enter the missing information. For more information about additional information submission, see Submission of additional payment information.
3. If you need to have payment form displayed with the Shopee method pre-selected, set the force_payment_method parameter to the code on the shopee payment method.
4. 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.
5. 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 data from a request for Payment Page opening:

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

Callback format

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

The following is an example of a callback with an information about successful 100.00 MYR purchase.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "shopee",
        "sum": {
            "amount": 10000,
            "currency": "MYR"
        },
        "description": ""
    },
    "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": 10000,
            "currency": "MYR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "MYR"
        },
        "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.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "shopee",
        "sum": {
            "amount": 10000,
            "currency": "MYR"
        },
        "description": ""
    },
    "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": 10000,
            "currency": "MYR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "MYR"
        },
        "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:

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

General information

In the Shopee 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 Shopee 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.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Shopee payment method and provide 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 Shopee 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—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. 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.
2. It is recommended to specify the phone number of the customer in the customer_account_number parameter. If the parameter is missing from the request, Payment Page will contain an additional field for the customer to enter the missing information. For more information about additional information submission, see Submission of additional payment information.
3. If you need to have the payment form displayed with the Shopee method pre-selected, set the force_payment_method parameter to the code on the shopee payment method.
4. 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.
5. After you specify all the parameters you need, you must create the signature for the request. For the instructions on how to sign payment requests, see Signature generation and verification.

Here is an example of the data from a request for the 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',
        customer_account_number: '123456789012', 
        payment_currency: 'IDR',
        payment_amount: 1000000,    
        signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Callback format

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

The following is an example of a callback with information about a successful 10,000.00 IDR purchase.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "shopee",
        "sum": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "description": ""
    },
    "account": {
        "number": "123456"
    },
    "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": 1000000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "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.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "shopee",
        "sum": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "description": ""
    },
    "account": {
        "number": "123456"
    },
    "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": 1000000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "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:

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

General information

In the Shopee 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 provider 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.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Shopee 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 Shopee method:

1. You initiate purchase by submitting a purchase request to the /v2/payment/wallet/shopee/sale endpoint by using HTTP method POST. This endpoint belongs to the following group of endpoints for payments by using e-wallets: /v2/payment/wallet/{payment_method}/sale
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—customer device IP
     • 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 except for cases where the currency does not have any minor currency units. 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 add any other additional (optional) parameters Gate supports.

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

{
    "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": 10000,
        "currency": "MYR"
    },
    "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 Shopee method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Gate.

The following is an example of a callback with an information about successful 100.00 MYR purchase.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "shopee",
        "sum": {
            "amount": 10000,
            "currency": "MYR"
        },
        "description": ""
    },
    "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": 10000,
            "currency": "MYR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "MYR"
        },
        "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.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "shopee",
        "sum": {
            "amount": 10000,
            "currency": "MYR"
        },
        "description": ""
    },
    "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": 10000,
            "currency": "MYR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "MYR"
        },
        "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:

• Synchronous and asynchronous message processing
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

General information

In the Shopee 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.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Shopee payment method and provide 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 Shopee method:

1. You initiate a purchase by submitting a purchase request to the /v2/payment/wallet/shopee/sale endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints for the payments by using e-wallets: /v2/payment/wallet/{payment_method}/sale.
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
   • account—object with customer account information:
     • number—customer e-wallet number
   • payment—object with purchase information:
     • amount—purchase amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. 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. It is recommended to specify the phone number of the customer in the phone parameter of the customer object. If you do not submit this parameter in the initial request, the payment platform will request this parameters by sending to the web service a callback with a list of the parameters web service is required to submit. (For more information about this procedure, see Submission of additional payment information.)
4. 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 Shopee method.

{
    "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",
        "phone": "491234567890"
    },
    "account":{
        "number": "12345678901"
    },
    "payment": {
        "amount": 1000000,
        "currency": "IDR"
    }
}

Format of the data for displaying 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 QR code data is sent in the callback from the payment platform in 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.

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

• type—element type, can take the following values:
  • qr_data—information needed for displaying the QR code
  • add_info—additional information for displaying to the customer
• title—the name of the data, can take the following values:
  • qr_code_data—data used for displaying the QR code
  • expired_timestamp—QR code lifetime (in seconds)
• data—the data used for displaying to the customer

Here is an example of the callback fragment containing the 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 format

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

The following is an example of a callback with information about a successful 10,000.00 IDR purchase.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "shopee",
        "sum": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "description": ""
    },
    "account": {
        "number": "123456"
    },
    "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": 1000000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "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.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "shopee",
        "sum": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "description": ""
    },
    "account": {
        "number": "123456"
    },
    "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": 1000000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "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:

• Synchronous and asynchronous message processing
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

General information

To perform a payout with the Shopee method, the merchant's web service sends a request with all the required parameters and signature to the Monetix URL, and receives a callback with the payment result.

The complete sequence of the payout process is provided below.

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

Request format

There are several things you must consider when using payout requests in the Shopee method:

1. You initiate a payout by sending a payout request to the /v2/payment/wallet/shopee/payout endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints for the payouts by using e-wallets : /v2/payment/wallet/{payment_method}/payout.
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
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
   • account—object with customer account information:
     • number—customer e-wallet number
   • payment—object with payout information:
     • amount—payout amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. 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 payout 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 payout request in the Shopee method.

{
    "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"
    },
    "account": {
        "number": "1234567890123456"
    },
    "payment": {
        "amount": 1000000,
        "currency": "IDR"
    }
}

Callback format

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

The following is the example of a callback with information about a successful 10,000.00 IDR payout.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_48",
        "type": "payout",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "shopee",
        "sum": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "description": ""
    },
    "operation": {
        "id": 29,
        "type": "payout",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

{
    "project_id": 1234,
    "payment": {
        "id": "payment_48",
        "type": "payout",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "shopee",
        "sum": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "description": ""
    },
    "operation": {
        "id": 29,
        "type": "payout",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "sum_converted": {
            "amount": 1000000,
            "currency": "IDR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlf155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Related topics

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

• Synchronous and asynchronous message processing
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

• single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
• as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

General information

You can perform test purchases with the Shopee 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 Shopee 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 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:

• 40000 and 40400—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 shopee 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 Shopee 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 Shopee payment method in the Purchase by using Gate section.

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.