Square

Process payments, manage catalog items, and handle orders with the Square API.

Detail	Value
Category	Payments
Base URL	https://connect.squareup.com
Authentication	Bearer Token
Endpoints	6
Connector key	square

Using Square in a workflow

1. Go to Connections and click New Connection.
2. Pick Square from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints

Endpoint	Summary
POST /payments	Create a payment
GET /payments/{payment_id}	Retrieve a payment
GET /payments	List payments
POST /refunds	Refund a payment
GET /customers	List customers
POST /customers	Create a customer

Each endpoint is documented in full below. Use the outline on the right to jump to one.

POST /payments

Create a payment

Detail	Value
Operation ID	payments.createPayment
Method	POST
Path	/payments

Parameters

No parameters.

Request Body

Field	Type
source_id	string
amount_money	object
idempotency_key	string

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Square connection from the Connection dropdown.
3. In the Operation dropdown, select payments.createPayment.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Square API reference.

GET /payments/{payment_id}

Retrieve a payment

Detail	Value
Operation ID	payments.getPayment
Method	GET
Path	/payments/{payment_id}

Parameters

Name	Location	Type	Required
payment_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Square connection from the Connection dropdown.
3. In the Operation dropdown, select payments.getPayment.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Square API reference.

GET /payments

List payments

Detail	Value
Operation ID	payments.listPayments
Method	GET
Path	/payments

Parameters

Name	Location	Type	Required
begin_time	query	string	No
end_time	query	string	No

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Square connection from the Connection dropdown.
3. In the Operation dropdown, select payments.listPayments.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Square API reference.

POST /refunds

Refund a payment

Detail	Value
Operation ID	payments.refundPayment
Method	POST
Path	/refunds

Parameters

No parameters.

Request Body

Field	Type
payment_id	string
amount_money	object
idempotency_key	string

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Square connection from the Connection dropdown.
3. In the Operation dropdown, select payments.refundPayment.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Square API reference.

GET /customers

List customers

Detail	Value
Operation ID	payments.listCustomers
Method	GET
Path	/customers

Parameters

Name	Location	Type	Required
cursor	query	string	No

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Square connection from the Connection dropdown.
3. In the Operation dropdown, select payments.listCustomers.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Square API reference.

POST /customers

Create a customer

Detail	Value
Operation ID	payments.createCustomer
Method	POST
Path	/customers

Parameters

No parameters.

Request Body

Field	Type
given_name	string
email_address	string

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Square connection from the Connection dropdown.
3. In the Operation dropdown, select payments.createCustomer.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Square API reference.