TerminalPaymentsApi

Terminal API payment-domain operations.

Payment is the API domain grouping for financial and card-present terminal operations. A payment-domain create operation prepares an executable TransactionContext. The context's transactionId is the runtime identifier used to execute, cancel, and recover the operation. This is different from the acquirer-created transactionReferenceNumber returned by completed or reserved transaction data after execution.

The lifecycle is:

  1. Create a transaction context.

  2. Execute the returned transactionId.

  3. Cancel execution if the operation has not reached a point of no return.

Reservation is the authorization-like hold terminology used by the Terminal API. Capture completes a reservation. Reservation cancellation cancels a reserved transaction and is distinct from cancelTransactionExecution, which only attempts to stop a pending/running execution. createVoid creates a void transaction context; the underlying payment network/acquirer operation may be represented as a reversal.

Functions

Link copied to clipboard

Creates a refund context for later execution with executeTransaction.

Link copied to clipboard

Creates a refund context for later execution with TerminalPaymentsApi.executeTransaction.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Looks up the terminal's latest VCS purchase or reversal result.

Link copied to clipboard