Create public payment requests and saved-card payment attempts.
Create a payment request
Creates a third-party payment request. Coax will either charge an eligible saved card or send the customer an SMS payment link, then emit configured payment callbacks when the request payment is confirmed. To receive payment_confirmed callbacks, email [email protected] with your callback URL, business name, target environment, and any location-specific requirements. Callback URLs are configured by Coax and are not supplied in this API request.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Create a payment request › Request Body
invoice_numberThird-party order reference.
Payment request line items. The total amount must be at least 1.00 AUD.
business_location_idmessagechannelinclude_gstpass_transaction_feeuse_saved_cardCreate a payment request › Responses
Payment request sent, charged, or already paid.
Check customer saved-card status
Checks whether an existing customer has a saved card that can be charged for the requested business location. This endpoint does not create customers and does not expose Stripe payment method IDs.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Check customer saved-card status › Request Body
business_location_idRequired when the Zuplo/Coax API key is scoped to all locations. Optional when the key itself is scoped to one location.
Check customer saved-card status › Responses
Saved-card status for the matching existing customer.