Integration Checklist

Last updated: 2026-10-20

Use this checklist before requesting Production approval. Complete every Required item. Complete If used items only when the ECR supports that feature or payment scheme.

For each test, record Pass/Fail, test date, tester, terminal ID, ECR sale ID, onlineAPIRefId, and an evidence link. Remove credentials, registration codes, and sensitive card data from all evidence.

Required checklist

Required checkPass whenMinimum evidence
Secure API accessDemo and Production settings are separate. Credentials are stored securely, required authentication headers are sent, and secrets or card data are not logged.One sanitized configuration sample, request-header sample, and application log.
Link the correct terminalLinking returns HTTP 200 with printerEnabled, the terminal shows Connected, and each ECR lane uses only its assigned terminalId.Link response, terminal screen evidence, and lane-to-terminal mapping.
Unlink and relinkUnlinking displays a new registration code, the old link cannot be used, and the terminal can be linked again. Physical-terminal requests do not include the Sandbox-only ConnectionId header.Unlink result, terminal screen evidence, and one sanitized physical-terminal request.
Validate and start a transactionThe ECR rejects an invalid amount, unsupported currency, or missing terminal before calling the API. Only one financial transaction can be active per terminal.One rejected-input test and one duplicate-click or concurrent-request test.
Track the transactionAfter HTTP 201, the ECR saves onlineAPIRefId against the sale. It keeps the sale pending until a final status is retrieved; HTTP 201 alone is never treated as approval.Request/response log and the saved ECR sale ID-to-onlineAPIRefId mapping.
Poll and finish oncePolling starts after saving the reference, normally runs no more often than every 2 seconds, continues only for status 14 (PENDING), and stops on a final status. Repeated results cannot update or print twice.One status history from PENDING to final and one duplicate-result test.
Handle cancel and refundThe cashier can cancel before approval and complete a refund. The ECR stores and displays the correct final result and receipt.One cancellation result, one refund result, and their receipts.
Recover safelyA timeout, lost connection, or HTTP 5xx is not treated as a decline or followed by an unsafe duplicate financial POST. HTTP 429 follows Retry-After. After offline status 9, the ECR retrieves and resolves the last transaction.One offline-recovery log and one retry or throttling test result.
Reconcile transactionsTransactions are recorded once with the correct amount, time, terminal, and final result, and ECR totals match the payment/control report.One reconciliation sample covering the required tests.

See Retrieve transaction status for all status values and Error handling for retry guidance.

Required acceptance tests

Run these tests in the approved test environment. A test passes when the terminal flow, final API result, ECR state, and receipt are correct.

Test groupTests to completeMinimum evidence
Terminal setupLink, unlink, and relink the terminal.Link/unlink responses and terminal screen evidence.
Approved purchasesChip + PIN, signature approval, contactless above the CVM limit with PIN, and contactless below the CVM limit without PIN.Test record and receipt for each purchase.
Cancelled purchasesRemove the card before PIN, cancel on the terminal before PIN, remove the card after PIN, wait for terminal timeout, and cancel from the ECR before approval.Test record showing that the sale was not completed, plus each available receipt.
RefundsRefund by chip, magstripe, and contactless; cancel one refund before approval.Test record and receipt for each refund flow.
Connection recoveryDisconnect terminal internet before PIN, complete the terminal flow, wait more than 60 seconds, reconnect, retrieve the last transaction, and retrieve its final status.Log showing status 9 while offline and the recovered final result after reconnecting.
Status retrievalRetrieve status during a complete transaction.Log showing PENDING, the final status, and the correct transaction details.
Receipts and control reportCheck merchant and cardholder receipts, then compare ECR records with the payment/control report.Receipt samples and one matching reconciliation report.

If used by the ECR

Test only the features offered to the customer:

  • Purchase reversal and refund reversal.
  • BankAxept purchase and refund.
  • Dankort purchase and refund.
  • Loyalty card handling.
  • Tip entered on the terminal or ECR.
  • Transaction report retrieval.
  • Terminal configuration printing.
  • Receipt printing through PrintData.

For each selected feature, provide one successful test record and its receipt, report, or printed output.

Minimum evidence pack

Submit only the following:

  1. The completed checklist and acceptance-test results.
  2. Sanitized API logs showing request acceptance, onlineAPIRefId, status polling, and final results.
  3. Terminal link/unlink evidence and the ECR lane-to-terminal mapping.
  4. Merchant and cardholder receipt samples for the required transaction tests.
  5. One offline-recovery log and one reconciliation sample.

Westpay may request more evidence when optional features, local payment schemes, or customer-specific behavior are included.

Before Production rollout

  • Production credentials and URLs are separate from Demo.
  • Support contacts and a rollback plan are available.
  • A controlled Production transaction is completed and reconciled before enabling all stores.

Completing this checklist confirms that the integration has covered the minimum technical and acceptance requirements. Final Production approval remains part of Westpay's onboarding process.