Build &amp; Customize Your Payments with ZenPay

🔄

Set up recurring billing

Tokenize customer payment methods and schedule automatic debits for subscriptions.

SubscriptionsTokens

👥

Manage customers

Create and update customer profiles, payment methods, and billing details via API.

APIManagement

🪪

Accept PayID & bank transfers

Enable instant PayID payments with program, merchant, or customer-level addresses.

PayIDNPP

↩️

Handle refunds & pre-auth

Issue refunds, capture pre-authorized payments, and manage idempotency safely.

RefundsPre-auth

📊

Process batch payouts

Upload CSV files to pay employees or suppliers in bulk—perfect for payroll and vendors.

BatchB2B

View Full API Reference 🎮 Try Interactive Playground

Quick Start

Get up and running in minutes with our hosted payment modal

JavaScript
cURL
Python

// Initialize the ZenPay hosted payment modal
$.zpPayment({
  apiKey: 'your_api_key',
  fingerprint: generateFingerprint(), // SHA3-512 server-side
  merchantCode: 'MERCHANT123',
  mode: 0, // 0 = payment page, 1 = payment iframe
  amount: 9900, // Amount in cents ($99.00)
  currency: 'AUD',
  description: 'Order #1234',
  reference: 'ORDER-1234',

  // Payment options
  enableApplePay: true,
  enableGooglePay: true,
  enablePayID: true,

  // Callbacks
  redirectUrl: 'https://yoursite.com/payment/success',
  callbackUrl: 'https://yoursite.com/api/payment/callback',

  // Security
  action: 'Authorise', // or 'Charge'
});

curl -X POST https://api.zenithpayments.com.au/v2/payments \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "amount": 9900,
    "currency": "AUD",
    "description": "Order #1234",
    "reference": "ORDER-1234",
    "customer": {
      "email": "customer@example.com",
      "name": "John Smith"
    },
    "payment_method": "card",
    "redirect_url": "https://yoursite.com/success"
  }'

import zenithpay

# Initialize client
client = zenithpay.Client(api_key='YOUR_API_KEY')

# Create payment
payment = client.payments.create(
    amount=9900,  # Amount in cents
    currency='AUD',
    description='Order #1234',
    reference='ORDER-1234',
    customer={
        'email': 'customer@example.com',
        'name': 'John Smith'
    },
    payment_method='card',
    redirect_url='https://yoursite.com/success'
)

print(payment.id)
print(payment.status)

⚠️ Important: Generate the SHA3-512 fingerprint server-side to prevent tampering. Migration from SHA512 is required in v5.

Sandbox Test Data

Use these test cards in your sandbox environment:

Card Number	Type	Result
`4242 4242 4242 4242`	Visa	Success
`5555 5555 5555 4444`	Mastercard	Success
`4000 0000 0000 0002`	Visa	Declined

Test Details:

Expiry: Any future date (e.g., 01/30)
•
CVV: Any 3 digits (e.g., 123)
•
Sample PayID: test@payme.io

Integration Pathways

Choose the integration method that best fits your use case

Recommended

🖥️

Hosted Payment Page

Zero PCI scope integration with modal or redirect options.

✓No PCI compliance required
✓Support for cards, PayID, Apple Pay, Google Pay
✓Customizable branding
✓Mobile-responsive design

⚡

Merchant & Customer APIs

Full control with RESTful APIs for payments and management.

✓One-off and pre-auth payments
✓Batch payments & refunds
✓Token management & subscriptions
✓Customer portal endpoints

Popular

🪪

PayID & Bank Transfers

Instant NPP payments with program, merchant, or customer PayIDs.

✓Real-time settlement
✓Lower fees than cards
✓Secure BSB/account lookup
✓Automated reconciliation

📊

Batch & B2B Solutions

Process bulk payouts and request-to-pay jobs.

✓CSV upload for bulk payments
✓Payroll and supplier payouts
✓Request-to-pay workflows
✓Comprehensive reporting

Popular Integration Flows

Step-by-step guides for common payment scenarios

Hosted Modal Checkout

Easy⏱ 15 min

Accept payments with minimal code using our pre-built payment modal.

Add jQuery plugin to your page
Configure payment options
Handle success callback

Tokenize & Recurring Payments

Medium⏱ 30 min

Save customer payment methods and charge them automatically.

Create customer via API
Tokenize payment method
Schedule recurring charges

Pre-authorize & Capture

Medium⏱ 25 min

Reserve funds now, capture later—perfect for bookings and reservations.

Create pre-auth payment
Verify customer fulfillment
Capture or void authorization

PayID with Reconciliation

Medium⏱ 45 min

Accept instant bank transfers and automatically reconcile payments.

Enable PayID for your program
Configure webhook endpoint
Match payments to invoices

Batch Payouts to Suppliers

Easy⏱ 20 min

Pay multiple recipients in one batch upload.

Prepare CSV with payout details
Upload via dashboard or API
Monitor batch processing

Self-Service Customer Portal

Advanced⏱ 2 hours

Build a portal where customers manage their payments and invoices.

Authenticate customer sessions
Use Customer API endpoints
Display invoices and payment history