Jump to Content
Home
Guides
Recipes
API Reference
Changelog
Discussions
v3.0
Guides
API Reference
Guides
Moon (Dark Mode)
Sun (Light Mode)
v3.0
Home
Guides
Recipes
API Reference
Changelog
Discussions
Retrieve a Webhook Endpoint
Search
JUMP TO
PayAdvantage Website
payadvantage.com.au
test.payadvantage.com.au
Quick Start
Getting Started with Pay Advantage API
PayAdvantage Web API
Authentication
Create a new Authentication
post
Delete a Authentication
delete
Delete a BSB Authentication
delete
Create a new B2B Authentication
post
Calculate Fee
Calculate Fee with Amount
get
Credit Card Charge
Retrieves a Credit Card Charge by code
get
Retrieves a Credit Card Charge By external id
get
Credit Card IFrame
Create a new Credit Card IFrame
post
Create a new Payment IFrame
post
Customer Payment Account
Retrieves Customer Payment Accounts
get
Create a new Customer Payment Account
post
Retrieve a Customer Payment Account
get
Delete a Customer Payment Account
delete
Modify a Customer Payment Account
patch
Create a new Customer Payment Account Link
post
Customer
Retrieve Customers
get
Create a new Customer
post
Generate customer BPAY code
post
Debit Batch
Retrieve Debit Batches
get
Create a new Debit Batch
post
Retrieve a Debit Batch
get
Update a Debit Batch
put
Delete a Debit Batch
delete
Modify a Debit Batch
patch
Authorise a debit batch
put
Debit Instruction
Retrieve all debit instructions
get
Create a new Debit Instruction
post
Retrieve a Debit Instruction by code
get
Retrieve all Debit Instructions in a debit batch
get
Delete a Debit Instruction
delete
Acknowledge a failure in the batch
put
Acknowledge a failure in the batch
post
Acknowledge a failure in the batch
patch
Direct Debit
Retrieve Direct Debits
get
Create a new Direct Debit
post
Retrieve a Direct Debit
get
Delete a Direct Debit
delete
Modify a Direct Debit
patch
Health Check
Determines if the system is currently online.
get
Merchant Activation
Retrieve Merchant Activations
get
Create a new Merchant Activation
post
Retrieve a Merchant Activation
get
Delete a Merchant Activation
delete
PayId
Retrieve PayIds
get
Create a new PayId
post
Retrieve a PayId
get
Payment Request
Retrieve Payment Requests
get
Create a new Payment Request
post
Retrieve a Payment Request
get
Delete a Payment Request
delete
Modify a Payment Request
patch
Payment
Retrieve Payments
get
Retrieve a Payment
get
Retrieves payments settling on the specified date.
get
Retrieves payments failed on the specified date.
get
QR Code
Retrieve a QR Code
get
QR Code with Logo
Retrieve a QR Code with Logo
get
Refund
Retrieve Refunds
get
Create a new Refund
post
Webhook Endpoint
Retrieve Webhook Endpoints
get
Create a new Webhook Endpoint
post
Retrieve a Webhook Endpoint
get
Delete a Webhook Endpoint
delete
Modify a Webhook Endpoint
patch
Webhook
Retrieve Webhooks
get
PaymentAuthorizationFees
Calculates the fees for a payment.
post
Payment Authorizations
Get Payment Authorizations
get
Create a Payment Authorization or a Single PayTo Agreement
post
Get a Payment Authorization
get
Capture a Payment Authorization
patch
Void a Payment Authorization or Single PayTo Agreement
delete
Retrieve a Webhook Endpoint
get
https://api.test.payadvantage.com.au/v3/webhook_endpoints/
{code}
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
