Link & Pay

Merchant Workflow

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

1. Optionally, before initiating a payment, the merchant can call the two endpoints below based on the use cases
   • Get User Information: ShopeePay will inform the merchant of the customer’s current wallet balance, KYC status etc, should the merchant require any such checks beforehand.
   • Get Coin Redemption: ShopeePay will inform the merchant of the customer’s Shopee Coin redemption rules and Coin amount, should the merchant wish to display this information.
2. Merchant calls Create Payment Order: Link & Pay endpoint to create payment for the customer. ShopeePay will return a redirect_url for the merchant to allow the user to enter.
3. Customer selects a payment method and confirms payment.
4. ShopeePay processes the payment and returns the customer back to the merchant’s page.
5. ShopeePay will sends an asynchronous message via Notify Transaction Status endpoint to inform merchants on the payment result.
6. Merchants can also call the Check Transaction Status endpoint to query the status of the transaction.
   • If the response code is "Success", merchant can mark this transaction as successful.
   • If the response code is "Failed", merchant can mark this transaction as failed.
   • If the transaction is in a processing status, please retry the request at an incremental time range of every 5 seconds (e.g., 5 seconds, 10 seconds, 15 seconds, and so on) up to a maximum of 100 seconds. If there is no response after 100 seconds, please retry the request at an incremental time range of every 5 minutes up to 24 hours.
   • If the transaction has no response, please retry the request at an incremental time range of every 5 seconds (e.g., 5 seconds, 10 seconds, 15 seconds, and so on) up to a maximum of 100 seconds. If there is no response after 100 seconds, please retry the request at an incremental time range of every 5 minutes up to 24 hours.
   • If customer can show evidence of payment success on their payment app, merchant may choose to consider payment as successful and wait for reconciliation process on T+1 to settle discrepancies with ShopeePay, if any.

Create Payment Order: Link & Pay

Use this endpoint to create a payment with an access token and a hosted-checkout page

• URL: "/v3/merchant-host/transaction/payment/direct"

Request Parameters

Sample API Request

REQUEST

{
        "request_id": "input-unique-request-id-here",
        "payment_reference_id":"ref-must-be-unique",
        "merchant_ext_id": "external-merchant",
        "store_ext_id":"external-store",
        "access_token": "uXjWuhPGepSOtntoC8kTK5er6DlbUiGeSJDt53",
        "amount":  1000000,
        "currency": "IDR",
        "use_coin": true,
        "return_url": "https://isv-domain.com",
        "expiry_time": 1716193900
}

Copy

Response Parameters

Sample API Response

RESPONSE

{
        "request_id": "input-unique-request-id-here",
        "errcode": 0,
        "debug_msg": "success",
        "redirect_url": "https://uat.shopee.id/s/browser/payment/auth/passcode-verify?mode=fullscreen&next=https%3A%2F%2Fuat.shopee.vn%2Fs%2Fbrowser%2Fpayment%2Fauth%2FtokenizedPaymentResult%3Freturn_url%3Dhttps%253A%252F%252Fgoogle.com%26ticket%3DbxfWQkI0VfGzlj7ANMudkMYO9RvkO1PM&return_url=https%3A%2F%2Fuat.shopee.vn%2Fs%2Fbrowser%2Fpayment%2Fauth%2FtokenizedPaymentResult%3Fresult%3D201%26return_url%3Dhttps%253A%252F%252Fgoogle.com%26ticket%3DbxfWQkI0VfGzlj7ANMudkMYO9RvkO1PM&scenario=7cdccb66-cd7a-448f-a01f-b2ddd8970e53&source=TokenizedPayment&ticket=bxfWQkI0VfGzlj7ANMudkMYO9RvkO1PM"
}

Copy

Response Code