Help Centre Help Center home page
Community Submit a request
Sign in
  1. Help Centre
  2. API Reference

API Reference

Documentation, Resources, Connecting Apps & Webhooks

Start Here

  • Setup & Authentication
  • Sandbox & Testing
  • Rate Limits & Best Practice
  • Retrieving & Filtering Lists

Core Resources

  • Customers & BPAY Reference
  • Credit Cards (Tokenising & Charging)
  • Capture Cards with PCI Compliant iFrame (Beta)
  • Direct Debit/Recurring Schedules
  • Batch Debiting
  • Payments
See all 7 articles

Enums, Codes & Lookups

  • Error Statuses & Response Codes
  • Payment Types
  • Payment Fail Codes
  • Country ISO & ID's
  • Email Receipts for Payments
  • BSB Lookup

Creating Apps + Connecting using OAuth

  • Registering an App
  • Connecting/Disconnecting to your Pay Advantage App
  • Getting Refresh & Access Tokens
  • Disconnecting

Webhooks (Beta)

  • Webhooks
  • Registering an Endpoint
  • Arming an endpoint
  • Verifying the x-payadvantage-signature
  • Processing Webhooks
  • Webhook APIs
Help Centre