Launch the Checkout

To launch the checkout, follow these steps:

1. From your server, call the Create Checkout Session API to create a checkout session.

   • When calling the Create Checkout Session API, don’t pass the redirectUrl parameter, as the SDK already handles the redirect automatically using the configuration file.
   • Call the API from your server to ensure session integrity and security. Never invoke this endpoint from your client-side Unity Project.

2. After receiving the API response on your server, extract the values from the session object:

   {
       "checkoutSessionToken": "session_token_identifier",
       "purchaseId": "pr_purchase_id",
       "url": "https://checkout-v2-sandbox.appcharge.com",
       "parsedUrl": "https://checkout-v2-sandbox.appcharge.com/session_token_identifier#boot=checkout_boot_data"
   }
   

   Parameter	Description
   checkoutSessionToken	A unique token to identify and validate the checkout session.
   purchaseId	ID to track the purchase.
   url	The base URL of the Appcharge checkout page.
   parsedUrl	The Parsed URL of the Appcharge checkout page.

3. Use the values returned in the checkout session response to open the checkout on the client. Depending on your integration version, use one of the following methods:
   
   

   Recommended integration

   Use the following values from the session response:

   C#

   PaymentLinksController.Instance.OpenCheckout(
       purchaseId: "PURCHASE_ID",
       parsedUrl: "PARSED_URL"
   )
   
   Legacy integration (deprecated)

   This method is deprecated and should not be used for new implementations.

   Use the following values from the session response:

   C#

   PaymentLinksController.Instance.OpenCheckout(
       sessionToken: "CHECKOUT_SESSION_TOKEN", 
       purchaseId: "PURCHASE_ID",
       url: "URL" 
   )
   
   The session response values must be passed exactly as received. Modifying them may result in the checkout failing to load.

4. Control whether the Android foreground Checkout Service is enabled (optional):

   
   

   The foreground service is enabled by default and helps keep your app prioritized while checkout is open, reducing the risk of Android closing or deprioritizing it during payment and network operations.

   You can enable or disable the service during runtime using:

   C#

   PaymentLinksController.Instance.SetConfiguration("setCheckoutServiceMode", true);  // Enable
   PaymentLinksController.Instance.SetConfiguration("setCheckoutServiceMode", false); // Disable
   
   The foreground service runs only if the required manifest permissions and service declaration are properly configured. If you don’t want to use the foreground service, remove CheckoutService declaration from your manifest file and disable it during runtime using the method above. The foreground permissions can remain, as they may be used by other services in your app.

5. You can also override in run-time how the checkout page is opened (optional):

   • External browser
     Open the checkout in the device’s default browser. This flow will redirect the player back to the app.

     C#

     // Unity Android
     PaymentLinksController.Instance.SetConfiguration("browserMode", AndroidBrowserMode.External)
     
     // Unity iOS
     PaymentLinksController.Instance.SetConfiguration("browserMode", iOSBrowserMode.External);
     
     Running the checkout in an external browser may cause inconsistent behavior across devices, incomplete transactions, or app unexpected lifecycle behavior.

   • Non-external browser (default)
     Open the checkout in a non-external browser. This flow will use the URL scheme provided in the configuration file to return back to the app.
     
     

     For Android, choose whether the Checkout opens in a Trusted Web Activity (TWA), or in a Custom Chrome Tab (CCT). For iOS, the checkout opens via SFSafariViewController. For more information regarding iOS, see Sell Outside IAP.

     C#

     // Unity Android with an internal custom Chrome tab
     PaymentLinksController.Instance.SetConfiguration("browserMode", AndroidBrowserMode.CCT)
     
     // Unity Android with an internal Trusted Web Activity
     PaymentLinksController.Instance.SetConfiguration("browserMode", AndroidBrowserMode.TWA)
     
     // Unity iOS
     PaymentLinksController.Instance.SetConfiguration("browserMode", iOSBrowserMode.SFSVC);
     

6. For Unity iOS only, you can force the Checkout page to display in portrait orientation, even if the app is currently in landscape mode (optional):

   C#

   PaymentLinksController.Instance.SetConfiguration("portraitOrientationLock", "true")