TerminalService class

URL: https://developer.squareup.com/reference/square/terminal-api The Terminal API allows you to manage terminal checkout and Interac refund requests sent to a paired Square Terminal. You can create a checkout or Interac refund request, check its status, cancel the request, search for in-process requests, and get the results of the request after it is completed.

Constructors

TerminalService.new({required String baseUrl, required AuthenticationService authenticationService})

Properties

authenticationService → AuthenticationService

final

baseUrl → String

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cancelTerminalCheckout({required String checkoutId, String? authToken}) → Future<TerminalCheckout>

Cancels a Terminal checkout request if the status of the request permits it.

cancelTerminalRefund({required String terminalRefundId, String? authToken}) → Future<TerminalRefund>

Cancels a Terminal checkout request if the status of the request permits it.

createTerminalCheckout({required CreateTerminalCheckoutRequest request, String? authToken}) → Future<TerminalCheckout>

Creates a Terminal checkout request and sends it to the specified device to take a payment for the requested amount.

createTerminalRefund({required CreateRefundRequest request, String? authToken}) → Future<TerminalRefund>

Creates a request to refund an Interac payment completed on a Square Terminal.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

readTerminalCheckout({required String checkoutId, String? authToken}) → Future<TerminalCheckout>

Retrieves a Terminal checkout request by checkoutId.

readTerminalRefund({required String terminalRefundId, String? authToken}) → Future<TerminalRefund>

Retrieves an Interac Terminal refund object by ID.

searchTerminalCheckout({required SearchTerminalRequest request, String? authToken}) → Future<TerminalCheckoutResponse>

Retrieves a filtered list of Terminal checkout requests created by the account making the request.

searchTerminalRefund({required SearchTerminalRequest request, String? authToken}) → Future<TerminalRefundResponse>

Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited