Skip to main content

Web Integration Overview

The PayUp Web Integration API powers the hosted checkout experience and the browser SDK. Use this guide to understand the sequence of calls and where to find schema-level details.

Flow Summary​

  1. Initialize the SDK
    Call POST /web/payment/tokenize from your storefront with the tk_ client token and the browser's origin. A scoped SDK token is returned for subsequent requests.

  2. Verify the customer
    Complete the verification journey (/verification/* endpoints) to obtain a verification JWT (type=payment_verification).

  3. Create the session
    Submit the cart and customer context to POST /web/payment/create-session with the verification JWT. PayUp responds with the hosted checkout URL and session metadata.

  4. Redirect the shopper
    Send customers to the returned redirectUrl. Monitor status through webhooks or poll GET /web/payment/session/{sessionId} using your API key.

Reference​

  • Payment API – the public payment surface: auth, tokenize, checkout sessions, verification, and payments.
  • Merchant API – the merchant dashboard admin endpoints.

When you extend the integration (for example, to support additional payment methods), update the schema in openapi/payup-public.yml and re-run npm run build to regenerate the reference.