API Reference

Getting Started

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

Customers & Payments

• Customers & BPAY Reference
• Payments
• Refunds

Credit/Debit Cards

• Charge or Tokenise a Credit Card
• Capture Cards with PCI Security Compliant iFrame
• Calculating Card Fees for on-charging
• Card Authorisations / Payment Hold

Subscriptions / Recurring Payments

• Recurring Payments/Subscriptions/Direct Debit
• Bank Account Debits using Batch Debiting

Payment Request Links

• Payment Request Links

Enums, Codes & Lookups

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

Webhooks

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

Creating Apps + Connecting using OAuth

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

Merchant Onboarding/Activation

• Merchant Onboarding/Activations (Beta)