square-terminal - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /square-terminal | Type: Application | PCID required: Yes

Tools

Tool	Description
`square_terminal_accept_dispute`	AcceptDispute
`square_terminal_bulk_create_vendors`	BulkCreateVendors
`square_terminal_bulk_retrieve_vendors`	BulkRetrieveVendors
`square_terminal_bulk_update_vendors`	BulkUpdateVendors
`square_terminal_cancel_terminal_action`	CancelTerminalAction
`square_terminal_cancel_terminal_checkout`	CancelTerminalCheckout
`square_terminal_cancel_terminal_refund`	CancelTerminalRefund
`square_terminal_cancel_transfer_order`	CancelTransferOrder
`square_terminal_create_device_code`	CreateDeviceCode
`square_terminal_create_dispute_evidence_file`	CreateDisputeEvidenceFile
`square_terminal_create_dispute_evidence_text`	CreateDisputeEvidenceText
`square_terminal_create_terminal_action`	CreateTerminalAction
`square_terminal_create_terminal_checkout`	CreateTerminalCheckout
`square_terminal_create_terminal_refund`	CreateTerminalRefund
`square_terminal_create_transfer_order`	CreateTransferOrder
`square_terminal_create_vendor`	CreateVendor
`square_terminal_delete_dispute_evidence`	DeleteDisputeEvidence
`square_terminal_delete_transfer_order`	DeleteTransferOrder
`square_terminal_dismiss_terminal_action`	DismissTerminalAction
`square_terminal_dismiss_terminal_checkout`	DismissTerminalCheckout
`square_terminal_dismiss_terminal_refund`	DismissTerminalRefund
`square_terminal_get_action`	GetTerminalAction
`square_terminal_get_checkout`	GetTerminalCheckout
`square_terminal_get_device`	GetDevice
`square_terminal_get_device_code`	GetDeviceCode
`square_terminal_get_refund`	GetTerminalRefund
`square_terminal_list_device_codes`	ListDeviceCodes
`square_terminal_list_devices`	ListDevices
`square_terminal_list_dispute_evidence`	ListDisputeEvidence
`square_terminal_list_disputes`	ListDisputes
`square_terminal_receive_transfer_order`	ReceiveTransferOrder
`square_terminal_retrieve_dispute`	RetrieveDispute
`square_terminal_retrieve_dispute_evidence`	RetrieveDisputeEvidence
`square_terminal_retrieve_transfer_order`	RetrieveTransferOrder
`square_terminal_retrieve_vendor`	RetrieveVendor
`square_terminal_search_terminal_actions`	SearchTerminalActions
`square_terminal_search_terminal_checkouts`	SearchTerminalCheckouts
`square_terminal_search_terminal_refunds`	SearchTerminalRefunds
`square_terminal_search_transfer_orders`	SearchTransferOrders
`square_terminal_search_vendors`	SearchVendors
`square_terminal_start_transfer_order`	StartTransferOrder
`square_terminal_submit_evidence`	SubmitEvidence
`square_terminal_update_transfer_order`	UpdateTransferOrder
`square_terminal_update_vendor`	UpdateVendor

square_terminal_accept_dispute

AcceptDispute Parameters:

Parameter	Type	Required	Default	Description
`dispute_id`	string	Yes	—	The ID of the dispute you want to accept.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dispute_id": {
      "type": "string",
      "description": "The ID of the dispute you want to accept."
    }
  },
  "required": [
    "PCID",
    "dispute_id"
  ]
}

square_terminal_bulk_create_vendors

BulkCreateVendors Parameters:

Parameter	Type	Required	Default	Description
`vendors`	object	Yes	—	Specifies a set of new Vendor objects as represented by a collection of idempotency-key/`Vendor`-object pairs.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "vendors": {
      "type": "object",
      "description": "Specifies a set of new [Vendor](entity:Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs."
    }
  },
  "required": [
    "PCID",
    "vendors"
  ]
}

square_terminal_bulk_retrieve_vendors

BulkRetrieveVendors Parameters:

Parameter	Type	Required	Default	Description
`vendor_ids`	string[]	No	—	IDs of the Vendor objects to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "vendor_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "IDs of the [Vendor](entity:Vendor) objects to retrieve."
    }
  },
  "required": [
    "PCID"
  ]
}

square_terminal_bulk_update_vendors

BulkUpdateVendors Parameters:

Parameter	Type	Required	Default	Description
`vendors`	object	Yes	—	A set of UpdateVendorRequest objects encapsulating to-be-updated Vendor objects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "vendors": {
      "type": "object",
      "description": "A set of [UpdateVendorRequest](entity:UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](entity:Vendor) objects. The set is represented by  a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs."
    }
  },
  "required": [
    "PCID",
    "vendors"
  ]
}

square_terminal_cancel_terminal_action

CancelTerminalAction Parameters:

Parameter	Type	Required	Default	Description
`action_id`	string	Yes	—	Unique ID for the desired `TerminalAction`.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "action_id": {
      "type": "string",
      "description": "Unique ID for the desired `TerminalAction`."
    }
  },
  "required": [
    "PCID",
    "action_id"
  ]
}

square_terminal_cancel_terminal_checkout

CancelTerminalCheckout Parameters:

Parameter	Type	Required	Default	Description
`checkout_id`	string	Yes	—	The unique ID for the desired `TerminalCheckout`.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "checkout_id": {
      "type": "string",
      "description": "The unique ID for the desired `TerminalCheckout`."
    }
  },
  "required": [
    "PCID",
    "checkout_id"
  ]
}

square_terminal_cancel_terminal_refund

CancelTerminalRefund Parameters:

Parameter	Type	Required	Default	Description
`terminal_refund_id`	string	Yes	—	The unique ID for the desired `TerminalRefund`.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "terminal_refund_id": {
      "type": "string",
      "description": "The unique ID for the desired `TerminalRefund`."
    }
  },
  "required": [
    "PCID",
    "terminal_refund_id"
  ]
}

square_terminal_cancel_transfer_order

CancelTransferOrder Parameters:

Parameter	Type	Required	Default	Description
`transfer_order_id`	string	Yes	—	The ID of the transfer order to cancel. Must be in STARTED or PARTIALLY_RECEIVED status.
`idempotency_key`	string	Yes	—	A unique string that identifies this UpdateTransferOrder request. Keys can be any valid string but must be unique for every UpdateTransferOrder request.
`version`	integer	No	—	Version for optimistic concurrency

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "transfer_order_id": {
      "type": "string",
      "description": "The ID of the transfer order to cancel. Must be in STARTED or PARTIALLY_RECEIVED status."
    },
    "idempotency_key": {
      "type": "string",
      "description": "A unique string that identifies this UpdateTransferOrder request. Keys can be any valid string but must be unique for every UpdateTransferOrder request."
    },
    "version": {
      "type": "integer",
      "description": "Version for optimistic concurrency"
    }
  },
  "required": [
    "PCID",
    "transfer_order_id",
    "idempotency_key"
  ]
}

square_terminal_create_device_code

CreateDeviceCode Parameters:

Parameter	Type	Required	Default	Description
`device_code`	object	Yes	—	Device Code
`idempotency_key`	string	Yes	—	A unique string that identifies this CreateDeviceCode request. Keys can be any valid string but must be unique for every CreateDeviceCode request. See Idempotency keys for more information.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "device_code": {
      "type": "object",
      "description": "Device Code",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique id for this device code."
        },
        "name": {
          "type": "string",
          "description": "An optional user-defined name for the device code."
        },
        "code": {
          "type": "string",
          "description": "The unique code that can be used to login."
        },
        "device_id": {
          "type": "string",
          "description": "The unique id of the device that used this code. Populated when the device is paired up."
        },
        "product_type": {
          "type": "string",
          "description": "Product Type",
          "enum": [
            "TERMINAL_API"
          ]
        },
        "location_id": {
          "type": "string",
          "description": "The location assigned to this code."
        },
        "status": {
          "type": "string",
          "description": "DeviceCode.Status enum.",
          "enum": [
            "UNKNOWN",
            "UNPAIRED",
            "PAIRED",
            "EXPIRED"
          ]
        },
        "pair_by": {
          "type": "string",
          "description": "When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format."
        },
        "created_at": {
          "type": "string",
          "description": "When this DeviceCode was created. Timestamp in RFC 3339 format."
        },
        "status_changed_at": {
          "type": "string",
          "description": "When this DeviceCode's status was last changed. Timestamp in RFC 3339 format."
        },
        "paired_at": {
          "type": "string",
          "description": "When this DeviceCode was paired. Timestamp in RFC 3339 format."
        }
      },
      "required": [
        "product_type"
      ]
    },
    "idempotency_key": {
      "type": "string",
      "description": "A unique string that identifies this CreateDeviceCode request. Keys can be any valid string but must be unique for every CreateDeviceCode request.  See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information."
    }
  },
  "required": [
    "PCID",
    "device_code",
    "idempotency_key"
  ]
}

square_terminal_create_dispute_evidence_file

CreateDisputeEvidenceFile Parameters:

Parameter	Type	Required	Default	Description
`dispute_id`	string	Yes	—	The ID of the dispute for which you want to upload evidence.
`image_file`	string	No	—	Image File
`request`	object	No	—	Defines the parameters for a `CreateDisputeEvidenceFile` request.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dispute_id": {
      "type": "string",
      "description": "The ID of the dispute for which you want to upload evidence."
    },
    "image_file": {
      "type": "string",
      "description": "Image File"
    },
    "request": {
      "type": "object",
      "description": "Defines the parameters for a `CreateDisputeEvidenceFile` request.",
      "properties": {
        "idempotency_key": {
          "type": "string",
          "description": "A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency)."
        },
        "evidence_type": {
          "type": "string",
          "description": "The type of the dispute evidence.",
          "enum": [
            "GENERIC_EVIDENCE",
            "ONLINE_OR_APP_ACCESS_LOG",
            "AUTHORIZATION_DOCUMENTATION",
            "CANCELLATION_OR_REFUND_DOCUMENTATION",
            "CARDHOLDER_COMMUNICATION",
            "CARDHOLDER_INFORMATION",
            "PURCHASE_ACKNOWLEDGEMENT",
            "DUPLICATE_CHARGE_DOCUMENTATION",
            "PRODUCT_OR_SERVICE_DESCRIPTION",
            "RECEIPT",
            "SERVICE_RECEIVED_DOCUMENTATION",
            "PROOF_OF_DELIVERY_DOCUMENTATION",
            "RELATED_TRANSACTION_DOCUMENTATION",
            "REBUTTAL_EXPLANATION",
            "TRACKING_NUMBER"
          ]
        },
        "content_type": {
          "type": "string",
          "description": "The MIME type of the uploaded file. The type can be image/heic, image/heif, image/jpeg, application/pdf, image/png, or image/tiff."
        }
      },
      "required": [
        "idempotency_key"
      ]
    }
  },
  "required": [
    "PCID",
    "dispute_id"
  ]
}

square_terminal_create_dispute_evidence_text

CreateDisputeEvidenceText Parameters:

Parameter	Type	Required	Default	Description
`dispute_id`	string	Yes	—	The ID of the dispute for which you want to upload evidence.
`evidence_text`	string	Yes	—	The evidence string.
`evidence_type`	string	No	—	The type of the dispute evidence.
`idempotency_key`	string	Yes	—	A unique key identifying the request. For more information, see Idempotency.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dispute_id": {
      "type": "string",
      "description": "The ID of the dispute for which you want to upload evidence."
    },
    "evidence_text": {
      "type": "string",
      "description": "The evidence string."
    },
    "evidence_type": {
      "type": "string",
      "description": "The type of the dispute evidence.",
      "enum": [
        "GENERIC_EVIDENCE",
        "ONLINE_OR_APP_ACCESS_LOG",
        "AUTHORIZATION_DOCUMENTATION",
        "CANCELLATION_OR_REFUND_DOCUMENTATION",
        "CARDHOLDER_COMMUNICATION",
        "CARDHOLDER_INFORMATION",
        "PURCHASE_ACKNOWLEDGEMENT",
        "DUPLICATE_CHARGE_DOCUMENTATION",
        "PRODUCT_OR_SERVICE_DESCRIPTION",
        "RECEIPT",
        "SERVICE_RECEIVED_DOCUMENTATION",
        "PROOF_OF_DELIVERY_DOCUMENTATION",
        "RELATED_TRANSACTION_DOCUMENTATION",
        "REBUTTAL_EXPLANATION",
        "TRACKING_NUMBER"
      ]
    },
    "idempotency_key": {
      "type": "string",
      "description": "A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency)."
    }
  },
  "required": [
    "PCID",
    "dispute_id",
    "evidence_text",
    "idempotency_key"
  ]
}

square_terminal_create_terminal_action

CreateTerminalAction Parameters:

Parameter	Type	Required	Default	Description
`action`	object	Yes	—	Represents an action processed by the Square Terminal.
`idempotency_key`	string	Yes	—	A unique string that identifies this `CreateAction` request. Keys can be any valid string but must be unique for every `CreateAction` request. See Idempotency keys for more information.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "action": {
      "type": "object",
      "description": "Represents an action processed by the Square Terminal.",
      "properties": {
        "id": {
          "type": "string",
          "description": "A unique ID for this `TerminalAction`."
        },
        "device_id": {
          "type": "string",
          "description": "The unique Id of the device intended for this `TerminalAction`. The Id can be retrieved from /v2/devices api."
        },
        "deadline_duration": {
          "type": "string",
          "description": "The duration as an RFC 3339 duration, after which the action will be automatically canceled. TerminalActions that are `PENDING` will be automatically `CANCELED` and have a cancellation reason of `TIMED_OUT`  Default: 5 minutes from creation  Maximum: 5 minutes"
        },
        "status": {
          "type": "string",
          "description": "The status of the `TerminalAction`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`"
        },
        "cancel_reason": {
          "type": "string",
          "description": "Cancel Reason",
          "enum": [
            "BUYER_CANCELED",
            "SELLER_CANCELED",
            "TIMED_OUT"
          ]
        },
        "created_at": {
          "type": "string",
          "description": "The time when the `TerminalAction` was created as an RFC 3339 timestamp."
        },
        "updated_at": {
          "type": "string",
          "description": "The time when the `TerminalAction` was last updated as an RFC 3339 timestamp."
        },
        "app_id": {
          "type": "string",
          "description": "The ID of the application that created the action."
        },
        "location_id": {
          "type": "string",
          "description": "The location id the action is attached to, if a link can be made."
        },
        "type": {
          "type": "string",
          "description": "Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.",
          "enum": [
            "QR_CODE",
            "PING",
            "SAVE_CARD",
            "SIGNATURE",
            "CONFIRMATION",
            "RECEIPT",
            "DATA_COLLECTION",
            "SELECT"
          ]
        },
        "qr_code_options": {
          "type": "object",
          "description": "Fields to describe the action that displays QR-Codes."
        },
        "save_card_options": {
          "type": "object",
          "description": "Describes save-card action fields."
        },
        "signature_options": {
          "type": "object",
          "description": "Signature Options"
        },
        "confirmation_options": {
          "type": "object",
          "description": "Confirmation Options"
        },
        "receipt_options": {
          "type": "object",
          "description": "Describes receipt action fields."
        },
        "data_collection_options": {
          "type": "object",
          "description": "Data Collection Options"
        },
        "select_options": {
          "type": "object",
          "description": "Select Options"
        },
        "device_metadata": {
          "type": "object",
          "description": "Device Metadata"
        },
        "await_next_action": {
          "type": "boolean",
          "description": "Indicates the action will be linked to another action and requires a waiting dialog to be displayed instead of returning to the idle screen on completion of the action.  Only supported on SIGNATURE, CONFIRMATION, DATA_COLLECTION, and SELECT types."
        },
        "await_next_action_duration": {
          "type": "string",
          "description": "The timeout duration of the waiting dialog as an RFC 3339 duration, after which the waiting dialog will no longer be displayed and the Terminal will return to the idle screen.  Default: 5 minutes from when the waiting dialog is displayed  Maximum: 5 minutes"
        }
      }
    },
    "idempotency_key": {
      "type": "string",
      "description": "A unique string that identifies this `CreateAction` request. Keys can be any valid string but must be unique for every `CreateAction` request.  See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information."
    }
  },
  "required": [
    "PCID",
    "action",
    "idempotency_key"
  ]
}

square_terminal_create_terminal_checkout

CreateTerminalCheckout Parameters:

Parameter	Type	Required	Default	Description
`checkout`	object	Yes	—	Represents a checkout processed by the Square Terminal.
`idempotency_key`	string	Yes	—	A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but must be unique for every `CreateCheckout` request. See Idempotency keys for more information.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "checkout": {
      "type": "object",
      "description": "Represents a checkout processed by the Square Terminal.",
      "properties": {
        "id": {
          "type": "string",
          "description": "A unique ID for this `TerminalCheckout`."
        },
        "amount_money": {
          "type": "object",
          "description": "Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information."
        },
        "reference_id": {
          "type": "string",
          "description": "An optional user-defined reference ID that can be used to associate this `TerminalCheckout` to another entity in an external system. For example, an order ID generated by a third-party shopping cart. The ID is also associated with any payments used to complete the checkout."
        },
        "note": {
          "type": "string",
          "description": "An optional note to associate with the checkout, as well as with any payments used to complete the checkout. Note: maximum 500 characters"
        },
        "order_id": {
          "type": "string",
          "description": "The reference to the Square order ID for the checkout request."
        },
        "payment_options": {
          "type": "object",
          "description": "Payment Options"
        },
        "device_options": {
          "type": "object",
          "description": "Device Options"
        },
        "deadline_duration": {
          "type": "string",
          "description": "An RFC 3339 duration, after which the checkout is automatically canceled. A `TerminalCheckout` that is `PENDING` is automatically `CANCELED` and has a cancellation reason of `TIMED_OUT`.  Default: 5 minutes from creation  Maximum: 5 minutes"
        },
        "status": {
          "type": "string",
          "description": "The status of the `TerminalCheckout`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`"
        },
        "cancel_reason": {
          "type": "string",
          "description": "Cancel Reason",
          "enum": [
            "BUYER_CANCELED",
            "SELLER_CANCELED",
            "TIMED_OUT"
          ]
        },
        "payment_ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of IDs for payments created by this `TerminalCheckout`."
        },
        "created_at": {
          "type": "string",
          "description": "The time when the `TerminalCheckout` was created, as an RFC 3339 timestamp."
        },
        "updated_at": {
          "type": "string",
          "description": "The time when the `TerminalCheckout` was last updated, as an RFC 3339 timestamp."
        },
        "app_id": {
          "type": "string",
          "description": "The ID of the application that created the checkout."
        },
        "location_id": {
          "type": "string",
          "description": "The location of the device where the `TerminalCheckout` was directed."
        },
        "payment_type": {
          "type": "string",
          "description": "Payment Type",
          "enum": [
            "CARD_PRESENT",
            "MANUAL_CARD_ENTRY",
            "FELICA_ID",
            "FELICA_QUICPAY",
            "FELICA_TRANSPORTATION_GROUP",
            "FELICA_ALL",
            "PAYPAY",
            "QR_CODE"
          ]
        },
        "team_member_id": {
          "type": "string",
          "description": "An optional ID of the team member associated with creating the checkout."
        },
        "customer_id": {
          "type": "string",
          "description": "An optional ID of the customer associated with the checkout."
        },
        "app_fee_money": {
          "type": "object",
          "description": "Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information."
        },
        "statement_description_identifier": {
          "type": "string",
          "description": "Optional additional payment information to include on the customer's card statement as part of the statement description. This can be, for example, an invoice number, ticket number, or short description that uniquely identifies the purchase."
        },
        "tip_money": {
          "type": "object",
          "description": "Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information."
        }
      },
      "required": [
        "amount_money",
        "device_options"
      ]
    },
    "idempotency_key": {
      "type": "string",
      "description": "A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but must be unique for every `CreateCheckout` request.  See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information."
    }
  },
  "required": [
    "PCID",
    "checkout",
    "idempotency_key"
  ]
}

square_terminal_create_terminal_refund

CreateTerminalRefund Parameters:

Parameter	Type	Required	Default	Description
`idempotency_key`	string	Yes	—	A unique string that identifies this `CreateRefund` request. Keys can be any valid string but must be unique for every `CreateRefund` request. See Idempotency keys for more information.
`refund`	object	No	—	Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "idempotency_key": {
      "type": "string",
      "description": "A unique string that identifies this `CreateRefund` request. Keys can be any valid string but must be unique for every `CreateRefund` request.  See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information."
    },
    "refund": {
      "type": "object",
      "description": "Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds.",
      "properties": {
        "id": {
          "type": "string",
          "description": "A unique ID for this `TerminalRefund`."
        },
        "refund_id": {
          "type": "string",
          "description": "The reference to the payment refund created by completing this `TerminalRefund`."
        },
        "payment_id": {
          "type": "string",
          "description": "The unique ID of the payment being refunded."
        },
        "order_id": {
          "type": "string",
          "description": "The reference to the Square order ID for the payment identified by the `payment_id`."
        },
        "amount_money": {
          "type": "object",
          "description": "Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information."
        },
        "reason": {
          "type": "string",
          "description": "A description of the reason for the refund."
        },
        "device_id": {
          "type": "string",
          "description": "The unique ID of the device intended for this `TerminalRefund`. The Id can be retrieved from /v2/devices api."
        },
        "deadline_duration": {
          "type": "string",
          "description": "The RFC 3339 duration, after which the refund is automatically canceled. A `TerminalRefund` that is `PENDING` is automatically `CANCELED` and has a cancellation reason of `TIMED_OUT`.  Default: 5 minutes from creation.  Maximum: 5 minutes"
        },
        "status": {
          "type": "string",
          "description": "The status of the `TerminalRefund`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`."
        },
        "cancel_reason": {
          "type": "string",
          "description": "Cancel Reason",
          "enum": [
            "BUYER_CANCELED",
            "SELLER_CANCELED",
            "TIMED_OUT"
          ]
        },
        "created_at": {
          "type": "string",
          "description": "The time when the `TerminalRefund` was created, as an RFC 3339 timestamp."
        },
        "updated_at": {
          "type": "string",
          "description": "The time when the `TerminalRefund` was last updated, as an RFC 3339 timestamp."
        },
        "app_id": {
          "type": "string",
          "description": "The ID of the application that created the refund."
        },
        "location_id": {
          "type": "string",
          "description": "The location of the device where the `TerminalRefund` was directed."
        }
      },
      "required": [
        "payment_id",
        "amount_money",
        "reason",
        "device_id"
      ]
    }
  },
  "required": [
    "PCID",
    "idempotency_key"
  ]
}

square_terminal_create_transfer_order

CreateTransferOrder Parameters:

Parameter	Type	Required	Default	Description
`idempotency_key`	string	Yes	—	A unique string that identifies this CreateTransferOrder request. Keys can be any valid string but must be unique for every CreateTransferOrder request.
`transfer_order`	object	Yes	—	Data for creating a new transfer order to move CatalogItemVariations between Locations. Used with the CreateTransferOrder endpoint.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "idempotency_key": {
      "type": "string",
      "description": "A unique string that identifies this CreateTransferOrder request. Keys can be any valid string but must be unique for every CreateTransferOrder request."
    },
    "transfer_order": {
      "type": "object",
      "description": "Data for creating a new transfer order to move [CatalogItemVariation](entity:CatalogItemVariation)s between [Location](entity:Location)s. Used with the [CreateTransferOrder](api-endpoint:TransferOrders-CreateTransferOrder) endpoint.",
      "properties": {
        "source_location_id": {
          "type": "string",
          "description": "The source [Location](entity:Location) that will send the items. Must be an active location in your Square account with sufficient inventory of the requested items."
        },
        "destination_location_id": {
          "type": "string",
          "description": "The destination [Location](entity:Location) that will receive the items. Must be an active location in your Square account"
        },
        "expected_at": {
          "type": "string",
          "description": "Expected transfer date in RFC 3339 format (e.g. \"2023-10-01T12:00:00Z\")."
        },
        "notes": {
          "type": "string",
          "description": "Optional notes about the transfer"
        },
        "tracking_number": {
          "type": "string",
          "description": "Optional shipment tracking number"
        },
        "created_by_team_member_id": {
          "type": "string",
          "description": "ID of the [TeamMember](entity:TeamMember) creating this transfer order. Used for tracking and auditing purposes."
        },
        "line_items": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "List of [CatalogItemVariation](entity:CatalogItemVariation)s to transfer, including quantities"
        }
      },
      "required": [
        "source_location_id",
        "destination_location_id"
      ]
    }
  },
  "required": [
    "PCID",
    "idempotency_key",
    "transfer_order"
  ]
}

square_terminal_create_vendor

CreateVendor Parameters:

Parameter	Type	Required	Default	Description
`idempotency_key`	string	Yes	—	A client-supplied, universally unique identifier (UUID) to make this CreateVendor call idempotent. See Idempotency in the API Development 101 section for more information.
`vendor`	object	No	—	Represents a supplier to a seller.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "idempotency_key": {
      "type": "string",
      "description": "A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](api-endpoint:Vendors-CreateVendor) call idempotent.  See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more information."
    },
    "vendor": {
      "type": "object",
      "description": "Represents a supplier to a seller.",
      "properties": {
        "id": {
          "type": "string",
          "description": "A unique Square-generated ID for the [Vendor](entity:Vendor). This field is required when attempting to update a [Vendor](entity:Vendor)."
        },
        "created_at": {
          "type": "string",
          "description": "An RFC 3339-formatted timestamp that indicates when the [Vendor](entity:Vendor) was created."
        },
        "updated_at": {
          "type": "string",
          "description": "An RFC 3339-formatted timestamp that indicates when the [Vendor](entity:Vendor) was last updated."
        },
        "name": {
          "type": "string",
          "description": "The name of the [Vendor](entity:Vendor). This field is required when attempting to create or update a [Vendor](entity:Vendor)."
        },
        "address": {
          "type": "object",
          "description": "Represents a postal address in a country.  For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
        },
        "contacts": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The contacts of the [Vendor](entity:Vendor)."
        },
        "account_number": {
          "type": "string",
          "description": "The account number of the [Vendor](entity:Vendor)."
        },
        "note": {
          "type": "string",
          "description": "A note detailing information about the [Vendor](entity:Vendor)."
        },
        "version": {
          "type": "integer",
          "description": "The version of the [Vendor](entity:Vendor)."
        },
        "status": {
          "type": "string",
          "description": "The status of the [Vendor](entity:Vendor), whether a [Vendor](entity:Vendor) is active or inactive.",
          "enum": [
            "ACTIVE",
            "INACTIVE"
          ]
        }
      }
    }
  },
  "required": [
    "PCID",
    "idempotency_key"
  ]
}

square_terminal_delete_dispute_evidence

DeleteDisputeEvidence Parameters:

Parameter	Type	Required	Default	Description
`dispute_id`	string	Yes	—	The ID of the dispute from which you want to remove evidence.
`evidence_id`	string	Yes	—	The ID of the evidence you want to remove.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dispute_id": {
      "type": "string",
      "description": "The ID of the dispute from which you want to remove evidence."
    },
    "evidence_id": {
      "type": "string",
      "description": "The ID of the evidence you want to remove."
    }
  },
  "required": [
    "PCID",
    "dispute_id",
    "evidence_id"
  ]
}

square_terminal_delete_transfer_order

DeleteTransferOrder Parameters:

Parameter	Type	Required	Default	Description
`transfer_order_id`	string	Yes	—	The ID of the transfer order to delete
`version`	integer	No	—	Version for optimistic concurrency

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "transfer_order_id": {
      "type": "string",
      "description": "The ID of the transfer order to delete"
    },
    "version": {
      "type": "integer",
      "description": "Version for optimistic concurrency"
    }
  },
  "required": [
    "PCID",
    "transfer_order_id"
  ]
}

square_terminal_dismiss_terminal_action

DismissTerminalAction Parameters:

Parameter	Type	Required	Default	Description
`action_id`	string	Yes	—	Unique ID for the `TerminalAction` associated with the action to be dismissed.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "action_id": {
      "type": "string",
      "description": "Unique ID for the `TerminalAction` associated with the action to be dismissed."
    }
  },
  "required": [
    "PCID",
    "action_id"
  ]
}

square_terminal_dismiss_terminal_checkout

DismissTerminalCheckout Parameters:

Parameter	Type	Required	Default	Description
`checkout_id`	string	Yes	—	Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "checkout_id": {
      "type": "string",
      "description": "Unique ID for the `TerminalCheckout` associated with the checkout to be dismissed."
    }
  },
  "required": [
    "PCID",
    "checkout_id"
  ]
}

square_terminal_dismiss_terminal_refund

DismissTerminalRefund Parameters:

Parameter	Type	Required	Default	Description
`terminal_refund_id`	string	Yes	—	Unique ID for the `TerminalRefund` associated with the refund to be dismissed.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "terminal_refund_id": {
      "type": "string",
      "description": "Unique ID for the `TerminalRefund` associated with the refund to be dismissed."
    }
  },
  "required": [
    "PCID",
    "terminal_refund_id"
  ]
}

square_terminal_get_action

GetTerminalAction Parameters:

Parameter	Type	Required	Default	Description
`action_id`	string	Yes	—	Unique ID for the desired `TerminalAction`.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "action_id": {
      "type": "string",
      "description": "Unique ID for the desired `TerminalAction`."
    }
  },
  "required": [
    "PCID",
    "action_id"
  ]
}

square_terminal_get_checkout

GetTerminalCheckout Parameters:

Parameter	Type	Required	Default	Description
`checkout_id`	string	Yes	—	The unique ID for the desired `TerminalCheckout`.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "checkout_id": {
      "type": "string",
      "description": "The unique ID for the desired `TerminalCheckout`."
    }
  },
  "required": [
    "PCID",
    "checkout_id"
  ]
}

square_terminal_get_device

GetDevice Parameters:

Parameter	Type	Required	Default	Description
`device_id`	string	Yes	—	The unique ID for the desired `Device`.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "device_id": {
      "type": "string",
      "description": "The unique ID for the desired `Device`."
    }
  },
  "required": [
    "PCID",
    "device_id"
  ]
}

square_terminal_get_device_code

GetDeviceCode Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	The unique identifier for the device code.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The unique identifier for the device code."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

square_terminal_get_refund

GetTerminalRefund Parameters:

Parameter	Type	Required	Default	Description
`terminal_refund_id`	string	Yes	—	The unique ID for the desired `TerminalRefund`.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "terminal_refund_id": {
      "type": "string",
      "description": "The unique ID for the desired `TerminalRefund`."
    }
  },
  "required": [
    "PCID",
    "terminal_refund_id"
  ]
}

square_terminal_list_device_codes

ListDeviceCodes Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See Paginating results for more information.
`location_id`	string	No	—	If specified, only returns DeviceCodes of the specified location. Returns DeviceCodes of all locations if empty.
`product_type`	string	No	—	If specified, only returns DeviceCodes targeting the specified product type. Returns DeviceCodes of all product types if empty.
`status`	string	No	—	If specified, returns DeviceCodes with the specified statuses. Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information."
    },
    "location_id": {
      "type": "string",
      "description": "If specified, only returns DeviceCodes of the specified location. Returns DeviceCodes of all locations if empty."
    },
    "product_type": {
      "type": "string",
      "description": "If specified, only returns DeviceCodes targeting the specified product type. Returns DeviceCodes of all product types if empty.",
      "enum": [
        "TERMINAL_API"
      ]
    },
    "status": {
      "type": "string",
      "description": "If specified, returns DeviceCodes with the specified statuses. Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.",
      "enum": [
        "UNKNOWN",
        "UNPAIRED",
        "PAIRED",
        "EXPIRED"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

square_terminal_list_devices

ListDevices Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	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. See Pagination for more information.
`sort_order`	string	No	—	The order in which results are listed. - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).
`limit`	integer	No	—	The number of results to return in a single page.
`location_id`	string	No	—	If present, only returns devices at the target location.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "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. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information."
    },
    "sort_order": {
      "type": "string",
      "description": "The order in which results are listed. - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).",
      "enum": [
        "DESC",
        "ASC"
      ]
    },
    "limit": {
      "type": "integer",
      "description": "The number of results to return in a single page."
    },
    "location_id": {
      "type": "string",
      "description": "If present, only returns devices at the target location."
    }
  },
  "required": [
    "PCID"
  ]
}

square_terminal_list_dispute_evidence

ListDisputeEvidence Parameters:

Parameter	Type	Required	Default	Description
`dispute_id`	string	Yes	—	The ID of the dispute.
`cursor`	string	No	—	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dispute_id": {
      "type": "string",
      "description": "The ID of the dispute."
    },
    "cursor": {
      "type": "string",
      "description": "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)."
    }
  },
  "required": [
    "PCID",
    "dispute_id"
  ]
}

square_terminal_list_disputes

ListDisputes Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	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.
`states`	string	No	—	The dispute states used to filter the result. If not specified, the endpoint returns all disputes.
`location_id`	string	No	—	The ID of the location for which to return a list of disputes. If not specified, the endpoint returns disputes associated with all locations.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "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)."
    },
    "states": {
      "type": "string",
      "description": "The dispute states used to filter the result. If not specified, the endpoint returns all disputes.",
      "enum": [
        "INQUIRY_EVIDENCE_REQUIRED",
        "INQUIRY_PROCESSING",
        "INQUIRY_CLOSED",
        "EVIDENCE_REQUIRED",
        "PROCESSING",
        "WON",
        "LOST",
        "ACCEPTED"
      ]
    },
    "location_id": {
      "type": "string",
      "description": "The ID of the location for which to return a list of disputes. If not specified, the endpoint returns disputes associated with all locations."
    }
  },
  "required": [
    "PCID"
  ]
}

square_terminal_receive_transfer_order

ReceiveTransferOrder Parameters:

Parameter	Type	Required	Default	Description
`transfer_order_id`	string	Yes	—	The ID of the transfer order to receive items for
`idempotency_key`	string	Yes	—	A unique key to make this request idempotent
`receipt`	object	Yes	—	The goods receipt details for a transfer order. This object represents a single receipt of goods against a transfer order, tracking: - Which CatalogItemVariations were received - Quantities received in good condition - Quantities damaged during transit/handling - Quantities canceled during receipt Multiple goods receipts can be created for a single transfer order to handle: - Partial deliveries - Multiple shipments - Split receipts across different dates - Cancellations of specific quantities Each receipt automatically: - Updates the transfer order status - Adjusts received quantities - Updates inventory levels at both source and destination Locations
`version`	integer	No	—	Version for optimistic concurrency

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "transfer_order_id": {
      "type": "string",
      "description": "The ID of the transfer order to receive items for"
    },
    "idempotency_key": {
      "type": "string",
      "description": "A unique key to make this request idempotent"
    },
    "receipt": {
      "type": "object",
      "description": "The goods receipt details for a transfer order. This object represents a single receipt of goods against a transfer order, tracking:  - Which [CatalogItemVariation](entity:CatalogItemVariation)s were received - Quantities received in good condition - Quantities damaged during transit/handling - Quantities canceled during receipt  Multiple goods receipts can be created for a single transfer order to handle: - Partial deliveries - Multiple shipments - Split receipts across different dates - Cancellations of specific quantities  Each receipt automatically: - Updates the transfer order status - Adjusts received quantities - Updates inventory levels at both source and destination [Location](entity:Location)s",
      "properties": {
        "line_items": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Line items being received. Each line item specifies: - The item being received - Quantity received in good condition - Quantity received damaged - Quantity canceled  Constraints: - Must include at least one line item - Maximum of 1000 line items per receipt - Each line item must reference a valid item from the transfer order - Total of received, damaged, and canceled quantities cannot exceed ordered quantity"
        }
      }
    },
    "version": {
      "type": "integer",
      "description": "Version for optimistic concurrency"
    }
  },
  "required": [
    "PCID",
    "transfer_order_id",
    "idempotency_key",
    "receipt"
  ]
}

square_terminal_retrieve_dispute

RetrieveDispute Parameters:

Parameter	Type	Required	Default	Description
`dispute_id`	string	Yes	—	The ID of the dispute you want more details about.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dispute_id": {
      "type": "string",
      "description": "The ID of the dispute you want more details about."
    }
  },
  "required": [
    "PCID",
    "dispute_id"
  ]
}

square_terminal_retrieve_dispute_evidence

RetrieveDisputeEvidence Parameters:

Parameter	Type	Required	Default	Description
`dispute_id`	string	Yes	—	The ID of the dispute from which you want to retrieve evidence metadata.
`evidence_id`	string	Yes	—	The ID of the evidence to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dispute_id": {
      "type": "string",
      "description": "The ID of the dispute from which you want to retrieve evidence metadata."
    },
    "evidence_id": {
      "type": "string",
      "description": "The ID of the evidence to retrieve."
    }
  },
  "required": [
    "PCID",
    "dispute_id",
    "evidence_id"
  ]
}

square_terminal_retrieve_transfer_order

RetrieveTransferOrder Parameters:

Parameter	Type	Required	Default	Description
`transfer_order_id`	string	Yes	—	The ID of the transfer order to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "transfer_order_id": {
      "type": "string",
      "description": "The ID of the transfer order to retrieve"
    }
  },
  "required": [
    "PCID",
    "transfer_order_id"
  ]
}

square_terminal_retrieve_vendor

RetrieveVendor Parameters:

Parameter	Type	Required	Default	Description
`vendor_id`	string	Yes	—	ID of the Vendor to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "vendor_id": {
      "type": "string",
      "description": "ID of the [Vendor](entity:Vendor) to retrieve."
    }
  },
  "required": [
    "PCID",
    "vendor_id"
  ]
}

square_terminal_search_terminal_actions

SearchTerminalActions Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See Pagination for more information.
`limit`	integer	No	—	Limit the number of results returned for a single request.
`query`	object	No	—	Search query string

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information."
    },
    "limit": {
      "type": "integer",
      "description": "Limit the number of results returned for a single request."
    },
    "query": {
      "type": "object",
      "description": "Search query string",
      "properties": {
        "filter": {
          "type": "object",
          "description": "The filter value"
        },
        "sort": {
          "type": "object",
          "description": "Sort order for results"
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

square_terminal_search_terminal_checkouts

SearchTerminalCheckouts Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	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. See Pagination for more information.
`limit`	integer	No	—	Limits the number of results returned for a single request.
`query`	object	No	—	Search query string

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "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. See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information."
    },
    "limit": {
      "type": "integer",
      "description": "Limits the number of results returned for a single request."
    },
    "query": {
      "type": "object",
      "description": "Search query string",
      "properties": {
        "filter": {
          "type": "object",
          "description": "The filter value"
        },
        "sort": {
          "type": "object",
          "description": "Sort order for results"
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

square_terminal_search_terminal_refunds

SearchTerminalRefunds Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	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.
`limit`	integer	No	—	Limits the number of results returned for a single request.
`query`	object	No	—	Search query string

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "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."
    },
    "limit": {
      "type": "integer",
      "description": "Limits the number of results returned for a single request."
    },
    "query": {
      "type": "object",
      "description": "Search query string",
      "properties": {
        "filter": {
          "type": "object",
          "description": "The filter value"
        },
        "sort": {
          "type": "object",
          "description": "Sort order for results"
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

square_terminal_search_transfer_orders

SearchTransferOrders Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	Pagination cursor from a previous search response
`limit`	integer	No	—	Maximum number of results to return (1-100)
`query`	object	No	—	Query parameters for searching transfer orders

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "Pagination cursor from a previous search response"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of results to return (1-100)"
    },
    "query": {
      "type": "object",
      "description": "Query parameters for searching transfer orders",
      "properties": {
        "filter": {
          "type": "object",
          "description": "Filter criteria for searching transfer orders"
        },
        "sort": {
          "type": "object",
          "description": "Sort configuration for search results"
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

square_terminal_search_vendors

SearchVendors Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the Pagination guide for more information.
`filter`	object	No	—	Defines supported query expressions to search for vendors by.
`sort`	object	No	—	Defines a sorter used to sort results from SearchVendors.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query.  See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information."
    },
    "filter": {
      "type": "object",
      "description": "Defines supported query expressions to search for vendors by.",
      "properties": {
        "name": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The names of the [Vendor](entity:Vendor) objects to retrieve."
        },
        "status": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "INACTIVE"
            ]
          },
          "description": "The statuses of the [Vendor](entity:Vendor) objects to retrieve. See [VendorStatus](#type-vendorstatus) for possible values"
        }
      }
    },
    "sort": {
      "type": "object",
      "description": "Defines a sorter used to sort results from [SearchVendors](api-endpoint:Vendors-SearchVendors).",
      "properties": {
        "field": {
          "type": "string",
          "description": "The field to sort the returned [Vendor](entity:Vendor) objects by.",
          "enum": [
            "NAME",
            "CREATED_AT"
          ]
        },
        "order": {
          "type": "string",
          "description": "The order (e.g., chronological or alphabetical) in which results from a request are returned.",
          "enum": [
            "DESC",
            "ASC"
          ]
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

square_terminal_start_transfer_order

StartTransferOrder Parameters:

Parameter	Type	Required	Default	Description
`transfer_order_id`	string	Yes	—	The ID of the transfer order to start. Must be in DRAFT status.
`idempotency_key`	string	Yes	—	A unique string that identifies this UpdateTransferOrder request. Keys can be any valid string but must be unique for every UpdateTransferOrder request.
`version`	integer	No	—	Version for optimistic concurrency

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "transfer_order_id": {
      "type": "string",
      "description": "The ID of the transfer order to start. Must be in DRAFT status."
    },
    "idempotency_key": {
      "type": "string",
      "description": "A unique string that identifies this UpdateTransferOrder request. Keys can be any valid string but must be unique for every UpdateTransferOrder request."
    },
    "version": {
      "type": "integer",
      "description": "Version for optimistic concurrency"
    }
  },
  "required": [
    "PCID",
    "transfer_order_id",
    "idempotency_key"
  ]
}

square_terminal_submit_evidence

SubmitEvidence Parameters:

Parameter	Type	Required	Default	Description
`dispute_id`	string	Yes	—	The ID of the dispute for which you want to submit evidence.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dispute_id": {
      "type": "string",
      "description": "The ID of the dispute for which you want to submit evidence."
    }
  },
  "required": [
    "PCID",
    "dispute_id"
  ]
}

square_terminal_update_transfer_order

UpdateTransferOrder Parameters:

Parameter	Type	Required	Default	Description
`transfer_order_id`	string	Yes	—	The ID of the transfer order to update
`idempotency_key`	string	Yes	—	A unique string that identifies this UpdateTransferOrder request. Keys must contain only alphanumeric characters, dashes and underscores
`transfer_order`	object	Yes	—	Data model for updating a transfer order. All fields are optional.
`version`	integer	No	—	Version for optimistic concurrency

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "transfer_order_id": {
      "type": "string",
      "description": "The ID of the transfer order to update"
    },
    "idempotency_key": {
      "type": "string",
      "description": "A unique string that identifies this UpdateTransferOrder request. Keys must contain only alphanumeric characters, dashes and underscores"
    },
    "transfer_order": {
      "type": "object",
      "description": "Data model for updating a transfer order. All fields are optional.",
      "properties": {
        "source_location_id": {
          "type": "string",
          "description": "The source [Location](entity:Location) that will send the items. Must be an active location in your Square account with sufficient inventory of the requested items."
        },
        "destination_location_id": {
          "type": "string",
          "description": "The destination [Location](entity:Location) that will receive the items. Must be an active location in your Square account."
        },
        "expected_at": {
          "type": "string",
          "description": "Expected transfer date in RFC 3339 format (e.g. \"2023-10-01T12:00:00Z\")."
        },
        "notes": {
          "type": "string",
          "description": "Optional notes about the transfer"
        },
        "tracking_number": {
          "type": "string",
          "description": "Shipment tracking number"
        },
        "line_items": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "List of items being transferred"
        }
      }
    },
    "version": {
      "type": "integer",
      "description": "Version for optimistic concurrency"
    }
  },
  "required": [
    "PCID",
    "transfer_order_id",
    "idempotency_key",
    "transfer_order"
  ]
}

square_terminal_update_vendor

UpdateVendor Parameters:

Parameter	Type	Required	Default	Description
`idempotency_key`	string	null	No	—	A client-supplied, universally unique identifier (UUID) for the request. See Idempotency in the API Development 101 section for more information.
`vendor`	object	Yes	—	Represents a supplier to a seller.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "idempotency_key": {
      "type": [
        "string",
        "null"
      ],
      "description": "A client-supplied, universally unique identifier (UUID) for the request.  See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the [API Development 101](https://developer.squareup.com/docs/buildbasics) section for more information."
    },
    "vendor": {
      "type": "object",
      "description": "Represents a supplier to a seller.",
      "properties": {
        "id": {
          "type": "string",
          "description": "A unique Square-generated ID for the [Vendor](entity:Vendor). This field is required when attempting to update a [Vendor](entity:Vendor)."
        },
        "created_at": {
          "type": "string",
          "description": "An RFC 3339-formatted timestamp that indicates when the [Vendor](entity:Vendor) was created."
        },
        "updated_at": {
          "type": "string",
          "description": "An RFC 3339-formatted timestamp that indicates when the [Vendor](entity:Vendor) was last updated."
        },
        "name": {
          "type": "string",
          "description": "The name of the [Vendor](entity:Vendor). This field is required when attempting to create or update a [Vendor](entity:Vendor)."
        },
        "address": {
          "type": "object",
          "description": "Represents a postal address in a country.  For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
        },
        "contacts": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The contacts of the [Vendor](entity:Vendor)."
        },
        "account_number": {
          "type": "string",
          "description": "The account number of the [Vendor](entity:Vendor)."
        },
        "note": {
          "type": "string",
          "description": "A note detailing information about the [Vendor](entity:Vendor)."
        },
        "version": {
          "type": "integer",
          "description": "The version of the [Vendor](entity:Vendor)."
        },
        "status": {
          "type": "string",
          "description": "The status of the [Vendor](entity:Vendor), whether a [Vendor](entity:Vendor) is active or inactive.",
          "enum": [
            "ACTIVE",
            "INACTIVE"
          ]
        }
      }
    }
  },
  "required": [
    "PCID",
    "vendor"
  ]
}

​Tools

​square_terminal_accept_dispute

​square_terminal_bulk_create_vendors

​square_terminal_bulk_retrieve_vendors

​square_terminal_bulk_update_vendors

​square_terminal_cancel_terminal_action

​square_terminal_cancel_terminal_checkout

​square_terminal_cancel_terminal_refund

​square_terminal_cancel_transfer_order

​square_terminal_create_device_code

​square_terminal_create_dispute_evidence_file

​square_terminal_create_dispute_evidence_text

​square_terminal_create_terminal_action

​square_terminal_create_terminal_checkout

​square_terminal_create_terminal_refund

​square_terminal_create_transfer_order

​square_terminal_create_vendor

​square_terminal_delete_dispute_evidence

​square_terminal_delete_transfer_order

​square_terminal_dismiss_terminal_action

​square_terminal_dismiss_terminal_checkout

​square_terminal_dismiss_terminal_refund

​square_terminal_get_action

​square_terminal_get_checkout

​square_terminal_get_device

​square_terminal_get_device_code

​square_terminal_get_refund

​square_terminal_list_device_codes

​square_terminal_list_devices

​square_terminal_list_dispute_evidence

​square_terminal_list_disputes

​square_terminal_receive_transfer_order

​square_terminal_retrieve_dispute

​square_terminal_retrieve_dispute_evidence

​square_terminal_retrieve_transfer_order

​square_terminal_retrieve_vendor

​square_terminal_search_terminal_actions

​square_terminal_search_terminal_checkouts

​square_terminal_search_terminal_refunds

​square_terminal_search_transfer_orders

​square_terminal_search_vendors

​square_terminal_start_transfer_order

​square_terminal_submit_evidence

​square_terminal_update_transfer_order

​square_terminal_update_vendor

Tools

square_terminal_accept_dispute

square_terminal_bulk_create_vendors

square_terminal_bulk_retrieve_vendors

square_terminal_bulk_update_vendors

square_terminal_cancel_terminal_action

square_terminal_cancel_terminal_checkout

square_terminal_cancel_terminal_refund

square_terminal_cancel_transfer_order

square_terminal_create_device_code

square_terminal_create_dispute_evidence_file

square_terminal_create_dispute_evidence_text

square_terminal_create_terminal_action

square_terminal_create_terminal_checkout

square_terminal_create_terminal_refund

square_terminal_create_transfer_order

square_terminal_create_vendor

square_terminal_delete_dispute_evidence

square_terminal_delete_transfer_order

square_terminal_dismiss_terminal_action

square_terminal_dismiss_terminal_checkout

square_terminal_dismiss_terminal_refund

square_terminal_get_action

square_terminal_get_checkout

square_terminal_get_device

square_terminal_get_device_code

square_terminal_get_refund

square_terminal_list_device_codes

square_terminal_list_devices

square_terminal_list_dispute_evidence

square_terminal_list_disputes

square_terminal_receive_transfer_order

square_terminal_retrieve_dispute

square_terminal_retrieve_dispute_evidence

square_terminal_retrieve_transfer_order

square_terminal_retrieve_vendor

square_terminal_search_terminal_actions

square_terminal_search_terminal_checkouts

square_terminal_search_terminal_refunds

square_terminal_search_transfer_orders

square_terminal_search_vendors

square_terminal_start_transfer_order

square_terminal_submit_evidence

square_terminal_update_transfer_order

square_terminal_update_vendor