Overview
Configuration is provided for establishing connections with the Square service. The configuration is used in the REST Connection Manager.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Configuration
Base URL address: https://connect.squareup.com/v2
.
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=new Date(response.expires_at).getTime()}}
.The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://docs.connect.squareup.com/api/oauth/.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/locations/{{=parameters.location_id}}/transactions
.
The result is extracted from:{{=response.transactions}}
.Documentation: https://docs.connect.squareup.com/api/connect/v2/#endpoint-listtransactions.
- [Create] action
-
Endpoint URL address:
/locations/{{=item.location_id}}/transactions
.
The result is extracted from:{{=response.transaction}}
.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://docs.connect.squareup.com/api/connect/v2/#endpoint-charge.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/locations/{{=item.location_id}}/transactions/{{=item.id}}/void
.
The action uses POST method.Documentation: https://docs.connect.squareup.com/api/connect/v2/#endpoint-voidtransaction.
- id
A key field. Template: ShortText.
- location_id
Template: ShortText.
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- tenders
A read-only field. Field components:
- An array.
- Contains the following components: id, location_id, transaction_id, created_at, note, amount_money, processing_fee_money, type, card_details, cash_details.
- refunds
A read-only field. Field components:
- An array.
- Contains the following components: id, location_id, transaction_id, tender_id, created_at, reason, amount_money, status, processing_fee_money.
- product
Template: ShortText. A read-only field.
- client_id
Template: ShortText. A read-only field.
- idempotency_key
Template: ShortText.
- amount_money
Template: Money.
- card_nonce
Template: ShortText.
- customer_card_id
Template: ShortText.
- delay_capture
Data type: DT_BOOL
- reference_id
Template: ShortText.
- note
Template: LongText.
- customer_id
Template: ShortText.
- billing_address
Template: Address.
- shipping_address
Template: Address.
- buyer_email_address
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/locations/{{=parameters.location_id}}/refunds
.
The result is extracted from:{{=response.refunds}}
.Documentation: https://docs.connect.squareup.com/api/connect/v2/#endpoint-listrefunds.
- [Create] action
-
Endpoint URL address:
/locations/{{=item.location_id}}/transactions/{{=item.transaction_id}}/refund
.
The result is extracted from:{{=response.refund}}
.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://docs.connect.squareup.com/api/connect/v2/#endpoint-createrefund.
-
application/json:
- id
A key field. Template: ShortText.
- location_id
Template: ShortText.
- transaction_id
Template: ShortText. A read-only field.
- tender_id
Template: ShortText.
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- reason
Template: ShortText.
- amount_money
Template: Money.
- status
Template: ShortText. A read-only field.
- processing_fee_money
Template: Money.
- idempotency_key
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/locations
.
The result is extracted from:{{=response.locations}}
.Documentation: https://docs.connect.squareup.com/api/connect/v2/#endpoint-listlocations.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- address
Template: Address.
- capabilities
Template: LongText.
- timezone
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/customers
.
The result is extracted from:{{=response.customers}}
.Documentation: https://docs.connect.squareup.com/api/connect/v2/#endpoint-listcustomers.
- [Create] action
-
Endpoint URL address:
/customers
.
The result is extracted from:{{=response.customer}}
.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://docs.connect.squareup.com/api/connect/v2/#endpoint-createcustomer.
-
application/json:
- [Update] action
-
Endpoint URL address:
/customers/{{=item.id}}
.
The result is extracted from:.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://docs.connect.squareup.com/api/connect/v2/#endpoint-updatecustomer.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/customers/{{=item.id}}
.
The action uses DELETE method.Documentation: https://docs.connect.squareup.com/api/connect/v2/#endpoint-deletecustomer.
- id
A key field. Template: ShortText.
- created_at
Data type: DT_DBTIMESTAMP A read-only field.
- updated_at
Data type: DT_DBTIMESTAMP A read-only field.
- cards
A read-only field. Field components:
- An array.
- Contains the following components: id, card_brand, last_4, exp_month, exp_year, cardholder_name, billing_address.
- given_name
Template: ShortText.
- family_name
Template: ShortText.
- nickname
Template: ShortText.
- company_name
Template: ShortText.
- email_address
Template: ShortText.
- address
Template: Address.
- phone_number
Template: ShortText.
- reference_id
Template: ShortText.
- preferences
A read-only field. Field components:
- Contains the following components: email_unsubscribed.
- note
Template: LongText.
- [Read] action
-
Endpoint URL address:
/customers/{{=parameters.customer_id}}
.
The result is extracted from:{{response.customer.cards}}
.The action has the following user-defined parameters:
- customer_id: Required. Specifies customer identifier.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
- [Create] action
-
Endpoint URL address:
/customers/{{=item.customer_id}}/cards
.
The result is extracted from:{{=response.card}}
.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://docs.connect.squareup.com/api/connect/v2/#endpoint-createcustomercard.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/customers/{{=item.customer_id}}/cards/{{=item.id}}
.
The action uses DELETE method.Documentation: https://docs.connect.squareup.com/api/connect/v2/#endpoint-deletecustomercard.
- id
Template: ShortText.
- customer_id
Template: ShortText.
- card_brand
Template: ShortText. A read-only field.
- last_4
Template: ShortText. A read-only field.
- exp_month
Data type: DT_I4 A read-only field.
- exp_year
Data type: DT_I4 A read-only field.
- cardholder_name
Template: ShortText.
- billing_address
Template: Address.
- card_nonce
Template: ShortText.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
cursor:
{{=parameters.iterator}}
-
_includeUserParameters:
{{=parameters}}
-
cursor:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- Address
Field components:
-
Uses template:
ShortText
. - Contains the following components: address_line_1, address_line_2, administrative_district_level_1, country, locality, postal_code.
-
Uses template:
- Money
Field components:
-
Uses template:
ShortText
. - Contains the following components: amount, currency.
-
Uses template:
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.