Square

Connection configuration samples

This section lists the sample values for the various fields that you configure when creating the connection.

OAuth 2.0 - Authorization code connection type

Personal access token connection type

Actions

This section shows how to perform some of the actions in this connector.

CancelPayment action

This action cancels a payment.

Input parameters of the CancelPayment action

For an example about how to configure the CancelPayment action, see Examples.

CompletePayment action

This action completes a payment.

Input parameters of the CompletePayment action

For an example about how to configure the CompletePayment action, see Examples.

CancelPaymentByIdempotencyKey action

This action cancels a payment using its idempotency key.

Input parameters of the CancelPaymentByIdempotencyKey action

For an example about how to configure the CancelPaymentByIdempotencyKey action, see Examples.

CancelInvoice action

This action cancels an invoice.

Input parameters of the CancelInvoice action

For an example about how to configure the CancelInvoice action, see Examples.

PublishInvoice action

This action publishes an invoice.

Input parameters of the PublishInvoice action

For an example about how to configure the PublishInvoice action, see Examples.

DeleteInvoiceAttachment action

This action deletes an invoice attachment.

Input parameters of the DeleteInvoiceAttachment action

For an example about how to configure the DeleteInvoiceAttachment action, see Examples.

CancelSubscriptions action

This action cancels a subscription.

Input parameters of the CancelSubscriptions action

For an example about how to configure the CancelSubscriptions action, see Examples.

Action examples

This section shows how to perform some of the action examples in this connector.

Example - Cancel a payment

1. In the Configure connector task dialog, click Actions.
2. Select the CancelPayment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "PaymentId": "P7eOGiuAYV8CfcLxSXHuUsedBRMZY"
   }
   

If the action is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

[
  {
    "Success": true
  }
]

Example - Complete a payment

1. In the Configure connector task dialog, click Actions.
2. Select the CompletePayment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "PaymentId": "JiZRuypGuu4B7OOoPhL3kYg9YZaZY"
   }
   

If the action is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": true
}] 

Example - Cancel a payment using an idempotency key

1. In the Configure connector task dialog, click Actions.
2. Select the CancelPaymentByIdempotencyKey action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "IdempotencyKey": "8b3e387b-a4d8-480c-a871-1c5fdcfd82cd"
   }
   

If the action is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": true
}]

Example - Cancel an invoice

1. In the Configure connector task dialog, click Actions.
2. Select the CancelInvoice action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
   "InvoiceVersion": "2"
   }
   

If the action is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

[
  {
    "invoice_id": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
    "invoice_version": "3",
    "invoice_location_id": "LSHW80WV4KB06",
    "invoice_order_id": "dfChzstnmPfPGdEIFQ6ulRFdOf4F",
    "invoice_payment_requests_uid": "28ff79b1-16de-4c82-bb88-3f4e02be68c5",
    "invoice_payment_requests_request_type": "BALANCE",
    "invoice_payment_requests_due_date": "2025-11-26",
    "invoice_payment_requests_tipping_enabled": "true",
    "invoice_payment_requests_computed_amount_money_amount": "60",
    "invoice_payment_requests_computed_amount_money_currency": "USD",
    "invoice_payment_requests_total_completed_amount_money_amount": "0",
    "invoice_payment_requests_total_completed_amount_money_currency": "USD",
    "invoice_payment_requests_reminders_uid": "ae64a254-d516-4014-aea2-5fee42ec7457",
    "invoice_payment_requests_reminders_relative_scheduled_days": "1",
    "invoice_payment_requests_reminders_message": "Your invoice is almost due",
    "invoice_payment_requests_reminders_status": "NOT_APPLICABLE",
    "invoice_payment_requests_automatic_payment_source": "NONE",
    "invoice_primary_recipient_customer_id": "5BH2SYXX0G87A7NBYZKKJJTDVG",
    "invoice_primary_recipient_given_name": "Postman",
    "invoice_primary_recipient_family_name": "Test",
    "invoice_primary_recipient_email_address": "Charlie.Cruz@altostrat.com",
    "invoice_primary_recipient_phone_number": "1-212-555-4240",
    "invoice_primary_recipient_company_name": "Square",
    "invoice_primary_recipient_address_address_line_1": "500 Electric Ave",
    "invoice_primary_recipient_address_address_line_2": "Suite 600",
    "invoice_primary_recipient_address_locality": "New York",
    "invoice_primary_recipient_address_administrative_district_level_1": "NY",
    "invoice_primary_recipient_address_postal_code": "10003",
    "invoice_primary_recipient_address_country": "US",
    "invoice_invoice_number": "00000001",
    "invoice_title": "Invoice Update",
    "invoice_description": "Updating invoice",
    "invoice_public_url": "https://app.squareupsandbox.com/pay-invoice/invtmp:8779596a-2c13-4cf0-ab21-05eb6a1d03ef",
    "invoice_status": "CANCELED",
    "invoice_timezone": "UTC",
    "invoice_created_at": "2025-06-11T09:19:10Z",
    "invoice_updated_at": "2025-06-11T09:57:24Z",
    "invoice_accepted_payment_methods_card": "true",
    "invoice_accepted_payment_methods_square_gift_card": "true",
    "invoice_accepted_payment_methods_bank_account": "true",
    "invoice_accepted_payment_methods_buy_now_pay_later": "true",
    "invoice_accepted_payment_methods_cash_app_pay": "true",
    "invoice_delivery_method": "EMAIL",
    "invoice_store_payment_method_enabled": "true",
    "success": true
  }
]

Example - Publish an invoice

1. In the Configure connector task dialog, click Actions.
2. Select the PublishInvoice action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "InvoiceId": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
     "InvoiceVersion": 1
   }
   

If the action is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

[
  {
    "invoice_id": "inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO",
    "invoice_version": "2",
    "invoice_location_id": "LSHW80WV4KB06",
    "invoice_order_id": "dfChzstnmPfPGdEIFQ6ulRFdOf4F",
    "invoice_payment_requests_uid": "28ff79b1-16de-4c82-bb88-3f4e02be68c5",
    "invoice_payment_requests_request_type": "BALANCE",
    "invoice_payment_requests_due_date": "2025-11-26",
    "invoice_payment_requests_tipping_enabled": "true",
    "invoice_payment_requests_computed_amount_money_amount": "60",
    "invoice_payment_requests_computed_amount_money_currency": "USD",
    "invoice_payment_requests_total_completed_amount_money_amount": "0",
    "invoice_payment_requests_total_completed_amount_money_currency": "USD",
    "invoice_payment_requests_reminders_uid": "ae64a254-d516-4014-aea2-5fee42ec7457",
    "invoice_payment_requests_reminders_relative_scheduled_days": "1",
    "invoice_payment_requests_reminders_message": "Your invoice is almost due",
    "invoice_payment_requests_reminders_status": "PENDING",
    "invoice_payment_requests_automatic_payment_source": "NONE",
    "invoice_primary_recipient_customer_id": "5BH2SYXX0G87A7NBYZKKJJTDVG",
    "invoice_primary_recipient_given_name": "Postman",
    "invoice_primary_recipient_family_name": "Test",
    "invoice_primary_recipient_email_address": "Charlie.Cruz@altostrat.com",
    "invoice_primary_recipient_phone_number": "1-212-555-4240",
    "invoice_primary_recipient_company_name": "Square",
    "invoice_primary_recipient_address_address_line_1": "500 Electric Ave",
    "invoice_primary_recipient_address_address_line_2": "Suite 600",
    "invoice_primary_recipient_address_locality": "New York",
    "invoice_primary_recipient_address_administrative_district_level_1": "NY",
    "invoice_primary_recipient_address_postal_code": "10003",
    "invoice_primary_recipient_address_country": "US",
    "invoice_invoice_number": "00000001",
    "invoice_title": "Invoice Update",
    "invoice_description": "Updating invoice",
    "invoice_public_url": "https://app.squareupsandbox.com/pay-invoice/invtmp:8779596a-2c13-4cf0-ab21-05eb6a1d03ef",
    "invoice_next_payment_amount_money_amount": "60",
    "invoice_next_payment_amount_money_currency": "USD",
    "invoice_status": "UNPAID",
    "invoice_timezone": "UTC",
    "invoice_created_at": "2025-06-11T09:19:10Z",
    "invoice_updated_at": "2025-06-11T09:52:13Z",
    "invoice_accepted_payment_methods_card": "true",
    "invoice_accepted_payment_methods_square_gift_card": "true",
    "invoice_accepted_payment_methods_bank_account": "true",
    "invoice_accepted_payment_methods_buy_now_pay_later": "true",
    "invoice_accepted_payment_methods_cash_app_pay": "true",
    "invoice_delivery_method": "EMAIL",
    "invoice_store_payment_method_enabled": "true",
    "success": true
  }
]

Example - Delete an invoice attachment

1. In the Configure connector task dialog, click Actions.
2. Select the DeleteInvoiceAttachment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "InvoiceId": "inv:0-ChBGMewfnhndQBmYdpW0sp3uEPgO",
     "AttachmentId": "inva:0-ChBsWWogZxWt0bRCqCdHkJJO"
   }
   

If the action is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": true
}]

Example - Cancel a subscription

1. In the Configure connector task dialog, click Actions.
2. Select the CancelSubscriptions action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
   }
   

If the action is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": true,
"Status": "CANCELED"

}]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all the payments

1. In the Configure connector task dialog, click Entities.
2. Select Payments from the Entity list.
3. Select the List operation, and then click Done.
4. In the Task Input section of the Connectors task, you can set the filterClause based on your filtering requirements.

You must use single quotes (') to enclose the value for a filterClause. You can use the filterClause to filter records based on the columns.

Example - Get payment details

1. In the Configure connector task dialog, click Entities.
2. Select Payments from the Entity list.
3. Select the Get operation, and then click Done.
4. Set the entityId to "bb4756c7-38c0-426b-97aa-03b6443e7f16" which is the key to be passed.
5. To set the entityId, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "bb4756c7-38c0-426b-97aa-03b6443e7f16" in the Input Value field and choose the entityId as local variable.

The value for entityId must be passed directly, such as "bb4756c7-38c0-426b-97aa-03b6443e7f16". Here, "bb4756c7-38c0-426b-97aa-03b6443e7f16" is the unique primary key value.

If passing a single entityId throws an error due to the presence of two composite keys, you can use the filterClause to pass the value.

Example - Delete a payment

1. In the Configure connector task dialog, click Entities.
2. Select Payments from the Entity list.
3. Select the Delete operation, and then click Done.
4. Set the entityId to "62008bbe-effa-4341-9d29-eac7f67b84fe" which is the key to be passed.
5. To set the entityId, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "62008bbe-effa-4341-9d29-eac7f67b84fe" in the Input Value field and choose the entityId as local variable.

If the entity has two composite business or primary keys, instead of specifying the entityId, you can also set the filterClause to id='62008bbe-effa-4341-9d29-eac7f67b84fe'.

Example - Create a payment

1. In the Configure connector task dialog, click Entities.
2. Select Payments from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId or connectorInputPayload as local variable.

   {
     "ShippingAddressLine1": "Paris",
     "BillingAddressFirstName": "Charlie",
     "SourceId": "cnon:card-nonce-ok",
     "BankName": "Altostrat bank",
     "MoneyAmount": 7,
     "MoneyCurrency": "USD",
     "IdempotencyKey": "ab5c8c43-eaba-474e-935c-268ea3ae453a"
   }
   

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Id": "BY8GnuLixAdrbr93m8nYHDgONxZZY"
   }
   

Example - Create a refund

1. In the Configure connector task dialog, click Entities.
2. Select Refunds from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId or connectorInputPayload as local variable.

   {
     "PaymentId": "50yXsd0oousMgYUv0372RkIdJnRZY",
     "RefundedMoneyAmount": 72,
     "RefundedMoneyCurrency": "USD"
   }
   

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Success": true
   }
   

Example - Create a subscription

1. In the Configure connector task dialog, click Entities.
2. Select Subscriptions from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId or connectorInputPayload as local variable.

   {
     "LocationId": "LSHW80WV4KB06",
     "CustomerId": "TE9VCZMC369HVA2RVBCEKTDQ6G",
     "PlanId": "OEVRZUHD5C42W7VQUT22WURN",
     "Ordinal": 0,
     "OrderTemplateId": "d9ZVzcjiHVc2Ugd0bzlE7yZT9g4F"
   }
   

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Id": "40da986b-08e4-45bf-9ba2-d11cf9f589fb"
   }
   

Example - Create a customer

1. In the Configure connector task dialog, click Entities.
2. Select Customers from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId or connectorInputPayload as local variable.

   {
     "FamilyName": "LastName",
     "GivenName": "FirstName"
   }
   

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Id": "X8883DFR5M4AXGEKRSCFE3F2M9"
   }
   

Example - Create a gift card

1. In the Configure connector task dialog, click Entities.
2. Select GiftCards from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId or connectorInputPayload as local variable.

   
   {
     "Type": "DIGITAL",
     "LocationId": "LSHW80WV4KB06"
   }
   
   

   If the integration is successful, the connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
     "Id": "X8883DFR5M4AXGEKRSCFE3F2M0"
   }
   

Example - Update an invoice

1. In the Configure connector task dialog, click Entities.
2. Select Invoices from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId, connectorInputPayload, or filterClause as local variable.

   {
     "Title": "Invoice Update",
     "Description": "Update Invoice",
     "Version": 0
   }
   

5. Set the entityId in Data Mapper to the entity of the Invoices.
6. To set the entityId, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId, connectorInputPayload, or filterClause as local variable.

   Instead of specifying the entityId, you can also set the filterClause to 'inv:0-ChCdONOpvkOxnZ64VuiDwLQ4EPgO'.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   { }
   

Example - Update a subscription

1. In the Configure connector task dialog, click Entities.
2. Select Subscriptions from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId, connectorInputPayload, or filterClause as local variable.

   {
     "Note": "Update Subscription"
   }
   

5. Set the entityId in Data Mapper to the entity of the Subscriptions.
6. To set the entityId, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId, connectorInputPayload, or filterClause as local variable.

   Instead of specifying the entityId, you can also set the filterClause to '40da986b-08e4-45bf-9ba2-d11cf9f589fb'.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   { }
   

Example - Update payout details

1. In the Configure connector task dialog, click Entities.
2. Select PayOuts from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId, connectorInputPayload, or filterClause as local variable.

   {
     "Version": 1,
     "Description": "Update Payout"
   }
   

5. Set the entityId in Data Mapper to the entity of the PayOuts.
6. To set the entityId, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the entityId, connectorInputPayload, or filterClause as local variable.

   Instead of specifying the entityId, you can also set the filterClause to '181352d9-94ef-4e86-8bb9-e3759472325f'.

   Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

   { }