Account Linking

ShopeePay offers the following functionalities for account linking and payment use cases:

• Initiate an Account Linking & Get Account Token
  • Request for Account Unlinking
• Use Cases for Account Linking
  • Create Payment Order: Link & Pay
  • Create Payment Order: Subscription
  • Create Payment Order: Auth&Capture
  • Get User Information

Merchant Workflow

To accept the payment in this scenario, the merchant needs to complete the following steps

1. Initiate Get Auth Code when customer chooses to link their ShopeePay account.
2. Bring the user to SPP's frontend to complete the authorization
3. Get access token by using returned partnerReferenceNo, and save token for future use cases (e.g. to obtain user information).
4. Initiate a payment request (via Link & Pay, Subscription, and Authorization & Capture) when customer selects to pay or when payment is due.

1. After customer chooses to link their ShopeePay account on merchant's application or website, the merchant calls the Get Auth Code endpoint to start the linking process.
2. ShopeePay returns an authCode which should be appended to the provided static URL, allowing merchants to direct users to ShopeePay's linking agreement page.
3. The customer agrees to link their account to the merchant.
4. Upon successful linking, the customer returns back to the merchant's page as indicated in the redirectUrl in the Account Linking request, along with an authCode, partnerReferenceNo.
5. Merchant can reply on the authCode or partnerReferenceNo passed by its frontend, to call the /registration-account binding endpoint
6. Once the merchant obtains the account token, they should save it securely for future use.
7. Should the customer choose to unlink ShopeePay in the future, the merchant should call the Account Unlink endpoint to invalidate the access token. Once the unlink request is successful, the merchant will not be able to get information or charge the customer's ShopeePay account.

Initiate Account Linking

• Use this endpoint to initiate the account linking process of a ShopeePay account to your platform.
• All API requests require a header. Refer to API Param Specification → Transaction Request

Specification

The following table is specification of this API:

Request Parameters

Sample API Request

The following script is a sample to generate seamlessData and seamlessSign:

1. Generate seamlessData

seamlessData = URLEncode(message)


message = {"mobileNumber":"123456789"}
seamlessData = %7B%22mobileNumber%22%3A%22123456789%22%7D

2. Sign seamlessData using algorithm SHA256withRSA and your own private key.

rawSign = SHA256withRSA(seamlessData, privateKey)

3. Generate the seamlessSign by applying base64 encoding and URL encoding

seamlessSign = URLEncode(Base64Encode(rawSign))

Response Parameter

Response Code

Please refer to the following description for a general explanation of the responseCode returned during an API Response.

For a more detailed explanation, it is advisable to consult responseMessage. This field provides additional information that can offer valuable insights for troubleshooting.

Merchants may choose to display the responseMessage to their operators or staffs to facilitate prompt identification and resolution of the issue.

Get Account Token

• Use this endpoint to initiate the account linking process of a ShopeePay account to your platform.
• All API requests require a header. Refer to API Param Specification → Transaction Request

Specification

The following table is a specification of this API:

Request Parameters

Response Parameter

Response Code

Please refer to the following description for a general explanation of the responseCode returned during an API Response.

For a more detailed explanation, it is advisable to consult responseMessage. This field provides additional information that can offer valuable insights for troubleshooting.

Merchants may choose to display the responseMessage to their operators or staffs to facilitate prompt identification and resolution of the issue.

Request for Account Unlinking

• Use this endpoint to unlink a ShopeePay account from a Customer's account on your platform.
• All API requests require a header. Refer to API Param Specification → Transaction Request

Specification

The following table is a specification of this API:

Request Parameter

Response Parameter

Response Codes

Please refer to the following description for a general explanation of the responseCode returned during an API Response.

For a more detailed explanation, it is advisable to consult responseMessage. This field provides additional information that can offer valuable insights for troubleshooting.

Merchants may choose to display the responseMessage to their operators or staffs to facilitate prompt identification and resolution of the issue.

Get User Info

• Use this endpoint to get customer's ShopeePay account information for display purposes.
• All API requests require a header. Refer to API Param Specification → Transaction Request

Specification

The following table is a specification of this API:

Request Parameter

Response Parameter

Response Codes

Please refer to the following description for a general explanation of the responseCode returned during an API Response.

For a more detailed explanation, it is advisable to consult responseMessage. This field provides additional information that can offer valuable insights for troubleshooting.

Merchants may choose to display the responseMessage to their operators or staffs to facilitate prompt identification and resolution of the issue.