Skip to main content
New to Corsair? See API access, authentication, and error handling.

Bookings

getBusinessProfile

bookings.getBusinessProfile Retrieves a seller’s booking profile. Risk: read
Input: empty object Output

Cards

create

cards.create Adds a card on file to an existing merchant. Requires idempotency_key; pass the same key to retry safely. Risk: write
Input
Output

disable

cards.disable Disables the card, preventing any further updates or charges. Disabling an already disabled card is allowed but has no effect. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

cards.get Retrieves details for a specific Card. Risk: read
Input Output

list

cards.list Retrieves a list of cards owned by the account making the request. A max of 25 cards will be returned. Risk: read
Input Output

Catalog

delete

catalog.delete Deletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

catalog.get Returns a single CatalogItem as a CatalogObject based on the provided ID. Risk: read
Input Output

list

catalog.list Returns a list of all CatalogObjects of the specified types in the catalog. Risk: read
Input Output

catalog.search Searches for CatalogObject of any type by matching supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query filters. Risk: read
Input
Output

upsert

catalog.upsert Creates a new or updates the specified CatalogObject. Replaces the whole object: any field left out of the request is cleared, nested variations included. Requires idempotency_key; pass the same key to retry safely. Risk: write
Input Replaces the whole object: any field left out of the request is cleared, nested variations included. Read it with catalog.get first and send it back complete.
Output

Channels

bulkGet

channels.bulkGet BulkRetrieveChannels. Beta in Square’s API; it may change. Risk: read
Input Output

get

channels.get RetrieveChannel. Beta in Square’s API; it may change. Risk: read
Input Output

list

channels.list ListChannels. Beta in Square’s API; it may change. Risk: read
Input Output

Checkout

getLocationSettings

checkout.getLocationSettings Retrieves the location-level settings for a Square-hosted checkout page. Beta in Square’s API; it may change. Risk: read
Input Output

updateLocationSettings

checkout.updateLocationSettings Updates the location-level settings for a Square-hosted checkout page. A policy’s title is required when setting its description. Beta in Square’s API; it may change. Risk: write
Input
Output

Custom Attribute Definitions

customer.create

customAttributeDefinitions.customer.create Creates a customer-related custom attribute definition for a Square seller account. Use this endpoint to define a custom attribute that can be associated with customer profiles. The definition name is required if visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES. Pass the same idempotency_key to retry safely. Risk: write
Input
Output

customer.delete

customAttributeDefinitions.customer.delete Deletes a customer-related custom attribute definition from a Square seller account. Cannot be undone. Risk: destructive · Irreversible
Input Output

customer.get

customAttributeDefinitions.customer.get Retrieves a customer-related custom attribute definition from a Square seller account. Risk: read
Input Output

customer.list

customAttributeDefinitions.customer.list Lists the customer-related custom attribute definitions that belong to a Square seller account. Risk: read
Input Output

customer.update

customAttributeDefinitions.customer.update Updates a customer-related custom attribute definition for a Square seller account. Pass the same idempotency_key to retry safely. Risk: write
Input
Output

location.create

customAttributeDefinitions.location.create Creates a location-related custom attribute definition for a Square seller account. Use this endpoint to define a custom attribute that can be associated with locations. The definition name is required if visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change. Risk: write
Input
Output

location.delete

customAttributeDefinitions.location.delete Deletes a location-related custom attribute definition from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from all locations. Cannot be undone. Beta in Square’s API; it may change. Risk: destructive · Irreversible
Input Output

location.get

customAttributeDefinitions.location.get Retrieves a location-related custom attribute definition from a Square seller account. Beta in Square’s API; it may change. Risk: read
Input Output

location.list

customAttributeDefinitions.location.list Lists the location-related custom attribute definitions that belong to a Square seller account. Beta in Square’s API; it may change. Risk: read
Input Output

location.update

customAttributeDefinitions.location.update Updates a location-related custom attribute definition for a Square seller account. Use this endpoint to update the following fields: name, description, visibility, or the schema for a Selection data type. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change. Risk: write
Input
Output

merchant.create

customAttributeDefinitions.merchant.create Creates a merchant-related custom attribute definition for a Square seller account. Use this endpoint to define a custom attribute that can be associated with a merchant connecting to your application. The definition name is required if visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change. Risk: write
Input
Output

merchant.delete

customAttributeDefinitions.merchant.delete Deletes a merchant-related custom attribute definition from a Square seller account. Deleting a custom attribute definition also deletes the corresponding custom attribute from the merchant. Cannot be undone. Beta in Square’s API; it may change. Risk: destructive · Irreversible
Input Output

merchant.get

customAttributeDefinitions.merchant.get Retrieves a merchant-related custom attribute definition from a Square seller account. Beta in Square’s API; it may change. Risk: read
Input Output

merchant.list

customAttributeDefinitions.merchant.list Lists the merchant-related custom attribute definitions that belong to a Square seller account. Beta in Square’s API; it may change. Risk: read
Input Output

merchant.update

customAttributeDefinitions.merchant.update Updates a merchant-related custom attribute definition for a Square seller account. Use this endpoint to update the following fields: name, description, visibility, or the schema for a Selection data type. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change. Risk: write
Input
Output

Custom Attributes

customer.bulkUpsert

customAttributes.customer.bulkUpsert Creates or updates custom attributes for customer profiles as a bulk operation. Risk: write
Input
Output

customer.delete

customAttributes.customer.delete Deletes a custom attribute associated with a customer profile. Cannot be undone. Risk: destructive · Irreversible
Input Output

customer.get

customAttributes.customer.get Retrieves a custom attribute associated with a customer profile. Risk: read
Input Output

customer.list

customAttributes.customer.list Lists the custom attributes associated with a customer profile. Risk: read
Input Output

customer.upsert

customAttributes.customer.upsert Creates or updates a custom attribute for a customer profile. Pass the same idempotency_key to retry safely. Risk: write
Input
Output

location.bulkDelete

customAttributes.location.bulkDelete Deletes custom attributes for locations as a bulk operation. To delete a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES. Cannot be undone. Beta in Square’s API; it may change. Risk: destructive · Irreversible
Input
Output

location.bulkUpsert

customAttributes.location.bulkUpsert Creates or updates custom attributes for locations as a bulk operation. Use this endpoint to set the value of one or more custom attributes for one or more locations. Beta in Square’s API; it may change. Risk: write
Input
Output

location.delete

customAttributes.location.delete Deletes a custom attribute associated with a location. To delete a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES. Cannot be undone. Beta in Square’s API; it may change. Risk: destructive · Irreversible
Input Output

location.get

customAttributes.location.get Retrieves a custom attribute associated with a location. You can use the with_definition query parameter to also retrieve the custom attribute definition in the same call. Beta in Square’s API; it may change. Risk: read
Input Output

location.list

customAttributes.location.list Lists the custom attributes associated with a location. You can use the with_definitions query parameter to also retrieve custom attribute definitions in the same call. Beta in Square’s API; it may change. Risk: read
Input Output

location.upsert

customAttributes.location.upsert Creates or updates a custom attribute for a location. Use this endpoint to set the value of a custom attribute for a specified location. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change. Risk: write
Input
Output

merchant.bulkDelete

customAttributes.merchant.bulkDelete Deletes custom attributes for a merchant as a bulk operation. To delete a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES. Cannot be undone. Beta in Square’s API; it may change. Risk: destructive · Irreversible
Input
Output

merchant.bulkUpsert

customAttributes.merchant.bulkUpsert Creates or updates custom attributes for a merchant as a bulk operation. Use this endpoint to set the value of one or more custom attributes for a merchant. Beta in Square’s API; it may change. Risk: write
Input
Output

merchant.delete

customAttributes.merchant.delete Deletes a custom attribute associated with a merchant. To delete a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES. Cannot be undone. Beta in Square’s API; it may change. Risk: destructive · Irreversible
Input Output

merchant.get

customAttributes.merchant.get Retrieves a custom attribute associated with a merchant. You can use the with_definition query parameter to also retrieve the custom attribute definition in the same call. Beta in Square’s API; it may change. Risk: read
Input Output

merchant.list

customAttributes.merchant.list Lists the custom attributes associated with a merchant. You can use the with_definitions query parameter to also retrieve custom attribute definitions in the same call. Beta in Square’s API; it may change. Risk: read
Input Output

merchant.upsert

customAttributes.merchant.upsert Creates or updates a custom attribute for a merchant. Use this endpoint to set the value of a custom attribute for a specified merchant. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change. Risk: write
Input
Output

Customer Groups

create

customerGroups.create Creates a new customer group for a business. Pass the same idempotency_key to retry safely. Risk: write
Input
Output

delete

customerGroups.delete Deletes a customer group as identified by the group_id value. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

customerGroups.get Retrieves a specific customer group as identified by the group_id value. Risk: read
Input Output

list

customerGroups.list Retrieves the list of customer groups of a business. Risk: read
Input Output

update

customerGroups.update Updates a customer group as identified by the group_id value. Risk: write
Input
Output

Customers

addGroup

customers.addGroup Adds a group membership to a customer. Risk: write
Input Output

bulkCreate

customers.bulkCreate Creates multiple customer profiles for a business. Risk: write
Input
Output

bulkDelete

customers.bulkDelete Deletes multiple customer profiles. Cannot be undone. Risk: destructive · Irreversible
Input Output

bulkGet

customers.bulkGet Retrieves multiple customer profiles. Risk: read
Input Output

bulkUpdate

customers.bulkUpdate Updates multiple customer profiles. Risk: write
Input
Output

create

customers.create Creates a new customer for a business. Pass the same idempotency_key to retry safely. Risk: write
Input
Output

delete

customers.delete Deletes a customer profile from a business. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

customers.get Returns details for a single customer. Risk: read
Input Output

list

customers.list Lists customer profiles associated with a Square account. Risk: read
Input Output

removeGroup

customers.removeGroup Removes a group membership from a customer. Risk: write
Input An HTTP DELETE, but classified as a write: customers.addGroup puts the customer back in the group. Output

search

customers.search Searches the customer profiles associated with a Square account using one or more supported query filters. Risk: read
Input
Output

update

customers.update Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request. To add or update a field, specify the new value. To remove a field, specify null. Risk: write
Input
Output

Customer Segments

get

customerSegments.get Retrieves a specific customer segment as identified by the segment_id value. Risk: read
Input Output

list

customerSegments.list Retrieves the list of customer segments of a business. Risk: read
Input Output

Disputes

accept

disputes.accept Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and updates the dispute state to ACCEPTED. Moves money. Square takes no idempotency_key here; disputes.get shows whether the dispute is already accepted before you repeat the call. Cannot be undone. Risk: destructive · Irreversible
Input Output

createEvidenceFile

disputes.createEvidenceFile Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats. Requires idempotency_key; pass the same key to retry safely. Risk: write
Input file_base64 is the file; content_type (in the JSON request field) is its MIME type. Sent as multipart: request is a plain form field and the file is in image_file. Output

createEvidenceText

disputes.createEvidenceText Uploads text to use as evidence for a dispute challenge. Requires idempotency_key; pass the same key to retry safely. Risk: write
Input Output

deleteEvidence

disputes.deleteEvidence Removes specified evidence from a dispute. Square does not send the bank any evidence that is removed. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

disputes.get Returns details about a specific dispute. Risk: read
Input Output

getEvidence

disputes.getEvidence Returns the metadata for the evidence specified in the request URL path. Risk: read
Input Output

list

disputes.list Returns a list of disputes associated with a particular account. Risk: read
Input Output

listEvidence

disputes.listEvidence Returns a list of evidence associated with a dispute. Risk: read
Input Output

submitEvidence

disputes.submitEvidence Submits evidence to the cardholder’s bank. Cannot be undone. Risk: destructive · Irreversible
Input Output

Inventory

batchGet

inventory.batchGet Returns current counts for the provided CatalogObjects at the requested Locations. Risk: read
Input Output

get

inventory.get Retrieves the current calculated stock count for a given CatalogObject at a given set of Locations. Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint. Risk: read
Input Output

Invoices

cancel

invoices.cancel Cancels an invoice. The seller cannot collect payments for the canceled invoice. Pass the invoice’s current version; every committed change, including adding or removing an attachment, increments it. Read it with invoices.get. Cannot be undone. Risk: destructive · Irreversible
Input Needs the invoice’s current version from invoices.get; every committed change, including adding or removing an attachment, increments it. Output

create

invoices.create Creates a draft invoice for an order created using the Orders API. Give delivery_method (recommended) or the deprecated request_method on each payment request; the schema does not require delivery_method for that reason. Pass the same idempotency_key to retry safely. Risk: write
Input
Output

createAttachment

invoices.createAttachment Uploads a file and attaches it to an invoice. This endpoint accepts HTTP multipart/form-data file uploads with a JSON request part and a file part. Notifies the customer by email or text message when the invoice’s delivery_method is EMAIL or SMS; the API has no option to skip this. Pass the same idempotency_key to retry safely. Risk: destructive
Input content_type is the file’s MIME type and defaults to image/jpeg. Sent as multipart: request is a plain form field and the file is in image_file. Output

delete

invoices.delete Deletes the specified invoice. When an invoice is deleted, the associated order status changes to CANCELED. If you pass version, it must be the current one; every committed change, including adding or removing an attachment, increments it. Read it with invoices.get. Cannot be undone. Risk: destructive · Irreversible
Input Only a draft invoice can be deleted. version is optional; if you pass it, it must be the current one (read it with invoices.get, since every committed change, including adding or removing an attachment, increments it). Output

deleteAttachment

invoices.deleteAttachment Removes an attachment from an invoice and permanently deletes the file. Attachments can be removed only from invoices in the DRAFT, SCHEDULED, UNPAID, or PARTIALLY_PAID state. Notifies the customer by email or text message when the invoice’s delivery_method is EMAIL or SMS; the API has no option to skip this. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

invoices.get Retrieves an invoice by invoice ID. Risk: read
Input Output

list

invoices.list Returns a list of invoices for a given location. The response is paginated. If truncated, the response includes a cursor that you use in a subsequent request to retrieve the next set of invoices. Risk: read
Input Output

publish

invoices.publish Publishes the specified draft invoice. Sends the invoice to the customer and may charge the card on file; cancel with invoices.cancel. Pass the invoice’s current version; every committed change, including adding or removing an attachment, increments it. Read it with invoices.get. Moves money. Pass the same idempotency_key to retry safely. Risk: destructive
Input Needs the invoice’s current version from invoices.get; every committed change, including adding or removing an attachment, increments it. Square then emails the customer and/or charges the card on file, depending on the invoice. Output

search

invoices.search Searches for invoices from a location specified in the filter. You can optionally specify customers in the filter for whom to retrieve invoices. Risk: read
Input
Output

update

invoices.update Updates an invoice. This endpoint supports sparse updates, so you only need to specify the fields you want to change along with the required version field. Some restrictions apply to updating invoices. Notifies the customer by email or text message when the invoice’s delivery_method is EMAIL or SMS; the API has no option to skip this. Pass the invoice’s current version; every committed change, including adding or removing an attachment, increments it. Read it with invoices.get. Pass the same idempotency_key to retry safely. Risk: destructive
Input Needs the invoice’s current version from invoices.get; every committed change, including adding or removing an attachment, increments it. To remove a payment request or a reminder, send its uid with remove: true (Square’s Update an Invoice guide).
Output

Locations

create

locations.create Creates a location. Creating new locations allows for separate configuration of receipt layouts, item prices, and sales reports. Locations can’t be deleted; deactivate with locations.update. Risk: write
Input Locations can’t be deleted; deactivate one with locations.update.
Output

get

locations.get Retrieves details of a single location. Specify “main” as the location ID to retrieve details of the main location. Risk: read
Input Output

list

locations.list Provides details about all of the seller’s locations, including those with an inactive status. Locations are listed alphabetically by name. Risk: read
Input: empty object Output

update

locations.update Updates a location. Risk: write
Input
Output

Merchants

get

merchants.get Retrieves the Merchant object for the given merchant_id. Risk: read
Input Pass me as merchant_id for the merchant that owns the access token. Output

list

merchants.list Provides details about the merchant associated with a given access token. Risk: read
Input Output

Oauth

getTokenStatus

oauth.getTokenStatus Returns information about an OAuth access token or an application’s personal access token. Risk: read
Input: empty object Reports the scopes and expiry of the access token the plugin is using. Output

Orders

calculate

orders.calculate Enables applications to preview order pricing without creating an order. A fulfillment’s pickup_details, shipment_details or in_store_details is required when its type is PICKUP, SHIPMENT or IN_STORE. A line item modifier’s base_price_money is required for ad hoc modifiers. Beta in Square’s API; it may change. Risk: read
Input
Output

create

orders.create Creates a new order that can include information about products for purchase and settings to apply to the purchase. A fulfillment’s pickup_details, shipment_details or in_store_details is required when its type is PICKUP, SHIPMENT or IN_STORE. A line item modifier’s base_price_money is required for ad hoc modifiers. Pass the same idempotency_key to retry safely. Risk: write
Input
Output

get

orders.get Retrieves an Order by ID. Risk: read
Input Output

pay

orders.pay Pay for an order using one or more approved payments or settle an order with a total of 0. Approved payments for the same order_id that are not listed in payment_ids are canceled. Moves money. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change. Risk: destructive
Input The total of payment_ids must equal the order total. Approved payments that reference this order_id but are not listed in payment_ids are canceled. Output

search

orders.search Search all orders for one or more locations. Orders include all sales, returns, and exchanges regardless of how or when they entered the Square ecosystem (such as Point of Sale, Invoices, and Connect APIs). Risk: read
Input
Output

update

orders.update Updates an open order by adding, replacing, or deleting fields. Orders with a COMPLETED or CANCELED state cannot be updated. Send only the fields to change, plus the order’s current version. A fulfillment’s pickup_details, shipment_details or in_store_details is required when its type is PICKUP, SHIPMENT or IN_STORE. A line item modifier’s base_price_money is required for ad hoc modifiers. Pass the same idempotency_key to retry safely. Beta in Square’s API; it may change. Risk: write
Input
Output

create

paymentLinks.create Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services. A fulfillment’s pickup_details, shipment_details or in_store_details is required when its type is PICKUP, SHIPMENT or IN_STORE. A line item modifier’s base_price_money is required for ad hoc modifiers. Pass the same idempotency_key to retry safely. Risk: write
Input
Output

delete

paymentLinks.delete Deletes a payment link. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

paymentLinks.get Retrieves a payment link. Risk: read
Input Output

list

paymentLinks.list Lists all payment links. Risk: read
Input Output

update

paymentLinks.update Updates a payment link. You can update the payment_link fields such as description, checkout_options, and pre_populated_data. Risk: write
Input
Output

Payments

cancel

payments.cancel Cancels (voids) a payment. You can use this endpoint to cancel a payment with the APPROVED status. Moves money. Square takes no idempotency_key here; payments.get shows whether the payment is already canceled before you repeat the call. Cannot be undone. Risk: destructive · Irreversible
Input Output

cancelByIdempotencyKey

payments.cancelByIdempotencyKey Voids a payment by the idempotency_key of the payments.create call that made it; use when that call’s response was lost. Moves money. Its idempotency_key names the payment to cancel; it does not make this call repeatable. Cannot be undone. Risk: destructive · Irreversible
Input The idempotency_key here names the payment to cancel (the key of the payments.create call that made it). It does not make this call repeatable. Output

complete

payments.complete Completes (captures) a payment. By default, payments are set to complete immediately after they are created. Moves money. Square takes no idempotency_key here; payments.get shows whether the payment is already completed before you repeat the call. Risk: destructive
Input Output

create

payments.create Creates a payment using the provided source. customer_id is required if source_id is a card on file created with the Cards API. Moves money. Pass the same idempotency_key to retry safely. Risk: destructive
Input Pass source_id from Square’s Web Payments SDK, a card on file (cards.create), or in the sandbox the test nonce cnon:card-nonce-ok. The payment completes immediately unless you set autocomplete: false; finish a delayed one with payments.complete.
Output

get

payments.get Retrieves details for a specific payment. Risk: read
Input Output

list

payments.list Retrieves a list of payments taken by the account making the request. Risk: read
Input Output

refund

payments.refund Refunds a payment. You can refund the entire payment amount or a portion of it. You can use this endpoint to refund a card payment or record a refund of a cash or external payment. customer_id is required if destination_id is a card on file created with the Cards API, and is only allowed when unlinked=true. Moves money. Pass the same idempotency_key to retry safely. Cannot be undone. Risk: destructive · Irreversible
Input Pass payment_id and amount_money. A refund cannot be reversed; use a new idempotency_key for a second refund, and the same one to retry the first.
Output

update

payments.update Updates a payment with the APPROVED status. You can update the amount_money and tip_money using this endpoint. Moves money. Pass the same idempotency_key to retry safely. Risk: destructive
Input
Output

Refunds

get

refunds.get Retrieves a specific refund using the refund_id. Risk: read
Input Output

list

refunds.list Retrieves a list of refunds for the account making the request. Risk: read
Input Output

Webhook Event Types

list

webhookEventTypes.list Lists all webhook event types that can be subscribed to. Risk: read
Input Output

Webhook Subscriptions

create

webhookSubscriptions.create Creates a webhook subscription. Pass the same idempotency_key to retry safely. Risk: write
Input
Output

delete

webhookSubscriptions.delete Deletes a webhook subscription. Cannot be undone. Risk: destructive · Irreversible
Input Output

get

webhookSubscriptions.get Retrieves a webhook subscription identified by its ID. Risk: read
Input Output

list

webhookSubscriptions.list Lists all webhook subscriptions owned by your application. Risk: read
Input Output

test

webhookSubscriptions.test Tests a webhook subscription by sending a test event to the notification URL. Risk: destructive
Input Output

update

webhookSubscriptions.update Updates a webhook subscription. Risk: write
Input
Output

updateSignatureKey

webhookSubscriptions.updateSignatureKey Updates a webhook subscription by replacing the existing signature key with a new one. The old signature key stops verifying as soon as the new one is issued. Pass the same idempotency_key to retry safely. Risk: write
Input The old signature key stops verifying as soon as the new one is issued. Output