ShopeePay via HitPay

ShopeePay via HitPay redirects the customer to a HitPay hosted checkout page where the customer can scan the presented QR code to proceed with payment.

One off payment	Refunds	Recurring	Cancel
✓	✓	x	x

ShopeePay via HitPay supports full refunds only. Partial refunds are not supported.Merchants using HitPay’s Admin Fees functionality for this payment method cannot initiate refunds via Primer for ShopeePay.

Get started with ShopeePay via HitPay

Before you begin

If this is your first payment method, make sure to follow the Get started guide to begin processing payments with Primer.

Configure in the Dashboard

Add ShopeePay via HitPay payment method to your Dashboard Go to the integrations section of the Dashboard, click on the ‘New Integration’ button and search for HitPay. Follow the instructions to connect your ShopeePay via HitPay account to your Primer Dashboard.
Activate ShopeePay via HitPay on the Checkout Go to the Checkout section of the Dashboard and activate the ShopeePay via HitPay payment method.
Configure a Workflow to process payments made with ShopeePay via HitPay Go to Workflows, and ensure there is a workflow with the Authorization action configured to process APMs.

Prepare the client session

HitPay leverages the following parameters to process a payment. Pass them when creating the client session.

Parameter Name	Required	Description
orderId	✓	A unique identifier for the order. Maximum 255 characters.
currencyCode	✓	The three-letter currency code in ISO 4217 format. e.g. use `USD` for US dollars.

Prepare the SDK for payments

Web
iOS
Android

Use the payment method type HITPAY_SHOPEEPAY wherever the code below references YOUR_PAYMENT_METHOD_TYPE.

Primer Checkout (recommended)
Universal Checkout (legacy)
Headless Universal Checkout (legacy)

Primer Checkout is our latest web SDK, built around declarative web components. Once ShopeePay via HitPay is enabled in your Dashboard, the default <primer-checkout> layout renders it automatically alongside your other methods — no payment-method-specific markup is required.

<primer-checkout client-token="your-client-token"></primer-checkout>

Custom layouts

Only reach for primer-payment-method if you’re building a custom layout and need to place ShopeePay via HitPay at a specific position. The element only renders when the type is enabled in your Dashboard and returned by the server for this checkout.

<primer-checkout client-token="your-client-token">
  <primer-main slot="main">
    <div slot="payments">
      <primer-payment-method type="YOUR_PAYMENT_METHOD_TYPE"></primer-payment-method>
    </div>
  </primer-main>
</primer-checkout>

For dynamic rendering based on what the server returns, listen to primer:methods-update or use primer-payment-method-container for declarative filtering.

Set up redirects

If ShopeePay via HitPay can’t be shown in a popup, Universal Checkout redirects the customer back to your site using the returnUrl passed in the redirect options. See Handle redirects & deep links for the full flow.

const options = {
  container: "#checkout-container",
  redirect: {
    returnUrl: "https://mystore.com/checkout",
  },
  onCheckoutComplete({ payment }) {
    console.log("Checkout complete.", payment);
  },
};

Show Universal Checkout

ShopeePay via HitPay is automatically presented when calling Primer.showUniversalCheckout.

import { Primer } from "@primer-io/checkout-web";

try {
  await Primer.showUniversalCheckout(clientToken, options);
} catch (e) {
  // handle error
}

Check the customization guide to learn how to customize payment method buttons.

Create a RedirectPaymentMethodManager for ShopeePay via HitPay using createPaymentMethodManager, then call start() to begin the redirect flow.

const manager = await headless.createPaymentMethodManager("YOUR_PAYMENT_METHOD_TYPE");

if (manager) {
  manager.addEventListener("click", () => {
    // Optional: run custom logic before the redirect flow starts.
  });

  await manager.start();
}

Refer to the full guide for handling payment methods with redirect.

Use the payment method type HITPAY_SHOPEEPAY wherever the code below references YOUR_PAYMENT_METHOD_TYPE.

Set up redirects

Redirect-based payment methods present a webpage or open a third-party app for the customer to authorize the payment. To return to your app once the customer has authorized the payment, include the urlScheme parameter when configuring PrimerPaymentMethodOptions.

let settings = PrimerSettings(
  // ...
  paymentMethodOptions: PrimerPaymentMethodOptions(
    urlScheme: "your-url-scheme://" // e.g. primer://, yourscheme://
  )
  // ...
)

When the customer is redirected back to your app, iOS calls application(_:continue:restorationHandler:). Forward the call to the Primer SDK so the checkout can continue the flow.

import PrimerSDK
import UIKit

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
  // ...
  func application(
    _ application: UIApplication,
    continue userActivity: NSUserActivity,
    restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void
  ) -> Bool {
    return Primer.shared.application(
      application,
      continue: userActivity,
      restorationHandler: restorationHandler
    )
  }
}

Show the payment method

Universal Checkout (drop-in)
Headless Universal Checkout

ShopeePay via HitPay is automatically presented when calling Primer.shared.showUniversalCheckout.

class MyViewController: UIViewController {
  func startUniversalCheckout() {
    Primer.shared.showUniversalCheckout(clientToken: self.clientToken)
  }
}

Check the customization guide to learn how to customize payment method buttons.

ShopeePay via HitPay requires a Native UI Manager to be presented to the customer.

// 👇 Create the payment method manager
let nativeUIPaymentMethodManager = try PrimerHeadlessUniversalCheckout.NativeUIManager(
  paymentMethodType: "YOUR_PAYMENT_METHOD_TYPE"
)

// 👇 Show the payment method
try nativeUIPaymentMethodManager.showPaymentMethod(intent: .checkout)

See NativeUIManager.init for the full API. As many redirect-based payment methods share this approach, we recommend centralizing the implementation — see the worked example in the Native UI Manager guide.

Use the payment method type HITPAY_SHOPEEPAY wherever the code below references YOUR_PAYMENT_METHOD_TYPE.

Universal Checkout (drop-in)
Headless Universal Checkout

ShopeePay via HitPay is automatically presented when calling Primer.instance.showUniversalCheckout.

class CheckoutActivity : AppCompatActivity() {
  private fun setupObservers() {
    viewModel.clientToken.observe(this) { clientToken ->
      showUniversalCheckout(clientToken)
    }
  }

  private fun showUniversalCheckout(clientToken: String) {
    Primer.instance.showUniversalCheckout(this, clientToken)
  }
}

Check the customization guide to learn how to customize payment method buttons.

ShopeePay via HitPay requires a Native UI Manager to be presented to the customer.

// 👇 Create the payment method manager
val nativeUiManager = PrimerHeadlessUniversalCheckoutNativeUiManager.newInstance("YOUR_PAYMENT_METHOD_TYPE")

// 👇 Show the payment method
nativeUiManager.showPaymentMethod(this, PrimerSessionIntent.CHECKOUT)

See NativeUiManager.newInstance for the full API. As many redirect-based payment methods share this approach, we recommend centralizing the implementation — see the worked example in the Native UI Manager guide.

Go live

You don’t need to do anything particular to go live — just make sure to use production credentials.

​Get started with ShopeePay via HitPay

​Before you begin

​Configure in the Dashboard

​Prepare the client session

​Prepare the SDK for payments

​Custom layouts

Set up redirects

Show Universal Checkout

​Set up redirects

​Show the payment method

​Go live

Get started with ShopeePay via HitPay

Before you begin

Configure in the Dashboard

Prepare the client session

Prepare the SDK for payments

Custom layouts

Set up redirects

Show the payment method

Go live