SquareConnect.TransactionsApi

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

Method	HTTP request	Description
captureTransaction	POST /v2/locations/{location_id}/transactions/{transaction_id}/capture	CaptureTransaction
charge	POST /v2/locations/{location_id}/transactions	Charge
createRefund	POST /v2/locations/{location_id}/transactions/{transaction_id}/refund	CreateRefund
listRefunds	GET /v2/locations/{location_id}/refunds	ListRefunds
listTransactions	GET /v2/locations/{location_id}/transactions	ListTransactions
retrieveTransaction	GET /v2/locations/{location_id}/transactions/{transaction_id}	RetrieveTransaction
voidTransaction	POST /v2/locations/{location_id}/transactions/{transaction_id}/void	VoidTransaction

captureTransaction

Note: This endpoint is deprecated.

CaptureTransactionResponse captureTransaction(locationId, transactionId)

CaptureTransaction

Captures a transaction that was created with the Charge endpoint with a `delay_capture` value of `true`. See Delayed capture transactions for more information.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TransactionsApi();

var locationId = SquareConnect.TransactionsApi.constructFromObject({}); // String | 

var transactionId = SquareConnect.TransactionsApi.constructFromObject({}); // String | 

apiInstance.captureTransaction(locationId, transactionId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
locationId	String
transactionId	String

Return type

CaptureTransactionResponse

Authorization

oauth2

HTTP request headers

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

charge

Note: This endpoint is deprecated.

ChargeResponse charge(locationId, body)

Charge

Charges a card represented by a card nonce or a customer's card on file. Your request to this endpoint must include either: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for Square chargeback protection, you must provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call RetrieveTransaction. See the `processing_fee_money` field of each Tender included in the transaction.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TransactionsApi();

var locationId = SquareConnect.TransactionsApi.constructFromObject({}); // String | The ID of the location to associate the created transaction with.

var body = SquareConnect.TransactionsApi.constructFromObject({}); // ChargeRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

apiInstance.charge(locationId, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
locationId	String	The ID of the location to associate the created transaction with.
body	ChargeRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

ChargeResponse

Authorization

oauth2

HTTP request headers

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

createRefund

Note: This endpoint is deprecated.

CreateRefundResponse createRefund(locationId, transactionId, body)

CreateRefund

Initiates a refund for a previously charged tender. You must issue a refund within 120 days of the associated payment. See this article for more information on refund behavior. NOTE: Card-present transactions with Interac credit cards cannot be refunded using the Connect API. Interac transactions must refunded in-person (e.g., dipping the card using POS app).

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TransactionsApi();

var locationId = SquareConnect.TransactionsApi.constructFromObject({}); // String | The ID of the original transaction's associated location.

var transactionId = SquareConnect.TransactionsApi.constructFromObject({}); // String | The ID of the original transaction that includes the tender to refund.

var body = SquareConnect.TransactionsApi.constructFromObject({}); // CreateRefundRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

apiInstance.createRefund(locationId, transactionId, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description
locationId	String	The ID of the original transaction's associated location.
transactionId	String	The ID of the original transaction that includes the tender to refund.
body	CreateRefundRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

CreateRefundResponse

Authorization

oauth2

HTTP request headers

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

listRefunds

Note: This endpoint is deprecated.

ListRefundsResponse listRefunds(locationId, opts)

ListRefunds

Lists refunds for one of a business's locations. In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square's Point of Sale applications. Refunds with a `status` of `PENDING` are not currently included in this endpoint's response. Max results per page: 50

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TransactionsApi();

var locationId = SquareConnect.TransactionsApi.constructFromObject({}); // String | The ID of the location to list refunds for.

var opts = { 
  'beginTime': SquareConnect.TransactionsApi.constructFromObject({});, // String | The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.
  'endTime': SquareConnect.TransactionsApi.constructFromObject({});, // String | The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time.
  'sortOrder': SquareConnect.TransactionsApi.constructFromObject({});, // String | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC`
  'cursor': SquareConnect.TransactionsApi.constructFromObject({}); // String | 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](#paginatingresults) for more information.
};
apiInstance.listRefunds(locationId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
locationId	String	The ID of the location to list refunds for.
beginTime	String	The beginning of the requested reporting period, in RFC 3339 format. See Date ranges for details on date inclusivity/exclusivity. Default value: The current time minus one year.	[optional]
endTime	String	The end of the requested reporting period, in RFC 3339 format. See Date ranges for details on date inclusivity/exclusivity. Default value: The current time.	[optional]
sortOrder	String	The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`	[optional]
cursor	String	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.	[optional]

Return type

ListRefundsResponse

Authorization

oauth2

HTTP request headers

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

listTransactions

Note: This endpoint is deprecated.

ListTransactionsResponse listTransactions(locationId, opts)

ListTransactions

Lists transactions for a particular location. Transactions include payment information from sales and exchanges and refund information from returns and exchanges. Max results per page: 50

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TransactionsApi();

var locationId = SquareConnect.TransactionsApi.constructFromObject({}); // String | The ID of the location to list transactions for.

var opts = { 
  'beginTime': SquareConnect.TransactionsApi.constructFromObject({});, // String | The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.
  'endTime': SquareConnect.TransactionsApi.constructFromObject({});, // String | The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time.
  'sortOrder': SquareConnect.TransactionsApi.constructFromObject({});, // String | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC`
  'cursor': SquareConnect.TransactionsApi.constructFromObject({}); // String | 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](#paginatingresults) for more information.
};
apiInstance.listTransactions(locationId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
locationId	String	The ID of the location to list transactions for.
beginTime	String	The beginning of the requested reporting period, in RFC 3339 format. See Date ranges for details on date inclusivity/exclusivity. Default value: The current time minus one year.	[optional]
endTime	String	The end of the requested reporting period, in RFC 3339 format. See Date ranges for details on date inclusivity/exclusivity. Default value: The current time.	[optional]
sortOrder	String	The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`	[optional]
cursor	String	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.	[optional]

Return type

ListTransactionsResponse

Authorization

oauth2

HTTP request headers

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

retrieveTransaction

Note: This endpoint is deprecated.

RetrieveTransactionResponse retrieveTransaction(locationId, transactionId)

RetrieveTransaction

Retrieves details for a single transaction.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TransactionsApi();

var locationId = SquareConnect.TransactionsApi.constructFromObject({}); // String | The ID of the transaction's associated location.

var transactionId = SquareConnect.TransactionsApi.constructFromObject({}); // String | The ID of the transaction to retrieve.

apiInstance.retrieveTransaction(locationId, transactionId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
locationId	String	The ID of the transaction's associated location.
transactionId	String	The ID of the transaction to retrieve.

Return type

RetrieveTransactionResponse

Authorization

oauth2

HTTP request headers

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

voidTransaction

Note: This endpoint is deprecated.

VoidTransactionResponse voidTransaction(locationId, transactionId)

VoidTransaction

Cancels a transaction that was created with the Charge endpoint with a `delay_capture` value of `true`. See Delayed capture transactions for more information.

Example

var SquareConnect = require('square-connect');
var defaultClient = SquareConnect.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SquareConnect.TransactionsApi();

var locationId = SquareConnect.TransactionsApi.constructFromObject({}); // String | 

var transactionId = SquareConnect.TransactionsApi.constructFromObject({}); // String | 

apiInstance.voidTransaction(locationId, transactionId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
locationId	String
transactionId	String

Return type

VoidTransactionResponse

Authorization

oauth2

HTTP request headers

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

Files

TransactionsApi.md

Latest commit

History

TransactionsApi.md

File metadata and controls

SquareConnect.TransactionsApi

captureTransaction

Example

Parameters

Return type

Authorization

HTTP request headers

charge

Example

Parameters

Return type

Authorization

HTTP request headers

createRefund

Example

Parameters

Return type

Authorization

HTTP request headers

listRefunds

Example

Parameters

Return type

Authorization

HTTP request headers

listTransactions

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveTransaction

Example

Parameters

Return type

Authorization

HTTP request headers

voidTransaction

Example

Parameters

Return type

Authorization

HTTP request headers