Core objects and relationships

The API is organised around a small set of objects. Understanding how they relate makes every endpoint predictable.

Object	What it represents	Key endpoints
`Customer`	A person or business that pays you. Owns saved cards and a default card.	Create,Retrieve,Update,Delete
`Card`	A payment method saved against a customer. One card is the default used by intents and subscriptions.	List,Set default,Remove
`Payment Intent`	An attempt to collect an amount from a customer for a job. Supports hold-and-capture.	Create,Confirm,Capture
`Payment Link`	A hosted payment page for a one-off amount (AUD only). Produces an intent when paid.	Generate,Status
`Refund`	Money returned to a customer against a payment intent.	Create,Status
`Worker`	A gig worker (talent) you pay. Owns bank details and maps your platform ID to an Airwallex account.	Create,Retrieve,Update,Bank details
`Payout`	A bank transfer to a worker (or one-off talent). Tracked by transferId.	Payout,Status,Talent payout
`Invoice / Receipt`	PDF documents generated and emailed for payments and payouts.	Create invoice,Receipts
`Subscription`	A recurring charge against a customer’s default card.	Create,Pause,Cancel

Money flows in from Customers (intents, links, subscriptions) and out to Workers (payouts). Webhooks report movement on both sides.

Last modified on November 10, 2026