com.squareup.square.api

Interface PaymentsApi

All Known Implementing Classes:

DefaultPaymentsApi

public interface PaymentsApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
CancelPaymentResponse	cancelPayment(String paymentId) Cancels (voids) a payment.
CompletableFuture<CancelPaymentResponse>	cancelPaymentAsync(String paymentId) Cancels (voids) a payment.
CancelPaymentByIdempotencyKeyResponse	cancelPaymentByIdempotencyKey(CancelPaymentByIdempotencyKeyRequest body) Cancels (voids) a payment identified by the idempotency key that is specified in the request.
CompletableFuture<CancelPaymentByIdempotencyKeyResponse>	cancelPaymentByIdempotencyKeyAsync(CancelPaymentByIdempotencyKeyRequest body) Cancels (voids) a payment identified by the idempotency key that is specified in the request.
CompletePaymentResponse	completePayment(String paymentId, CompletePaymentRequest body) Completes (captures) a payment.
CompletableFuture<CompletePaymentResponse>	completePaymentAsync(String paymentId, CompletePaymentRequest body) Completes (captures) a payment.
CreatePaymentResponse	createPayment(CreatePaymentRequest body) Creates a payment using the provided source.
CompletableFuture<CreatePaymentResponse>	createPaymentAsync(CreatePaymentRequest body) Creates a payment using the provided source.
GetPaymentResponse	getPayment(String paymentId) Retrieves details for a specific payment.
CompletableFuture<GetPaymentResponse>	getPaymentAsync(String paymentId) Retrieves details for a specific payment.
ListPaymentsResponse	listPayments(String beginTime, String endTime, String sortOrder, String cursor, String locationId, Long total, String last4, String cardBrand, Integer limit) Retrieves a list of payments taken by the account making the request.
CompletableFuture<ListPaymentsResponse>	listPaymentsAsync(String beginTime, String endTime, String sortOrder, String cursor, String locationId, Long total, String last4, String cardBrand, Integer limit) Retrieves a list of payments taken by the account making the request.
UpdatePaymentResponse	updatePayment(String paymentId, UpdatePaymentRequest body) Updates a payment with the APPROVED status.
CompletableFuture<UpdatePaymentResponse>	updatePaymentAsync(String paymentId, UpdatePaymentRequest body) Updates a payment with the APPROVED status.

Method Detail

listPayments

ListPaymentsResponse listPayments(String beginTime,
                                  String endTime,
                                  String sortOrder,
                                  String cursor,
                                  String locationId,
                                  Long total,
                                  String last4,
                                  String cardBrand,
                                  Integer limit)
                           throws ApiException,
                                  IOException

Retrieves a list of payments taken by the account making the request. Results are eventually consistent, and new payments or changes to payments might take several seconds to appear. The maximum results per page is 100.

Parameters:

beginTime - Optional parameter: Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the `created_at` field for each Payment. Inclusive. Default: The current time minus one year.

endTime - Optional parameter: Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the `created_at` field for each Payment. Default: The current time.

sortOrder - Optional parameter: The order in which results are listed by `Payment.created_at`: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

locationId - Optional parameter: Limit results to the location supplied. By default, results are returned for the default (main) location associated with the seller.

total - Optional parameter: The exact amount in the `total_money` for a payment.

last4 - Optional parameter: The last four digits of a payment card.

cardBrand - Optional parameter: The brand of the payment card (for example, VISA).

limit - Optional parameter: The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`

Returns:

Returns the ListPaymentsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listPaymentsAsync

CompletableFuture<ListPaymentsResponse> listPaymentsAsync(String beginTime,
                                                          String endTime,
                                                          String sortOrder,
                                                          String cursor,
                                                          String locationId,
                                                          Long total,
                                                          String last4,
                                                          String cardBrand,
                                                          Integer limit)

Retrieves a list of payments taken by the account making the request. Results are eventually consistent, and new payments or changes to payments might take several seconds to appear. The maximum results per page is 100.

Parameters:

beginTime - Optional parameter: Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the `created_at` field for each Payment. Inclusive. Default: The current time minus one year.

endTime - Optional parameter: Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the `created_at` field for each Payment. Default: The current time.

sortOrder - Optional parameter: The order in which results are listed by `Payment.created_at`: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

locationId - Optional parameter: Limit results to the location supplied. By default, results are returned for the default (main) location associated with the seller.

total - Optional parameter: The exact amount in the `total_money` for a payment.

last4 - Optional parameter: The last four digits of a payment card.

cardBrand - Optional parameter: The brand of the payment card (for example, VISA).

limit - Optional parameter: The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`

Returns:

Returns the ListPaymentsResponse response from the API call

createPayment

CreatePaymentResponse createPayment(CreatePaymentRequest body)
                             throws ApiException,
                                    IOException

Creates a payment using the provided source. You can use this endpoint to charge a card (credit/debit card or Square gift card) or record a payment that the seller received outside of Square (cash payment from a buyer or a payment that an external entity processed on behalf of the seller). The endpoint creates a `Payment` object and returns it in the response.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreatePaymentResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createPaymentAsync

CompletableFuture<CreatePaymentResponse> createPaymentAsync(CreatePaymentRequest body)

Creates a payment using the provided source. You can use this endpoint to charge a card (credit/debit card or Square gift card) or record a payment that the seller received outside of Square (cash payment from a buyer or a payment that an external entity processed on behalf of the seller). The endpoint creates a `Payment` object and returns it in the response.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreatePaymentResponse response from the API call

cancelPaymentByIdempotencyKey

CancelPaymentByIdempotencyKeyResponse cancelPaymentByIdempotencyKey(CancelPaymentByIdempotencyKeyRequest body)
                                                             throws ApiException,
                                                                    IOException

Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when the status of a `CreatePayment` request is unknown (for example, after you send a `CreatePayment` request, a network error occurs and you do not get a response). In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your `CreatePayment` request that you want to cancel. After canceling the payment, you can submit your `CreatePayment` request again. Note that if no payment with the specified idempotency key is found, no action is taken and the endpoint returns successfully.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CancelPaymentByIdempotencyKeyResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

cancelPaymentByIdempotencyKeyAsync

CompletableFuture<CancelPaymentByIdempotencyKeyResponse> cancelPaymentByIdempotencyKeyAsync(CancelPaymentByIdempotencyKeyRequest body)

Cancels (voids) a payment identified by the idempotency key that is specified in the request. Use this method when the status of a `CreatePayment` request is unknown (for example, after you send a `CreatePayment` request, a network error occurs and you do not get a response). In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your `CreatePayment` request that you want to cancel. After canceling the payment, you can submit your `CreatePayment` request again. Note that if no payment with the specified idempotency key is found, no action is taken and the endpoint returns successfully.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CancelPaymentByIdempotencyKeyResponse response from the API call

getPayment

GetPaymentResponse getPayment(String paymentId)
                       throws ApiException,
                              IOException

Retrieves details for a specific payment.

Parameters:

paymentId - Required parameter: A unique ID for the desired payment.

Returns:

Returns the GetPaymentResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

getPaymentAsync

CompletableFuture<GetPaymentResponse> getPaymentAsync(String paymentId)

Retrieves details for a specific payment.

Parameters:

paymentId - Required parameter: A unique ID for the desired payment.

Returns:

Returns the GetPaymentResponse response from the API call

updatePayment

UpdatePaymentResponse updatePayment(String paymentId,
                                    UpdatePaymentRequest body)
                             throws ApiException,
                                    IOException

Updates a payment with the APPROVED status. You can update the `amount_money` and `tip_money` using this endpoint.

Parameters:

paymentId - Required parameter: The ID of the payment to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdatePaymentResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updatePaymentAsync

CompletableFuture<UpdatePaymentResponse> updatePaymentAsync(String paymentId,
                                                            UpdatePaymentRequest body)

Updates a payment with the APPROVED status. You can update the `amount_money` and `tip_money` using this endpoint.

Parameters:

paymentId - Required parameter: The ID of the payment to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdatePaymentResponse response from the API call

cancelPayment

CancelPaymentResponse cancelPayment(String paymentId)
                             throws ApiException,
                                    IOException

Cancels (voids) a payment. You can use this endpoint to cancel a payment with the APPROVED `status`.

Parameters:

paymentId - Required parameter: The ID of the payment to cancel.

Returns:

Returns the CancelPaymentResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

cancelPaymentAsync

CompletableFuture<CancelPaymentResponse> cancelPaymentAsync(String paymentId)

Cancels (voids) a payment. You can use this endpoint to cancel a payment with the APPROVED `status`.

Parameters:

paymentId - Required parameter: The ID of the payment to cancel.

Returns:

Returns the CancelPaymentResponse response from the API call

completePayment

CompletePaymentResponse completePayment(String paymentId,
                                        CompletePaymentRequest body)
                                 throws ApiException,
                                        IOException

Completes (captures) a payment. By default, payments are set to complete immediately after they are created. You can use this endpoint to complete a payment with the APPROVED `status`.

Parameters:

paymentId - Required parameter: The unique ID identifying the payment to be completed.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CompletePaymentResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

completePaymentAsync

CompletableFuture<CompletePaymentResponse> completePaymentAsync(String paymentId,
                                                                CompletePaymentRequest body)

Completes (captures) a payment. By default, payments are set to complete immediately after they are created. You can use this endpoint to complete a payment with the APPROVED `status`.

Parameters:

paymentId - Required parameter: The unique ID identifying the payment to be completed.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CompletePaymentResponse response from the API call