This page is a ZenPay-styled copy of the Zenith Payments developer documentation. View the original docs

Integration Checklist

Use This Checklist

Check off each item before going live. This is an example list as each integration can be unique.

Your progress is saved in this browser and will persist across sessions.

Tick items off as you go. Your progress is saved in this browser only.

Test Account Setup#

Initial integration meetingRequiredStandard

Contact your BDM
Discuss goals and implementation method

Owner: Merchant · Section: Test Account SetupSandbox account createdRequiredStandard

Have sandbox credentials
Merchant portal access if needed

Owner: Merchant · Section: Test Account SetupIntegration method chosenRequiredStandardOwner: Merchant · Section: Test Account Setup

Code Implementation (Plugin)#

Server-side session creation implementedConditionalStandard

API key stored securely (environment variables)
Never exposed in client-side code
Fingerprinting not exposed client-side

Owner: Merchant · Section: Code Implementation (Plugin)Fingerprint generation correctConditionalHigh risk

Using SHA3-512 algorithm
Using UTC timestamp and cents for payment amount
Values concatenated and separated by pipes (|)

Owner: Merchant · Section: Code Implementation (Plugin)Required fields includedConditionalStandard

version (must be 5+)
endpointUrl
merchantCode
mode
userMode
displayMode
redirectUrl
callbackUrl
customerEmail
merchantUniquePaymentId
timestamp
fingerprint
customerName (for modes 0, 2, 3)
paymentAmount (for modes 0, 2, 3)

Owner: Merchant · Section: Code Implementation (Plugin)Client-side integration completeConditionalStandard

CDN scripts loaded (CSS and JS)
Payment button triggers session creation
Payment window opens correctly (modal/redirect)
Callback URL received

Owner: Merchant · Section: Code Implementation (Plugin)

Code Implementation (API)#

Correct API endpoints identifiedConditionalStandard

Identify required endpoints to make payments
Identify required endpoints to reconcile payments
Consider other API endpoint use cases

Owner: Merchant · Section: Code Implementation (API)Handle state changesConditionalStandard

Regularly check endpoints for state changes (settlement, PayTo mandates)

Owner: Merchant · Section: Code Implementation (API)Create front-end UI/UX for API operationsConditionalStandard

UI for making payments
UI for managing customer payment token wallet (if tokenising)
UI/UX for other API functions (refund requests, transaction history)

Owner: Merchant · Section: Code Implementation (API)

Error Handling#

Retry logic implementedRequiredStandard

User-friendly failure messaging
Instructions for retrying

Owner: Merchant · Section: Error HandlingLogging configuredRequiredMedium risk

Errors logged for debugging
NO sensitive data logged (full API keys, fingerprints)
Includes error codes, timestamps, context

Owner: Merchant · Section: Error Handling

Payment Flow#

Success flow testedRequiredStandard

Test payment processes correctly
Customer redirected to success page
Order marked as paid in database
Confirmation email sent (optional)

Owner: Merchant · Section: Payment FlowFailure flow testedRequiredStandard

Payment fails gracefully
Error message shown to customer
Order remains unpaid in database
Customer can retry payment

Owner: Merchant · Section: Payment FlowEdge cases handledRequiredStandard

Session timeout (30 minutes)
Duplicate transactions prevented (use merchantUniquePaymentId)
Reconciliation via callbackUrl or API, not redirectUrl

Owner: Merchant · Section: Payment Flow

Functional Testing#

All payment modes testedRequiredStandard

Mode 0: Payment (standard)
Mode 1: Tokenisation (if using)
Mode 2: Custom payment (if using)
Mode 3: Pre-authorisation (if using)

Owner: Merchant · Section: Functional TestingAll test cards testedRequiredStandard

Success: 4111 1111 1111 1111
Declined: 4000 0000 0000 0002
3DS Required: 4000 0000 0000 3220
Insufficient Funds: 4000 0000 0000 9995

Owner: Merchant · Section: Functional TestingAmount variations testedRequiredStandard

Minimum amount ($0.01)
Large amounts ($9,999.99)
Decimal amounts ($12.34)

Owner: Merchant · Section: Functional Testing3D Secure testedRequiredMedium risk

3DS authentication prompt shows
Success and failure scenarios tested
Redirects work correctly

Owner: Merchant · Section: Functional Testing

Integration Testing#

End-to-end flow completeRequiredStandard

Customer selects product, adds to cart, proceeds to checkout
Completes payment
Receives confirmation

Owner: Merchant · Section: Integration TestingRedirect URLs correctRequiredStandard

Success URL receives payment data
Payment reference captured
Order ID matches
Status codes interpreted correctly

Owner: Merchant · Section: Integration TestingSession management tested (if using)ConditionalStandard

New session created for each payment
Old tokens do not work
Tokens expire after 30 minutes
Tokens are single-use

Owner: Merchant · Section: Integration Testing

Browser & Device Testing#

Desktop browsers testedRequiredStandard

Chrome (latest)
Firefox (latest)
Safari (latest)
Edge (latest)

Owner: Merchant · Section: Browser & Device TestingMobile browsers testedRequiredStandard

iOS Safari
Android Chrome
Mobile responsive design

Owner: Merchant · Section: Browser & Device Testing

API Security#

API keys securedRequiredHigh risk

Stored in environment variables
Never in source code
Never in client-side JavaScript
Added to .gitignore

Owner: Security · Section: API SecurityHTTPS enforcedRequiredHigh risk

Site uses HTTPS only
SSL certificate valid
HTTP redirects to HTTPS

Owner: Security · Section: API SecurityInput validationRequiredStandard

Email format validated
Amount validated (min/max)
Required fields checked
Special characters sanitized

Owner: Security · Section: API SecurityRate limiting implementedRequiredMedium risk

Prevents session creation spam
Protects against abuse
Reasonable limits set

Owner: Security · Section: API SecurityReCaptcha/Cloudflare/similar implementedRequiredMedium risk

Reduces bot attacks
Protects against abuse

Owner: Security · Section: API Security

PCI Compliance#

Hosted Checkout Page (Recommended)RecommendedStandard

No PCI compliance burden
Cards never touch your server
Zenith handles security

Owner: Security · Section: PCI ComplianceAPI Integration tokenisation (if using)ConditionalStandard

PCI DSS SAQ D completed
Quarterly vulnerability scans scheduled
Annual security audit planned
Server hardened and patched
Card data encrypted at rest
Network segmented
Access controls in place

Owner: Security · Section: PCI Compliance

Data Protection#

Secure storageRequiredStandard

Payment references stored securely (safe to store)
NO card numbers stored
NO CVV stored
Tokens stored securely (if tokenising)

Owner: Security · Section: Data Protection

Configuration#

Environment variables setRequiredStandard

Production API URL
Production payment page URL
Production API key
Production merchant code
Production redirect URLs

Owner: Merchant · Section: ConfigurationCredentials switchedRequiredStandard

Sandbox → production API key
Sandbox → production URLs
Test cards → real cards only

Owner: Merchant · Section: ConfigurationMonitoring configuredRequiredMedium risk

Error tracking (e.g. Sentry)
Performance monitoring
Payment success/failure metrics
Alerts for critical errors

Owner: Merchant · Section: Configuration

Documentation#

Internal documentation writtenRequiredStandard

How to process refunds
How to check payment status
Error handling procedures
Support escalation process

Owner: Merchant ops · Section: DocumentationCustomer documentation readyRecommendedStandard

Payment instructions
Accepted card types
FAQ section
Contact information

Owner: Merchant ops · Section: DocumentationSupport team trainedRequiredStandard

Understands payment flow
Knows how to check payment status
Can explain common errors
Has access to merchant portal

Owner: Merchant ops · Section: Documentation

Final Checks#

Production credentials verifiedRequiredHigh risk

Test payment with real card (small amount)
Refund test payment immediately
Verify payment appears in merchant portal

Owner: Merchant · Section: Final ChecksProduction account requestedRequiredStandard

Applied for production account
Completed KYC verification
Received production credentials

Owner: Shared · Section: Final ChecksMonitoring activeRequiredMedium risk

Error alerts configured
Success rate tracked
Performance metrics visible
Support notified of launch

Owner: Merchant · Section: Final ChecksRollback plan readyRequiredHigh risk

Can revert to old payment system
Database backup taken
Rollback procedure documented

Owner: Merchant · Section: Final ChecksLoad testing doneRequiredMedium risk

Tested with concurrent users
No bottlenecks identified
Server can handle expected load

Owner: Merchant · Section: Final Checks

Communication#

Stakeholders informedRequiredStandard

Management aware of go-live
Finance team prepared
Customer support briefed
Marketing notified (if announcing)

Owner: Merchant ops · Section: CommunicationCustomers notified (if changing systems)ConditionalStandard

Email sent about new payment system
FAQ updated
Benefits explained
Transition timeline clear

Owner: Merchant ops · Section: Communication

Post-Launch#

Monitor closelyRecommendedStandard

Check error rates daily
Review payment success rate
Read customer feedback
Check for issues in merchant portal

Owner: Merchant · Section: Post-LaunchPerformance reviewRecommendedStandard

Average payment completion time
Session creation success rate
Error frequency by type
Browser/device breakdown

Owner: Merchant · Section: Post-LaunchSupport reviewRecommendedStandard

Customer questions logged
Common issues identified
FAQ updated if needed
Team feedback gathered

Owner: Merchant · Section: Post-Launch

✅ Production Approval#

Field	Details
Integration completed by	__
Date	__
Approved by	__
Go-live date	__

Ready to Launch?

When all items are checked, you're ready for production! Remember to monitor closely for the first week.

🆘 Support Contacts#

Email: Integrations@zenithpayments.com.au
Portal: Submit ticket

📚 Additional Resources#

🎉 Congratulations!#

You're ready to launch! This checklist ensures a smooth, secure integration. Questions before launch? Contact integrations@zenithpayments.com.au After launch? We're here to help, please reach out any time!

Need help with your integration?Talk to the Zenith Integrations Team.

Email integrations Talk to us

Integration Checklist

Test Account Setup#

Code Implementation (Plugin)#

Code Implementation (API)#

Error Handling#

Payment Flow#

Functional Testing#

Integration Testing#

Browser & Device Testing#

API Security#

PCI Compliance#

Data Protection#

Configuration#

Documentation#

Final Checks#

Communication#

Post-Launch#

✅ Production Approval#

🆘 Support Contacts#

Technical Issues (integration related)#

📚 Additional Resources#

🎉 Congratulations!#