Shopee

Introduction

Shopee is a payment method which allows you to process payments in Malaysian ringgits by using e-wallets in Malaysia. This method supports purchases.

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

General information

Interaction diagram

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

Operations support

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

The following properties and limitations apply to the Shopee method.

* For information about the threshold time, refer to your account manager.

Processing scenarios

To perform a purchase by using the Shopee method, you need to redirect the customer to the provider service.

The customer payment scenario via Payment Page looks like this.

General scenarios of processing purchases and payouts can be presented as follows.

Scenarios for performing operations via the main interfaces of the payment platform correspond to those presented in the diagrams. Similarly, when additional features (such as payment links) are used, scenarios for performing operations also correspond to the specifics of those features.

General information

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

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

Request format

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

1. The following parameters required for any payment must be specified:
   • project_id—project identifier obtained from ecommpay during integration
   • payment_id—payment identifier unique within the project
   • payment_currency—payment currency code in the ISO-4217 alpha-3 format
   • payment_amount—payment amount in the smallest currency unit
   • customer_id—customer identifier unique within the project

   Depending on the payment processing provider, other parameters may be required in the purchase requests.

2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.

   Depending on the payment processing provider, other parameters may be required in the purchase requests.

3. Additionally, it is recommended to specify the parameter customer_phone. If this parameter is missing, the payment form may display an input field for entering the missing value (details are available in Submission of additional payment information).
4. If you need to have the payment form displayed with the Shopee method selected, set the force_payment_method parameter to shopee.
5. Additionally, any other parameters available for working with Payment Page can be used (details).
6. After all target parameters are specified, generate a signature (details).

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

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "MYR",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "MYR",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

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

The following is the example of a callback with information about a 100.00 MYR purchase made in the 1234 project.

{
    "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": "9e32835fb27907e0336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 10000,
            "currency": "MYR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "MYR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 0000,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdMtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is the example of a callback with information about 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": 0000,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoMz2iFYv58P4VnHANu45/jmY+g=="
}

Useful links

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

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

General information

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

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

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

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

Request format

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

1. To initiate each purchase, send a separate POST request to the /v2/payment/wallet/shopee/sale endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/sale.
2. Each request must include the following objects and parameters:
   • Object general—general purchase information:
     • project_id—project identifier obtained from ecommpay during integration
     • payment_id—payment identifier unique within the project
     • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
   • Object payment—payment information:
     • amount—payment amount in the smallest currency unit
     • currency—payment currency code in the ISO-4217 alpha-3 format
   • Object customer—customer information:
     • id—customer identifier unique within the project
     • ip_address—customer IP address relevant for the initiated payment
   • Object return_url—contains the URLs to which customer is redirected while or after payment processing:
     • success—URL to return customer to the web service after a successful payment.

   Depending on the payment processing provider, other parameters may be required in the purchase requests.

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

Thus, a correct purchase request by using the Shopee method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and IP address and the signature.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 10000,
    "currency": "MYR"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0"
  }
  "return_url": {
    "success": "http://example.com/success"
  }
}

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 10000,
    "currency": "MYR"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0"
  }
  "return_url": {
    "success": "http://example.com/success"
  }
}

Formats of intermediate callbacks for customer redirection

Each payment made with the Shopee method requires redirection of customers from the merchant's web service to the provider service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

• body—object with data to be sent in the request body
• method—parameter specifying the HTTP method for sending the request (GET or POST)
• url—parameter containing a link for redirection

  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

Final callback format

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

The following is the example of a callback with information about a 100.00 MYR purchase made in the 1234 project.

{
    "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": "9e32835fb27907e0b0856e33117242b5cf60e17839",
        "sum_initial": {
            "amount": 10000,
            "currency": "MYR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "MYR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 0000,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is the example of a callback with information about 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": 0000,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCR4m8Cz2iFYv58P4VnHANu445/jmY+g=="
}

Useful links

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

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