Skip to content

Checkout API

The Pyng Checkout API is designed to provide a reliable platform for online and retail financial transactions.

The API offers two products:

  • POS Checkout — the partner displays a QR code and the customer pays by scanning it with the Pyng app. Suited to in-person and on-screen retail.
  • Online Checkout (Pay with Pyng) — the partner creates a Checkout Session and opens a Pyng-hosted page. Pyng manages the customer journey through Hosted Checkout, including agreement handling, payment, and return to the partner.

Authentication, errors, URLs, transport, and data handling are shared by both products.

POS Checkout

The partner presents a QR code to the customer and later checks or receives the final transaction status.

sequenceDiagram
    autonumber
    participant P as Partner
    participant C as Customer
    participant A as Pyng App
    participant API as Pyng Checkout API

    P->>API: Create payment intent
    API-->>P: Payment intent + QR payload
    P-->>C: Display QR code
    C->>A: Scan QR code
    A->>API: Validate and process payment
    A-->>C: Show payment result
    P->>API: Pull transaction status or receive webhook
    API-->>P: Final transaction status

Endpoints: Create Payment Intent, Pull Transaction Status, Push Transaction Status, Sandbox Transaction Simulation.

Online Checkout (Pay with Pyng)

The partner creates a Checkout Session and opens a Pyng Launch URL. Pyng then manages the customer journey through Hosted Checkout, including agreement handling, payment, and return to the partner.

sequenceDiagram
    autonumber
    participant P as Partner Backend
    participant W as Partner Website
    participant C as Customer
    participant H as Pyng Hosted Checkout
    participant B as Customer Bank App
    participant API as Pyng Checkout API

    P->>API: Create Checkout Session
    API-->>P: checkoutSessionId + launchUrl
    P-->>W: launchUrl
    C->>W: Click "Pay with Pyng"
    W->>H: Open launchUrl

    alt Agreement is already active
        H->>API: Start payment
        API-->>H: Payment completed
    else Agreement must be created or approved
        H-->>C: Show agreement instructions
        C->>B: Approve agreement in bank app
        H->>API: Poll agreement status
        API-->>H: Agreement active
        H->>API: Start payment
        API-->>H: Payment completed
    end

    H-->>C: Show result
    H-->>W: Return to partner
    P->>API: Poll session status
    API-->>P: Final checkout status

Endpoints: Create Checkout Session, Get Checkout Session Status.

URLs

Sandbox - https://sample.pyng.com.au

Production - https://app.pyng.com.au

Transport

All Checkout API endpoints require TLS 1.3 or higher over HTTPS. Plain-HTTP requests are rejected at the load balancer.

Data handling

Both products are account-to-account: payments are initiated against the customer's Pyng account and authorised by the customer in their bank app or by scanning a QR code with the Pyng app. Partners never receive or transmit card numbers, bank account credentials, or PIN/CVV. The partner stores only the identifiers returned by the Checkout API (paymentIntentId, checkoutSessionId, orderId) for reconciliation.