# Zenith Payments Developer Documentation > Payment solutions for every industry ## 1.129 - [Release 1.129](/release-notes/1.129.md): ZenPay Release 1.129 ## 1.130 - [Release 1.130](/release-notes/1.130.md): ZenPay Release 1.130 ## Archive - [Archive](/release-notes/archive.md): Archive ## Get Started - [Choose Your Integration](/docs/get-started/choose-your-integration.md): ZenPay supports multiple integration paths depending on how much control you need and how much implementation work you want to do. - [Integration Checklist](/docs/get-started/integration-checklist.md): Pre-integration and post-integration checklist ## Integration Guides - [Batch Payments](/docs/integration-guides/batch-payments.md): Processing multiple payments in a single submission - [Best Practices](/docs/integration-guides/best-practices.md): General best practices for integrating with Zenith Payments across all integration paths - [Common Payment Flows](/docs/integration-guides/common-flows.md): Documentation of common payment processing flows - [Pre-Authorisation Guide](/docs/integration-guides/pre-auth.md): Guide to pre-authorisation payment flows - [Payment Reconciliation](/docs/integration-guides/reconciliation.md): Approaches for reconciling Zenith payments against your own systems - [Recurring Payments](/docs/integration-guides/recurring.md): Charging stored tokens on a schedule for subscription and recurring billing - [TravelPay B2B Guide](/docs/integration-guides/travelpayb2b.md): This can be a complex integration to build due to the need to send a customer in and out of our portal. Please contact us prior to building any TravelPay B2B integrations. ## Integration Options - [Integration Options](/docs/integration-options.md): ZenPay offers three integration paths. Choose based on how your customers reach checkout and how much control you want. - [Hosted Checkout](/docs/integration-options/hosted-checkout.md): Hosted Checkout is ZenPay's integrated checkout solution. Your frontend initialises the JavaScript Plugin (zpPayment(...)) using values prepared by your backend, then launches the ZenPay-hosted payment experience either in a modal iframe or via full-page redirect. - [Best Practices / Hardening Your Integration](/docs/integration-options/hosted-checkout/best-practices.md) - [Building the Payload](/docs/integration-options/hosted-checkout/building-payload.md): --- - [Callbacks and Handling the Customer's Return](/docs/integration-options/hosted-checkout/callbacks.md): --- - [Configuring Payment Types](/docs/integration-options/hosted-checkout/configuring-payment-types.md) - [Full Worked Example](/docs/integration-options/hosted-checkout/full-worked-example.md) - [Hosted Checkout Pathway](/docs/integration-options/hosted-checkout/hosted-checkout-pathway.md): --- - [Input and Output Parameters](/docs/integration-options/hosted-checkout/input-output-parameters.md): --- - [Plugin Errors and Troubleshooting](/docs/integration-options/hosted-checkout/plugin-troubleshooting.md): --- - [Payment Links](/docs/integration-options/payment-links.md): Payment Links let merchants accept payments using a ZenPay-hosted payment link without building a custom checkout integration. - [FAQ](/docs/integration-options/payment-links/faq.md): This page answers common merchant questions about Payment Links. - [Notifications](/docs/integration-options/payment-links/notifications.md): What this page covers - [Setup & Branding](/docs/integration-options/payment-links/setup-and-branding.md): This page explains the merchant logo setup and what the customer sees on a Payment Link. - [URL Parameters](/docs/integration-options/payment-links/url-parameters.md): Prefill Payment Link fields via URL query string for per-customer links without a backend - [REST API](/docs/integration-options/rest-api.md): Overview of the Zenith Payments Merchant API and when to use it. - [API Integration Guide](/docs/integration-options/rest-api/api-guide.md): Whilst we do have an API to collect and tokenise card details, this requires PCI DSS certification. Please utilise our Payment Plugin to collect payment details for tokenisation. Contact us for more information if you do have PCI DSS certification. - [Authentication](/docs/integration-options/rest-api/authentication.md): Authentication model and credential handling for the Zenith Payments Merchant API. - [Zenith Customer Entity Guide](/docs/integration-options/rest-api/cml-guide.md) - [Common API Patterns](/docs/integration-options/rest-api/common-api-patterns.md): Practical design patterns for building against the Zenith Payments Merchant API. - [Errors](/docs/integration-options/rest-api/errors.md): How Zenith Payments REST API reports errors and how to handle them. - [Create a batch payment](/docs/integration-options/rest-api/openapi/v2/batch-payments-create.md): Creates a batch payment from the supplied request payload. - [Get a batch payment](/docs/integration-options/rest-api/openapi/v2/batch-payments-get.md): Returns the batch payment for the specified batch payment ID. - [List batch payment entries](/docs/integration-options/rest-api/openapi/v2/batch-payments-list-entries.md): Returns the entries for the specified batch payment. - [Create a card proxy](/docs/integration-options/rest-api/openapi/v2/card-proxies-create.md): Creates a card proxy from the supplied card details. Not recommended for software or sites that are not PCI DSS compliant. For an easy and secure card tokenisation and payment option, see the Payment Plugin. - [Delete a card proxy](/docs/integration-options/rest-api/openapi/v2/card-proxies-delete.md): Deletes the specified card proxy without affecting customers already registered with it. - [Get a card proxy](/docs/integration-options/rest-api/openapi/v2/card-proxies-get.md): Returns the card proxy for the specified card proxy value. - [Get card proxy pricing](/docs/integration-options/rest-api/openapi/v2/card-proxies-get-pricing.md): Returns pricing for the specified card proxy and payment amount. - [Create a credit request](/docs/integration-options/rest-api/openapi/v2/credit-requests-create.md): Creates a credit request from the supplied request payload. - [Get a credit request](/docs/integration-options/rest-api/openapi/v2/credit-requests-get.md): Returns the credit request for the specified request unique ID. - [Create a customer](/docs/integration-options/rest-api/openapi/v2/customers-create.md): Creates a customer from the supplied request payload. - [Get a customer](/docs/integration-options/rest-api/openapi/v2/customers-get.md): Returns the customer for the specified customer reference. - [Get a customer account](/docs/integration-options/rest-api/openapi/v2/customers-get-account.md): Returns the account details for the specified customer. - [Get a customer payment option](/docs/integration-options/rest-api/openapi/v2/customers-get-payment-option.md): Returns the payment option for the specified customer. - [Get a customer profile](/docs/integration-options/rest-api/openapi/v2/customers-get-profile.md): Returns the profile for the specified customer. - [Get customer status](/docs/integration-options/rest-api/openapi/v2/customers-get-status.md): Returns the status for the specified customer. - [List customers](/docs/integration-options/rest-api/openapi/v2/customers-list.md): Returns customers that match the supplied filter criteria. - [Update a customer account](/docs/integration-options/rest-api/openapi/v2/customers-update-account.md): Updates the account details for the specified customer. - [Update a customer payment option](/docs/integration-options/rest-api/openapi/v2/customers-update-payment-option.md): Updates the payment option for the specified customer. - [Update a customer profile](/docs/integration-options/rest-api/openapi/v2/customers-update-profile.md): Updates the profile for the specified customer. - [Update a customer reference](/docs/integration-options/rest-api/openapi/v2/customers-update-reference.md): Updates the customer reference for the specified customer. - [Update customer status](/docs/integration-options/rest-api/openapi/v2/customers-update-status.md): Updates the status for the specified customer. - [Ping the API](/docs/integration-options/rest-api/openapi/v2/diagnostics-ping.md): Returns the server date time and version information. - [Merchant APIs](/docs/integration-options/rest-api/openapi/v2/merchant-apis.md): ZenPay v2 REST Payment API. Supports: - [Create a payment](/docs/integration-options/rest-api/openapi/v2/payments-create.md): Creates a payment from the supplied request payload. - [Create a refund request](/docs/integration-options/rest-api/openapi/v2/payments-create-refund-request.md): Creates a refund request for the specified payment. - [Get a payment](/docs/integration-options/rest-api/openapi/v2/payments-get.md): Returns the payment for the specified payment reference. - [Get a payment by merchant unique ID](/docs/integration-options/rest-api/openapi/v2/payments-get-by-unique-id.md): Returns the payment for the specified merchant unique ID. - [Get a refund request](/docs/integration-options/rest-api/openapi/v2/payments-get-refund-request-by-unique-id.md): Returns the refund request for the specified payment and refund request unique ID. - [List payments](/docs/integration-options/rest-api/openapi/v2/payments-list.md): Returns payments that match the supplied filter criteria. - [List refund requests](/docs/integration-options/rest-api/openapi/v2/payments-list-refund-requests.md): Returns the refund requests for the specified payment. - [Create a preauthorization](/docs/integration-options/rest-api/openapi/v2/preauths-create.md): Creates a preauthorization from the supplied request payload. - [Capture a preauthorization](/docs/integration-options/rest-api/openapi/v2/preauths-create-capture.md): Captures the specified preauthorization. - [Get a preauthorization by reference](/docs/integration-options/rest-api/openapi/v2/preauths-get.md): Returns preauthorization details for the specified preauthorization reference. - [List preauthorizations](/docs/integration-options/rest-api/openapi/v2/preauths-list.md): Returns preauthorizations that match the supplied filter criteria. - [Void a preauthorization](/docs/integration-options/rest-api/openapi/v2/preauths-update-void.md): Voids the specified preauthorization. - [Get a proxy](/docs/integration-options/rest-api/openapi/v2/proxies-get.md): Returns the payment account proxy for the specified proxy value. - [Get proxy pricing](/docs/integration-options/rest-api/openapi/v2/proxies-get-pricing.md): Returns pricing for the specified proxy and payment amount. - [Create a request pay](/docs/integration-options/rest-api/openapi/v2/request-pays-create.md): Creates a request pay from the supplied request payload. - [Get a request pay](/docs/integration-options/rest-api/openapi/v2/request-pays-get.md): Returns the request pay for the specified request pay ID. - [List request pay entries](/docs/integration-options/rest-api/openapi/v2/request-pays-list-entries.md): Returns the entries for the specified request pay. - [3D Secure Browser Data](/docs/integration-options/rest-api/openapi/v2/schemas/3-d-secure-browser-data.md): Cardholder browser data collected for 3D Secure authentication. - [3D Secure Data](/docs/integration-options/rest-api/openapi/v2/schemas/3-d-secure-data.md): 3D Secure authentication configuration including browser data, callback URL, and redirect URL. - [Additional Reference](/docs/integration-options/rest-api/openapi/v2/schemas/additional-reference.md): Additional customer reference entry containing a full name and customer reference. - [Ambiguous Result](/docs/integration-options/rest-api/openapi/v2/schemas/ambiguous-result.md): Response returned when a duplicate is detected (HTTP 300). Indicates the resource already exists. - [Bank Account Details](/docs/integration-options/rest-api/openapi/v2/schemas/bank-account-details.md): Bank account details including BSB, account number, and account name. - [Batch Payment Entry](/docs/integration-options/rest-api/openapi/v2/schemas/batch-payment-entry.md): Individual entry within a batch payment including amount, status, and reference. - [Batch Payment Entry Record](/docs/integration-options/rest-api/openapi/v2/schemas/batch-payment-entry-record.md): Individual batch payment entry submitted by the client. Supports JSON or XML format. - [Batch Payment Request](/docs/integration-options/rest-api/openapi/v2/schemas/batch-payment-request.md): Container for batch payment entries. Root element containing a collection of BatchPaymentEntry. - [Batch Payment Response](/docs/integration-options/rest-api/openapi/v2/schemas/batch-payment-response.md): Batch payment response returned after submission. - [Batch Payment Summary](/docs/integration-options/rest-api/openapi/v2/schemas/batch-payment-summary.md): Batch payment summary including status, totals, and processing details. - [BPAY Detail](/docs/integration-options/rest-api/openapi/v2/schemas/bpay-detail.md): BPAY details including biller code and biller reference. - [Card Proxy Token Response](/docs/integration-options/rest-api/openapi/v2/schemas/card-proxy-token-response.md): Card proxy token response including card proxy value, obfuscated card number, expiry, card type, and status. - [Card Tokenization Request](/docs/integration-options/rest-api/openapi/v2/schemas/card-tokenization-request.md): Credit or debit card details for card proxy creation. - [Card Tokenization Response](/docs/integration-options/rest-api/openapi/v2/schemas/card-tokenization-response.md): Card authorisation response returned after card proxy creation. - [Credit Card](/docs/integration-options/rest-api/openapi/v2/schemas/credit-card.md): Credit card details including card number, type, expiry, and label. - [Credit Card Proxy](/docs/integration-options/rest-api/openapi/v2/schemas/credit-card-proxy.md): Credit card proxy reference with optional label. - [Credit Disbursement Request](/docs/integration-options/rest-api/openapi/v2/schemas/credit-disbursement-request.md): Credit request details including customer reference, amount, payment account proxy, and reason. - [Credit Request Response](/docs/integration-options/rest-api/openapi/v2/schemas/credit-request-response.md): Credit request details including status, credit reference, amount, and merchant information. - [Customer Account Response](/docs/integration-options/rest-api/openapi/v2/schemas/customer-account-response.md): Customer payment account including bank account and credit card details. - [Customer Address](/docs/integration-options/rest-api/openapi/v2/schemas/customer-address.md): Customer address including address lines, suburb, state, postcode, and country. - [Customer Creation Response](/docs/integration-options/rest-api/openapi/v2/schemas/customer-creation-response.md): Customer creation response including assigned references and payment option details. - [Customer Details Response](/docs/integration-options/rest-api/openapi/v2/schemas/customer-details-response.md): Customer details including profile, payment account, payment option, and merchant information. - [Customer Payment Account Update](/docs/integration-options/rest-api/openapi/v2/schemas/customer-payment-account-update.md): Customer payment account update. Accepts PaymentAccountProxy, CreditCardProxy, or BankAccount. Priority order: PaymentAccountProxy, BankAccount, CreditCardProxy. Preferred option is PaymentAccountProxy. - [Customer Payment Option](/docs/integration-options/rest-api/openapi/v2/schemas/customer-payment-option.md): Customer payment option including payment type, amount, frequency, schedule, and notification method. - [Customer Profile](/docs/integration-options/rest-api/openapi/v2/schemas/customer-profile.md): Customer profile including personal details, contact information, address, and account dates. - [Customer Profile Details](/docs/integration-options/rest-api/openapi/v2/schemas/customer-profile-details.md): Customer profile details returned for a customer profile query. - [Customer Profile Request](/docs/integration-options/rest-api/openapi/v2/schemas/customer-profile-request.md): Customer profile details for creating or updating a customer profile. - [Customer Status Update Request](/docs/integration-options/rest-api/openapi/v2/schemas/customer-status-update-request.md): Customer status update request including close/open flag and reason. - [Hosted Payment Methods](/docs/integration-options/rest-api/openapi/v2/schemas/hosted-payment-methods.md): Payment methods enabled for the payment plugin session. - [Hosted Payment Page Customization](/docs/integration-options/rest-api/openapi/v2/schemas/hosted-payment-page-customization.md): Visual customization options for the payment plugin. - [Hosted Payment Session Request](/docs/integration-options/rest-api/openapi/v2/schemas/hosted-payment-session-request.md): Session creation request including payment mode, version, and customization options. - [Hosted Payment Session Response](/docs/integration-options/rest-api/openapi/v2/schemas/hosted-payment-session-response.md): Session response containing the secure token, expiry, and payment plugin endpoint URL. - [Internal Server Error](/docs/integration-options/rest-api/openapi/v2/schemas/internal-server-error.md): Response returned when an internal server error occurs (HTTP 500). - [New Customer Request](/docs/integration-options/rest-api/openapi/v2/schemas/new-customer-request.md): Customer creation request including profile, payment option, and account details. - [PayID Detail](/docs/integration-options/rest-api/openapi/v2/schemas/payid-detail.md): PayID details including PayID value, name, and reference. - [Payment Account Reference](/docs/integration-options/rest-api/openapi/v2/schemas/payment-account-reference.md): Payment account proxy reference. Recommended over CardProxy. - [Payment Account Reference Response](/docs/integration-options/rest-api/openapi/v2/schemas/payment-account-reference-response.md): Payment account proxy response representing the different response structures for card, bank account, PayID, and PayTo details. - [Payment Additional Data](/docs/integration-options/rest-api/openapi/v2/schemas/payment-additional-data.md): Acquirer and issuer references for a card transaction: the authorisation code, the retrieval reference number and the system trace audit number. - [Payment Card](/docs/integration-options/rest-api/openapi/v2/schemas/payment-card.md): Card details for direct card payment including cardholder name, card number, expiry, and CVV. - [Payment Request](/docs/integration-options/rest-api/openapi/v2/schemas/payment-request.md): Payment request including customer reference or card proxy, amount, and optional 3D Secure details. - [Payment Result](/docs/integration-options/rest-api/openapi/v2/schemas/payment-result.md): Payment response including status, amounts, fees, and settlement details. Fields marked as conditional are only returned under certain conditions. - [Ping Response](/docs/integration-options/rest-api/openapi/v2/schemas/ping-response.md): Ping response including server date time and version information. - [Preauthorization Capture Request](/docs/integration-options/rest-api/openapi/v2/schemas/preauthorization-capture-request.md): Capture request for a preauthorization including payment amount and optional references. - [Preauthorization Capture Result](/docs/integration-options/rest-api/openapi/v2/schemas/preauthorization-capture-result.md): Capture preauthorization response including status, amounts, and transaction details. Fields marked as conditional are only returned under certain conditions. - [Preauthorization Request](/docs/integration-options/rest-api/openapi/v2/schemas/preauthorization-request.md): Preauthorization request including customer reference, amount, and optional card or proxy details. - [Preauthorization Result](/docs/integration-options/rest-api/openapi/v2/schemas/preauthorization-result.md): Preauthorization response including status, amounts, fees, and settlement details. Fields marked as conditional are only returned under certain conditions. - [Preauthorization Void Result](/docs/integration-options/rest-api/openapi/v2/schemas/preauthorization-void-result.md): Void preauthorization response including status and transaction details. Fields marked as conditional are only returned under certain conditions. - [Precondition Failed Response](/docs/integration-options/rest-api/openapi/v2/schemas/precondition-failed-response.md): Error response returned when a precondition check fails. - [Pricing](/docs/integration-options/rest-api/openapi/v2/schemas/pricing.md): Applicable fee for the card used. - [Pricing Response](/docs/integration-options/rest-api/openapi/v2/schemas/pricing-response.md): Pricing response including applicable fees. - [Refund Request](/docs/integration-options/rest-api/openapi/v2/schemas/refund-request.md): Refund request including refund value and optional merchant unique ID. - [Refund Result](/docs/integration-options/rest-api/openapi/v2/schemas/refund-result.md): Refund request response including status and refund reference. - [Request Pay Batch Request](/docs/integration-options/rest-api/openapi/v2/schemas/request-pay-batch-request.md): Container for request-to-pay entries. Root element containing a collection of RequestPayEntry. - [Request Pay Entry](/docs/integration-options/rest-api/openapi/v2/schemas/request-pay-entry.md): Individual entry within a request-to-pay batch including amount and recipient details. - [Request Pay Entry Request](/docs/integration-options/rest-api/openapi/v2/schemas/request-pay-entry-request.md): Individual request-to-pay entry submitted by the client. - [Request Pay Response](/docs/integration-options/rest-api/openapi/v2/schemas/request-pay-response.md): Request-to-pay response returned after submission. - [Request Pay Summary](/docs/integration-options/rest-api/openapi/v2/schemas/request-pay-summary.md): Request-to-pay summary including status, totals, and processing details. - [Settlement Payment](/docs/integration-options/rest-api/openapi/v2/schemas/settlement-payment.md): Settlement payment details including processing date, status, settlement date, and funds to merchant. - [Sub Payment](/docs/integration-options/rest-api/openapi/v2/schemas/sub-payment.md): Refund or recall transaction details including date, fees, amount, reason, and status. - [Validation Error](/docs/integration-options/rest-api/openapi/v2/schemas/validation-error.md): Represents an error that occurs during model binding. - [Validation Model State](/docs/integration-options/rest-api/openapi/v2/schemas/validation-model-state.md): Encapsulates the state of model binding to a property of an action-method argument, or to the argument itself. - [Validation Result](/docs/integration-options/rest-api/openapi/v2/schemas/validation-result.md): Represents the result of binding a value (such as from a form post or query string) to an action-method argument property, or to the argument itself. - [Create a session](/docs/integration-options/rest-api/openapi/v2/sessions-create.md): Creates a session for the payment plugin. The session created will have an expiry. - [Customer APIs](/docs/integration-options/rest-api/openapi/v3/customer-apis.md): Self-service REST API for merchant customers, using a Bearer token issued by the customer through their own portal account (distinct from the Merchant API's ZenPay-issued Basic/Api-Key credentials). - [Ping method to get the server date time and version information](/docs/integration-options/rest-api/openapi/v3/diagnostics-ping.md): Ping method to get the server date time and version information - [Get all the payments](/docs/integration-options/rest-api/openapi/v3/payments-get.md): Get all the payments - [Get a payment by unique ID](/docs/integration-options/rest-api/openapi/v3/payments-get-payment.md): Returns the payment for the specified customer and unique payment ID. - [Get a payment by reference](/docs/integration-options/rest-api/openapi/v3/payments-get-payment-by-reference.md): Returns the payment for the specified customer and payment reference. - [Create a payment](/docs/integration-options/rest-api/openapi/v3/payments-post.md): Creates a payment from the supplied request payload. - [CancellationToken](/docs/integration-options/rest-api/openapi/v3/schemas/cancellationtoken.md) - [PaymentRequest](/docs/integration-options/rest-api/openapi/v3/schemas/paymentrequest.md) - [PingResponse](/docs/integration-options/rest-api/openapi/v3/schemas/pingresponse.md): Ping result - [SafeWaitHandle](/docs/integration-options/rest-api/openapi/v3/schemas/safewaithandle.md) - [WaitHandle](/docs/integration-options/rest-api/openapi/v3/schemas/waithandle.md) - [Refund Guide](/docs/integration-options/rest-api/refunds.md): Guide to processing refunds - [Sessions and Hosted Checkout](/docs/integration-options/rest-api/sessions-and-hosted-checkout.md): How Merchant API sessions support secure Hosted Checkout launches. ## Openapi - [API Reference](/docs/openapi.md): Choose between the Merchant APIs and Customer APIs reference ## Release Notes - [Release Notes](/release-notes.md): ZenPay platform release notes and updates ## Resources - [Architecture](/docs/resources/architecture.md): Use this page for: - [Glossary & FAQ](/docs/resources/glossary-faq.md): Common terms and frequently asked questions about Zenith Payments. - [Status Codes](/docs/resources/payment-and-transaction-codes.md): Transaction type codes and payment status codes used across all ZenPay integration methods. - [Payment Methods](/docs/resources/payment-methods.md): Supported payment methods across Zenith integration paths - [Bank and PayID](/docs/resources/payment-methods/bank-npp.md): Bank transfer and PayID payment method - [Buy Now Pay Later](/docs/resources/payment-methods/buy-now-pay-later.md): SlicePay BNPL payment method (TravelPay only) - [Cards](/docs/resources/payment-methods/cards.md): Card payment schemes, tokenisation, and 3DS across Zenith integration paths - [Digital Wallets](/docs/resources/payment-methods/digital-wallets.md): Apple Pay, Google Pay, and Alipay+ availability and platform behaviour - [PayTo](/docs/resources/payment-methods/payto.md): Zenith supports PayTo, the real-time bank account payment solution built on the NPP (New Payment Platform). - [Test Cards](/docs/resources/test-cards.md): Test card numbers and credentials for development - [Developer Tools](/docs/resources/tools.md): Interactive utilities to help you integrate, test, and debug Zenith Payments - [Webhooks](/docs/resources/webhooks.md): Webhook event types, payload structure, and signature verification. ## Security - [Security](/docs/security.md): Security requirements, TLS standards, signature verification, and PCI DSS compliance guidance.