Docs Guides Developer API

API Overview

Overview
Response Objects
Purchases
Tokenized Cards
Refunds
Direct Debits
Direct Credits
Batches
Customers
Bank Accounts
Applicable Surcharges
- Overview
- Get applicable surcharge
Webhooks
Direct Post
Payment Plans
Settlement
- Overview
- Fetch settlement totals
Invoices
OAuth Clients
- Overview
- Create an oAuth client
Reports
Disputes
Health Check
- Overview
- Health check

Digital Wallet Registration

Overview
Register an Apple Pay on the Web Domain
List Apple Pay domains
Check an Apple Pay on the Web Domain
Remove an Apple Pay on the Web Domain

Hosted Payment Pages

v2 overview
v3 overview
Persisted invoices
Xero integration
Click to Pay

Health

Overview
Auth + partner resolution canary

Partner

Overview
Show the authenticated partner (self)
Rotate the partner's own API token

Merchants

Overview
List merchants
Create merchant
Show merchant
Update merchant
Replace merchant
Activate merchant
Suspend merchant
Rotate merchant Credentials

Acquirer Connections

Overview
List a merchant's acquirer connections
Board a merchant onto an acquirer (synchronous)
Show an acquirer connection
Update acquirer connection
Enable acquirer connection
Disable acquirer connection

Acquirers

Overview
List Acquirers
Show Acquirer

SSO

Overview
Show SSO
Enforce SSO
Disable SSO

Users

Overview
List Users
Create User
Show User
Update User
Delete User
Deactivate User
Reactivate User

API Reference

Health Check

This endpoint lets merchants quickly determine if the FZ gateway is operational.