com.squareup.square.api

Interface CheckoutApi

All Known Implementing Classes:

DefaultCheckoutApi

public interface CheckoutApi

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
CreateCheckoutResponse	createCheckout(String locationId, CreateCheckoutRequest body) 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.
CompletableFuture<CreateCheckoutResponse>	createCheckoutAsync(String locationId, CreateCheckoutRequest body) 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.
CreatePaymentLinkResponse	createPaymentLink(CreatePaymentLinkRequest body) Creates a Square-hosted checkout page.
CompletableFuture<CreatePaymentLinkResponse>	createPaymentLinkAsync(CreatePaymentLinkRequest body) Creates a Square-hosted checkout page.
DeletePaymentLinkResponse	deletePaymentLink(String id) Deletes a payment link.
CompletableFuture<DeletePaymentLinkResponse>	deletePaymentLinkAsync(String id) Deletes a payment link.
ListPaymentLinksResponse	listPaymentLinks(String cursor, Integer limit) Lists all payment links.
CompletableFuture<ListPaymentLinksResponse>	listPaymentLinksAsync(String cursor, Integer limit) Lists all payment links.
RetrievePaymentLinkResponse	retrievePaymentLink(String id) Retrieves a payment link.
CompletableFuture<RetrievePaymentLinkResponse>	retrievePaymentLinkAsync(String id) Retrieves a payment link.
UpdatePaymentLinkResponse	updatePaymentLink(String id, UpdatePaymentLinkRequest body) Updates a payment link.
CompletableFuture<UpdatePaymentLinkResponse>	updatePaymentLinkAsync(String id, UpdatePaymentLinkRequest body) Updates a payment link.

Method Detail

createCheckout

CreateCheckoutResponse createCheckout(String locationId,
                                      CreateCheckoutRequest body)
                               throws ApiException,
                                      IOException

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. NOTE: The Checkout API has been updated with new features. For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights). We recommend that you use the new [CreatePaymentLink]($e/Checkout/CreatePaymentLink) endpoint in place of this previously released endpoint.

Parameters:

locationId - Required parameter: The ID of the business location to associate the checkout with.

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

Returns:

Returns the CreateCheckoutResponse 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.

createCheckoutAsync

CompletableFuture<CreateCheckoutResponse> createCheckoutAsync(String locationId,
                                                              CreateCheckoutRequest body)

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. NOTE: The Checkout API has been updated with new features. For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights). We recommend that you use the new [CreatePaymentLink]($e/Checkout/CreatePaymentLink) endpoint in place of this previously released endpoint.

Parameters:

locationId - Required parameter: The ID of the business location to associate the checkout with.

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

Returns:

Returns the CreateCheckoutResponse response from the API call

listPaymentLinks

ListPaymentLinksResponse listPaymentLinks(String cursor,
                                          Integer limit)
                                   throws ApiException,
                                          IOException

Lists all payment links.

Parameters:

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. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).

limit - Optional parameter: A limit on the number of results to return per page. The limit is advisory and the implementation might return more or less results. If the supplied limit is negative, zero, or greater than the maximum limit of 1000, it is ignored. Default value: `100`

Returns:

Returns the ListPaymentLinksResponse 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.

listPaymentLinksAsync

CompletableFuture<ListPaymentLinksResponse> listPaymentLinksAsync(String cursor,
                                                                  Integer limit)

Lists all payment links.

Parameters:

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. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).

limit - Optional parameter: A limit on the number of results to return per page. The limit is advisory and the implementation might return more or less results. If the supplied limit is negative, zero, or greater than the maximum limit of 1000, it is ignored. Default value: `100`

Returns:

Returns the ListPaymentLinksResponse response from the API call

createPaymentLink

CreatePaymentLinkResponse createPaymentLink(CreatePaymentLinkRequest body)
                                     throws ApiException,
                                            IOException

Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services.

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 CreatePaymentLinkResponse 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.

createPaymentLinkAsync

CompletableFuture<CreatePaymentLinkResponse> createPaymentLinkAsync(CreatePaymentLinkRequest body)

Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services.

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 CreatePaymentLinkResponse response from the API call

deletePaymentLink

DeletePaymentLinkResponse deletePaymentLink(String id)
                                     throws ApiException,
                                            IOException

Deletes a payment link.

Parameters:

id - Required parameter: The ID of the payment link to delete.

Returns:

Returns the DeletePaymentLinkResponse 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.

deletePaymentLinkAsync

CompletableFuture<DeletePaymentLinkResponse> deletePaymentLinkAsync(String id)

Deletes a payment link.

Parameters:

id - Required parameter: The ID of the payment link to delete.

Returns:

Returns the DeletePaymentLinkResponse response from the API call

retrievePaymentLink

RetrievePaymentLinkResponse retrievePaymentLink(String id)
                                         throws ApiException,
                                                IOException

Retrieves a payment link.

Parameters:

id - Required parameter: The ID of link to retrieve.

Returns:

Returns the RetrievePaymentLinkResponse 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.

retrievePaymentLinkAsync

CompletableFuture<RetrievePaymentLinkResponse> retrievePaymentLinkAsync(String id)

Retrieves a payment link.

Parameters:

id - Required parameter: The ID of link to retrieve.

Returns:

Returns the RetrievePaymentLinkResponse response from the API call

updatePaymentLink

UpdatePaymentLinkResponse updatePaymentLink(String id,
                                            UpdatePaymentLinkRequest body)
                                     throws ApiException,
                                            IOException

Updates a payment link. You can update the `payment_link` fields such as `description`, `checkout_options`, and `pre_populated_data`. You cannot update other fields such as the `order_id`, `version`, `URL`, or `timestamp` field.

Parameters:

id - Required parameter: The ID of the payment link 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 UpdatePaymentLinkResponse 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.

updatePaymentLinkAsync

CompletableFuture<UpdatePaymentLinkResponse> updatePaymentLinkAsync(String id,
                                                                    UpdatePaymentLinkRequest body)

Updates a payment link. You can update the `payment_link` fields such as `description`, `checkout_options`, and `pre_populated_data`. You cannot update other fields such as the `order_id`, `version`, `URL`, or `timestamp` field.

Parameters:

id - Required parameter: The ID of the payment link 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 UpdatePaymentLinkResponse response from the API call