Square.Connect.Api.V1TransactionsApi

March 13, 2019 · View on GitHub

All URIs are relative to https://connect.squareup.com

Method	HTTP request	Description
CreateRefund	POST /v1/{location_id}/refunds	CreateRefund
ListBankAccounts	GET /v1/{location_id}/bank-accounts	ListBankAccounts
ListOrders	GET /v1/{location_id}/orders	ListOrders
ListPayments	GET /v1/{location_id}/payments	ListPayments
ListRefunds	GET /v1/{location_id}/refunds	ListRefunds
ListSettlements	GET /v1/{location_id}/settlements	ListSettlements
RetrieveBankAccount	GET /v1/{location_id}/bank-accounts/{bank_account_id}	RetrieveBankAccount
RetrieveOrder	GET /v1/{location_id}/orders/{order_id}	RetrieveOrder
RetrievePayment	GET /v1/{location_id}/payments/{payment_id}	RetrievePayment
RetrieveSettlement	GET /v1/{location_id}/settlements/{settlement_id}	RetrieveSettlement
UpdateOrder	PUT /v1/{location_id}/orders/{order_id}	UpdateOrder

CreateRefund

V1Refund CreateRefund (string locationId, V1CreateRefundRequest body)

CreateRefund

Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. You cannot issue a partial refund for a split tender payment. You must instead issue a full or partial refund for a particular tender, by providing the applicable tender id to the V1CreateRefund endpoint. Issuing a full refund for a split tender payment refunds all tenders associated with the payment. Issuing a refund for a card payment is not reversible. For development purposes, you can create fake cash payments in Square Point of Sale and refund them.

Example

using System;
using System.Diagnostics;
using Square.Connect.Api;
using Square.Connect.Client;
using Square.Connect.Model;

namespace Example
{
    public class CreateRefundExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new V1TransactionsApi();
            var locationId = locationId_example;  // string | The ID of the original payment's associated location.
            var body = new V1CreateRefundRequest(); // V1CreateRefundRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

            try
            {
                // CreateRefund
                V1Refund result = apiInstance.CreateRefund(locationId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling V1TransactionsApi.CreateRefund: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
locationId	string	The ID of the original payment's associated location.
body	V1CreateRefundRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

V1Refund

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListBankAccounts

List ListBankAccounts (string locationId)

ListBankAccounts

Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.

Example

using System;
using System.Diagnostics;
using Square.Connect.Api;
using Square.Connect.Client;
using Square.Connect.Model;

namespace Example
{
    public class ListBankAccountsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new V1TransactionsApi();
            var locationId = locationId_example;  // string | The ID of the location to list bank accounts for.

            try
            {
                // ListBankAccounts
                List&lt;V1BankAccount&gt; result = apiInstance.ListBankAccounts(locationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling V1TransactionsApi.ListBankAccounts: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
locationId	string	The ID of the location to list bank accounts for.

Return type

List

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListOrders

List ListOrders (string locationId, string order = null, int? limit = null, string batchToken = null)

ListOrders

Provides summary information for a merchant's online store orders.

Example

using System;
using System.Diagnostics;
using Square.Connect.Api;
using Square.Connect.Client;
using Square.Connect.Model;

namespace Example
{
    public class ListOrdersExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new V1TransactionsApi();
            var locationId = locationId_example;  // string | The ID of the location to list online store orders for.
            var order = order_example;  // string | TThe order in which payments are listed in the response. (optional) 
            var limit = 56;  // int? | The maximum number of payments to return in a single response. This value cannot exceed 200. (optional) 
            var batchToken = batchToken_example;  // string | A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional) 

            try
            {
                // ListOrders
                List&lt;V1Order&gt; result = apiInstance.ListOrders(locationId, order, limit, batchToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling V1TransactionsApi.ListOrders: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
locationId	string	The ID of the location to list online store orders for.
order	string	TThe order in which payments are listed in the response.	[optional]
limit	int?	The maximum number of payments to return in a single response. This value cannot exceed 200.	[optional]
batchToken	string	A pagination cursor to retrieve the next set of results for your original query to the endpoint.	[optional]

Return type

List

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListPayments

List ListPayments (string locationId, string order = null, string beginTime = null, string endTime = null, int? limit = null, string batchToken = null, bool? includePartial = null)

ListPayments

Provides summary information for all payments taken for a given Square account during a date range. Date ranges cannot exceed 1 year in length. See Date ranges for details of inclusive and exclusive dates. Note*: Details for payments processed with Square Point of Sale while in offline mode may not be transmitted to Square for up to 72 hours. Offline payments have a created_at value that reflects the time the payment was originally processed, not the time it was subsequently transmitted to Square. Consequently, the ListPayments endpoint might list an offline payment chronologically between online payments that were seen in a previous request.

Example

using System;
using System.Diagnostics;
using Square.Connect.Api;
using Square.Connect.Client;
using Square.Connect.Model;

namespace Example
{
    public class ListPaymentsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new V1TransactionsApi();
            var locationId = locationId_example;  // string | The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations.
            var order = order_example;  // string | The order in which payments are listed in the response. (optional) 
            var beginTime = beginTime_example;  // string | The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. (optional) 
            var endTime = endTime_example;  // string | The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. (optional) 
            var limit = 56;  // int? | The maximum number of payments to return in a single response. This value cannot exceed 200. (optional) 
            var batchToken = batchToken_example;  // string | A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional) 
            var includePartial = true;  // bool? | Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed. (optional) 

            try
            {
                // ListPayments
                List&lt;V1Payment&gt; result = apiInstance.ListPayments(locationId, order, beginTime, endTime, limit, batchToken, includePartial);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling V1TransactionsApi.ListPayments: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
locationId	string	The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations.
order	string	The order in which payments are listed in the response.	[optional]
beginTime	string	The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.	[optional]
endTime	string	The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.	[optional]
limit	int?	The maximum number of payments to return in a single response. This value cannot exceed 200.	[optional]
batchToken	string	A pagination cursor to retrieve the next set of results for your original query to the endpoint.	[optional]
includePartial	bool?	Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed.	[optional]

Return type

List

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListRefunds

List ListRefunds (string locationId, string order = null, string beginTime = null, string endTime = null, int? limit = null, string batchToken = null)

ListRefunds

Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length.

Example

using System;
using System.Diagnostics;
using Square.Connect.Api;
using Square.Connect.Client;
using Square.Connect.Model;

namespace Example
{
    public class ListRefundsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new V1TransactionsApi();
            var locationId = locationId_example;  // string | The ID of the location to list refunds for.
            var order = order_example;  // string | TThe order in which payments are listed in the response. (optional) 
            var beginTime = beginTime_example;  // string | The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. (optional) 
            var endTime = endTime_example;  // string | The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. (optional) 
            var limit = 56;  // int? | The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods. (optional) 
            var batchToken = batchToken_example;  // string | A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional) 

            try
            {
                // ListRefunds
                List&lt;V1Refund&gt; result = apiInstance.ListRefunds(locationId, order, beginTime, endTime, limit, batchToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling V1TransactionsApi.ListRefunds: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
locationId	string	The ID of the location to list refunds for.
order	string	TThe order in which payments are listed in the response.	[optional]
beginTime	string	The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.	[optional]
endTime	string	The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.	[optional]
limit	int?	The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods.	[optional]
batchToken	string	A pagination cursor to retrieve the next set of results for your original query to the endpoint.	[optional]

Return type

List

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListSettlements

List ListSettlements (string locationId, string order = null, string beginTime = null, string endTime = null, int? limit = null, string status = null, string batchToken = null)

ListSettlements

Provides summary information for all deposits and withdrawals initiated by Square to a linked bank account during a date range. Date ranges cannot exceed one year in length. Note*: the ListSettlements endpoint does not provide entry information.

Example

using System;
using System.Diagnostics;
using Square.Connect.Api;
using Square.Connect.Client;
using Square.Connect.Model;

namespace Example
{
    public class ListSettlementsExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new V1TransactionsApi();
            var locationId = locationId_example;  // string | The ID of the location to list settlements for. If you specify me, this endpoint returns payments aggregated from all of the business's locations.
            var order = order_example;  // string | TThe order in which payments are listed in the response. (optional) 
            var beginTime = beginTime_example;  // string | The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. (optional) 
            var endTime = endTime_example;  // string | The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. (optional) 
            var limit = 56;  // int? | The maximum number of payments to return in a single response. This value cannot exceed 200. (optional) 
            var status = status_example;  // string | Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). (optional) 
            var batchToken = batchToken_example;  // string | A pagination cursor to retrieve the next set of results for your original query to the endpoint. (optional) 

            try
            {
                // ListSettlements
                List&lt;V1Settlement&gt; result = apiInstance.ListSettlements(locationId, order, beginTime, endTime, limit, status, batchToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling V1TransactionsApi.ListSettlements: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
locationId	string	The ID of the location to list settlements for. If you specify me, this endpoint returns payments aggregated from all of the business's locations.
order	string	TThe order in which payments are listed in the response.	[optional]
beginTime	string	The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year.	[optional]
endTime	string	The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time.	[optional]
limit	int?	The maximum number of payments to return in a single response. This value cannot exceed 200.	[optional]
status	string	Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).	[optional]
batchToken	string	A pagination cursor to retrieve the next set of results for your original query to the endpoint.	[optional]

Return type

List

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetrieveBankAccount

V1BankAccount RetrieveBankAccount (string locationId, string bankAccountId)

RetrieveBankAccount

Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.

Example

using System;
using System.Diagnostics;
using Square.Connect.Api;
using Square.Connect.Client;
using Square.Connect.Model;

namespace Example
{
    public class RetrieveBankAccountExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new V1TransactionsApi();
            var locationId = locationId_example;  // string | The ID of the bank account's associated location.
            var bankAccountId = bankAccountId_example;  // string | The bank account's Square-issued ID. You obtain this value from Settlement objects returned.

            try
            {
                // RetrieveBankAccount
                V1BankAccount result = apiInstance.RetrieveBankAccount(locationId, bankAccountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling V1TransactionsApi.RetrieveBankAccount: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
locationId	string	The ID of the bank account's associated location.
bankAccountId	string	The bank account's Square-issued ID. You obtain this value from Settlement objects returned.

Return type

V1BankAccount

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetrieveOrder

V1Order RetrieveOrder (string locationId, string orderId)

RetrieveOrder

Provides comprehensive information for a single online store order, including the order's history.

Example

using System;
using System.Diagnostics;
using Square.Connect.Api;
using Square.Connect.Client;
using Square.Connect.Model;

namespace Example
{
    public class RetrieveOrderExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new V1TransactionsApi();
            var locationId = locationId_example;  // string | The ID of the order's associated location.
            var orderId = orderId_example;  // string | The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint

            try
            {
                // RetrieveOrder
                V1Order result = apiInstance.RetrieveOrder(locationId, orderId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling V1TransactionsApi.RetrieveOrder: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
locationId	string	The ID of the order's associated location.
orderId	string	The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint

Return type

V1Order

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetrievePayment

V1Payment RetrievePayment (string locationId, string paymentId)

RetrievePayment

Provides comprehensive information for a single payment.

Example

using System;
using System.Diagnostics;
using Square.Connect.Api;
using Square.Connect.Client;
using Square.Connect.Model;

namespace Example
{
    public class RetrievePaymentExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new V1TransactionsApi();
            var locationId = locationId_example;  // string | The ID of the payment's associated location.
            var paymentId = paymentId_example;  // string | The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint.

            try
            {
                // RetrievePayment
                V1Payment result = apiInstance.RetrievePayment(locationId, paymentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling V1TransactionsApi.RetrievePayment: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
locationId	string	The ID of the payment's associated location.
paymentId	string	The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint.

Return type

V1Payment

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetrieveSettlement

V1Settlement RetrieveSettlement (string locationId, string settlementId)

RetrieveSettlement

Provides comprehensive information for a single settlement. The returned Settlement objects include an entries field that lists the transactions that contribute to the settlement total. Most settlement entries correspond to a payment payout, but settlement entries are also generated for less common events, like refunds, manual adjustments, or chargeback holds. Square initiates its regular deposits as indicated in the Deposit Options with Square help article. Details for a regular deposit are usually not available from Connect API endpoints before 10 p.m. PST the same day. Square does not know when an initiated settlement completes, only whether it has failed. A completed settlement is typically reflected in a bank account within 3 business days, but in exceptional cases it may take longer.

Example

using System;
using System.Diagnostics;
using Square.Connect.Api;
using Square.Connect.Client;
using Square.Connect.Model;

namespace Example
{
    public class RetrieveSettlementExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new V1TransactionsApi();
            var locationId = locationId_example;  // string | The ID of the settlements's associated location.
            var settlementId = settlementId_example;  // string | The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint.

            try
            {
                // RetrieveSettlement
                V1Settlement result = apiInstance.RetrieveSettlement(locationId, settlementId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling V1TransactionsApi.RetrieveSettlement: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
locationId	string	The ID of the settlements's associated location.
settlementId	string	The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint.

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateOrder

V1Order UpdateOrder (string locationId, string orderId, V1UpdateOrderRequest body)

UpdateOrder

Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:

Example

using System;
using System.Diagnostics;
using Square.Connect.Api;
using Square.Connect.Client;
using Square.Connect.Model;

namespace Example
{
    public class UpdateOrderExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new V1TransactionsApi();
            var locationId = locationId_example;  // string | The ID of the order's associated location.
            var orderId = orderId_example;  // string | The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint
            var body = new V1UpdateOrderRequest(); // V1UpdateOrderRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

            try
            {
                // UpdateOrder
                V1Order result = apiInstance.UpdateOrder(locationId, orderId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling V1TransactionsApi.UpdateOrder: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
locationId	string	The ID of the order's associated location.
orderId	string	The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint
body	V1UpdateOrderRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]