API Reference

Start Here

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

Core Resources

• Customers & BPAY Reference
• Credit Cards (Tokenising & Charging)
• Direct Debit/Recurring Schedules
• Batch Debiting
• Payments
• Refunds

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 the Access and Refresh Tokens
• Disconnecting

Webhooks

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