PaymentService class

URL: https://developer.squareup.com/reference/square/payments-api

Constructors

PaymentService({required String baseUrl, required AuthenticationService authenticationService})

Properties

authenticationService → AuthenticationService
final
baseUrl → String
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

acceptDispute({required String disputeId, String? authToken}) → Future<Dispute>
Accepts the loss on a dispute.
cancelPayment({required String paymentId, String? authToken}) → Future<bool>
Cancels (voids) a payment.
cancelPaymentByIdempotencyKey({required String idempotencyKey, String? authToken}) → Future<bool>
Cancels (voids) a payment identified by the idempotency key that is specified in the request.
completePayment({required String paymentId, required CompletePaymentRequest request, String? authToken}) → Future<Payment>
Completes (captures) a payment.
createCard({required CreateCardRequest request, String? authToken}) → Future<Card>
Adds a card on file to an existing merchant.
createCheckout({required String locationId, required CreateCheckoutRequest request, String? authToken}) → Future<Checkout>
Links a checkoutId to a checkout_page_url that customers are directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
createDisputeEvidenceFile({required String disputeId, required CreateDisputeEvidenceFileRequest request, String? authToken}) → Future<DisputeEvidence>
Uploads a file to use as evidence in a dispute challenge.
createDisputeEvidenceText({required String disputeId, required CreateDisputeEvidenceTextRequest request, String? authToken}) → Future<DisputeEvidence>
Uploads text to use as evidence for a dispute challenge.
createPayment({required CreatePaymentRequest request, String? authToken}) → Future<Payment>
Creates a payment using the provided source.
deleteDisputeEvidence({required String disputeId, required String evidenceId, String? authToken}) → Future<bool>
Removes specified evidence from a dispute.
disableCard({required String cardId, String? authToken}) → Future<Card>
Disables the card, preventing any further updates or charges.
listCards({required ListCardRequest request, String? authToken}) → Future<CardResponse>
Retrieves a list of cards owned by the account making the request.
listDisputeEvidence({required String disputeId, String? cursor, String? authToken}) → Future<DisputeEvidenceListResponse>
Returns a list of evidence associated with a dispute.
listDisputes({required ListDisputesRequest request, String? authToken}) → Future<DisputeResponse>
Returns a list of disputes associated with a particular account.
listPayments({required ListPaymentRequest request, String? authToken}) → Future<SquarePaymentResponse>
Retrieves a list of payments taken by the account making the request.
listRefunds({required ListRefundsRequest request, String? authToken}) → Future<SquareRefundResponse>
Retrieves a list of refunds for the account making the request.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
readCard({required String cardId, String? authToken}) → Future<Card>
Retrieves details for a specific Card.
readDispute({required String disputeId, String? authToken}) → Future<Dispute>
Returns details about a specific dispute.
readDisputeEvidence({required String disputeId, required String evidenceId, String? authToken}) → Future<DisputeEvidence>
Returns the evidence metadata specified by the evidence ID in the request URL path
readPayment({required String paymentId, String? authToken}) → Future<Payment>
Retrieves details for a specific payment.
readPaymentRefund({required String refundId, String? authToken}) → Future<Refund>
Retrieves a specific refund using the refund_id
refundPayment({required RefundPaymentRequest request, String? authToken}) → Future<Refund>
Refunds a payment.
registerApplePayDomain({required String domainName, String? authToken}) → Future<RegisterDomainResponseStatus>
Activates a domain for use with Apple Pay on the Web and Square.
submitDisputeEvidence({required String disputeId, String? authToken}) → Future<DisputeEvidence>
Submits evidence to the cardholder's bank.
toString() → String
A string representation of this object.
inherited
updatePayment({required String paymentId, required UpdatePaymentRequest request, String? authToken}) → Future<Payment>
Updates a payment with the APPROVED status.

Operators

operator ==(Object other) → bool
The equality operator.
inherited