Skip to content

Introduction

Pyng provides APIs that enable partners to integrate Pyng payment experiences into their own products and customer journeys.

This documentation is intended for developers, solution architects, and integration teams responsible for building and operating partner integrations with Pyng.

Warning

Code examples in this documentation are automatically generated. They may contain mistakes, omissions, or implementation details that require adjustment for your integration. Always validate examples against the API contract and your own testing before using them in production.

What This Documentation Covers

The current documentation includes:

  • authentication requirements for accessing the Checkout API
  • payment-intent-based checkout flows
  • transaction status retrieval and webhook delivery
  • draft documentation for the proposed Pay with Pyng Checkout Session flow

Integration Model

Pyng integrations are designed around secure server-to-server API calls for session or payment creation, followed by partner-side user experience handling and backend confirmation of final status.

Depending on the integration pattern, Pyng may provide:

  • payment intent creation
  • launch URLs for customer payment flows
  • transaction status polling
  • webhook notifications for completion events

Environments

Use the appropriate Pyng environment for development, testing, and production rollout.

  • Sandbox: https://sample.pyng.com.au
  • Production: https://app.pyng.com.au

Draft Content

Some pages in this documentation are explicitly marked as Draft.

Draft pages describe proposed API contracts and flows that are still under review and may change before public release. They should not be treated as final integration guarantees.

For most integrations, start with:

  1. Checkout API summary
  2. Authentication
  3. Create Payment Intent API
  4. Transaction status polling and webhook delivery

If you are reviewing the proposed Pay with Pyng flow, then continue to the draft Checkout Session pages.

Support

If you have questions about integration, environments, onboarding, or rollout planning, contact support@pyng.com.au.