This page is a ZenPay-styled copy of the Zenith Payments developer documentation. View the original docs
Merchant APIs
ZenPay v2 REST Payment API. Supports:
- Payments
- Preauths
- Refunds
- CreditRequests
- BatchPayments
- Customers
- CardProxies
- Proxies
- RequestPays
- Sessions
- Diagnostics
Download the OpenAPI spec (openapi-v2.json)
Servers#
Merchant APIs — choose an environment prefix and brand domain
https://{subdomain}.{baseDomain}
| Variable | Default | Values | Description |
|---|---|---|---|
baseDomain | travelpay.com.au | travelpay.com.au, b2bpay.com.au, childcareeasypay.com.au, schooleasypay.com.au, rentalrewards.com.au, zenpay.com.au, thoroughbredpayments.com.au | Brand domain |
subdomain | api.sandbox | api, apiuat, api.sandbox | Environment prefix |
Authentication#
- API Key:
Api-Key - HTTP: Basic Auth
Api-Key
Merchant's API key. Required together with Merchant's username and password
| Security scheme type | apiKey |
|---|---|
| Header parameter name | Api-Key |
BasicAuth
Merchant's username and password. Required together with the Api-Key header
| Security scheme type | http |
|---|---|
| HTTP authorization scheme | basic |
Endpoints#
Batch Payments#
A batch payment is a collection of payment entries submitted together for processing. Each entry settles asynchronously against a registered customer.
- POSTCreate a batch payment
/v2/batchpayments - GETGet a batch payment
/v2/batchpayments/{batchPaymentId} - GETList batch payment entries
/v2/batchpayments/{batchPaymentId}/entries
Card Proxies#
A card proxy is a secure tokenized reference to a credit or debit card. Card proxies allow PCI-compliant payment processing without handling raw card numbers.
- POSTCreate a card proxy
/v2/cardproxies - DELETEDelete a card proxy
/v2/cardproxies/{cardProxy} - GETGet a card proxy
/v2/cardproxies/{cardProxy} - GETGet card proxy pricing
/v2/cardproxies/{cardProxy}/pricing
Credit Requests#
A credit request is a disbursement of funds to a customer bank account. Credits are submitted with a customer reference, amount, and destination account proxy.
- POSTCreate a credit request
/v2/credit-requests - GETGet a credit request
/v2/credit-requests/{requestUniqueId}
Customers#
A customer represents a payer enrolled with a merchant. Each customer holds a profile, payment account details, payment options, and subscription status.
- GETList customers
/v2/customers - POSTCreate a customer
/v2/customers - GETGet a customer
/v2/customers/{customerReference} - GETGet a customer account
/v2/customers/{customerReference}/account - PUTUpdate a customer account
/v2/customers/{customerReference}/account - PUTUpdate a customer reference
/v2/customers/{customerReference}/customerReference - GETGet a customer payment option
/v2/customers/{customerReference}/paymentOption - PUTUpdate a customer payment option
/v2/customers/{customerReference}/paymentOption - GETGet a customer profile
/v2/customers/{customerReference}/profile - PUTUpdate a customer profile
/v2/customers/{customerReference}/profile - GETGet customer status
/v2/customers/{customerReference}/status - PUTUpdate customer status
/v2/customers/{customerReference}/status
Diagnostics#
API health and connectivity endpoints for verifying the service is operational.
- GETPing the API
/v2/diagnostics/ping
Payments#
A payment is a one-off charge against a customer's card or bank account. Payments support card proxies, customer references, refunds, and 3D Secure authentication.
- GETList payments
/v2/payments - POSTCreate a payment
/v2/payments - GETGet a payment by merchant unique ID
/v2/payments/uniqueId/{merchantUniqueId} - GETGet a refund request
/v2/payments/uniqueId/{paymentReference}/refundrequests/{refundRequestUniqueId} - GETGet a payment
/v2/payments/{paymentReference} - GETList refund requests
/v2/payments/{paymentReference}/refundrequests - POSTCreate a refund request
/v2/payments/{paymentReference}/refundrequests
Preauths#
A preauthorization places a hold on a customer's card for a specified amount. Preauthorizations can later be captured (converted to a payment) or voided (released).
- GETList preauthorizations
/v2/preauths - POSTCreate a preauthorization
/v2/preauths - GETGet a preauthorization by reference
/v2/preauths/{preauthReference} - POSTCapture a preauthorization
/v2/preauths/{preauthReference}/captures - PUTVoid a preauthorization
/v2/preauths/{preauthReference}/voids
Proxies#
A proxy is a reference to a stored payment account (card, bank account, PayID, or PayTo). Proxies can be queried for details and applicable transaction pricing.
- GETGet a proxy
/v2/proxies/{proxy} - GETGet proxy pricing
/v2/proxies/{proxy}/pricing
Request Pays#
A request-to-pay sends a payment request to a customer via email or SMS. Customers receive a link to complete payment through the hosted payment page.
- POSTCreate a request pay
/v2/requestpays - GETGet a request pay
/v2/requestpays/{requestPayId} - GETList request pay entries
/v2/requestpays/{requestPayId}/entries
Sessions#
A session is a secure, time-limited token used to initialize the hosted payment plugin. Sessions configure payment methods, amounts, customization, and callback URLs.
- POSTCreate a session
/v2/sessions
Contact#
ZenPay Integrations Team: integrations@zenithpayments.com.au