const v1TransactionsApi = client.v1TransactionsApi;V1TransactionsApi
- List Orders
- Retrieve Order
- Update Order
- List Payments
- Retrieve Payment
- List Refunds
- Create Refund
- List Settlements
- Retrieve Settlement
This endpoint is deprecated.
Provides summary information for a merchant's online store orders.
async listOrders(
locationId: string,
order?: string,
limit?: number,
batchToken?: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<V1Order[]>>| Parameter | Type | Tags | Description |
|---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to list online store orders for. |
order |
string | undefined |
Query, Optional | The order in which payments are listed in the response. |
limit |
number | undefined |
Query, Optional | The maximum number of payments to return in a single response. This value cannot exceed 200. |
batchToken |
string | undefined |
Query, Optional | A pagination cursor to retrieve the next set of results for your original query to the endpoint. |
requestOptions |
RequestOptions | undefined |
Optional | Pass additional request options. |
const locationId = 'location_id4';
const order = 'DESC';
const limit = 172;
const batchToken = 'batch_token2';
try {
const { result, ...httpResponse } = await v1TransactionsApi.listOrders(locationId, order, limit, batchToken);
// Get more response info...
// const { statusCode, headers } = httpResponse;
} catch(error) {
if (error instanceof ApiError) {
const errors = error.result;
// const { statusCode, headers } = error;
}
}This endpoint is deprecated.
Provides comprehensive information for a single online store order, including the order's history.
async retrieveOrder(
locationId: string,
orderId: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<V1Order>>| Parameter | Type | Tags | Description |
|---|---|---|---|
locationId |
string |
Template, Required | The ID of the order's associated location. |
orderId |
string |
Template, Required | The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint |
requestOptions |
RequestOptions | undefined |
Optional | Pass additional request options. |
const locationId = 'location_id4';
const orderId = 'order_id6';
try {
const { result, ...httpResponse } = await v1TransactionsApi.retrieveOrder(locationId, orderId);
// Get more response info...
// const { statusCode, headers } = httpResponse;
} catch(error) {
if (error instanceof ApiError) {
const errors = error.result;
// const { statusCode, headers } = error;
}
}This endpoint is deprecated.
Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:
async updateOrder(
locationId: string,
orderId: string,
body: V1UpdateOrderRequest,
requestOptions?: RequestOptions
): Promise<ApiResponse<V1Order>>| Parameter | Type | Tags | Description |
|---|---|---|---|
locationId |
string |
Template, Required | The ID of the order's associated location. |
orderId |
string |
Template, Required | The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint |
body |
V1UpdateOrderRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
requestOptions |
RequestOptions | undefined |
Optional | Pass additional request options. |
const locationId = 'location_id4';
const orderId = 'order_id6';
const contentType = null;
const body: V1UpdateOrderRequest = {
action: 'REFUND',
};
body.shippedTrackingNumber = 'shipped_tracking_number6';
body.completedNote = 'completed_note6';
body.refundedNote = 'refunded_note0';
body.canceledNote = 'canceled_note4';
try {
const { result, ...httpResponse } = await v1TransactionsApi.updateOrder(locationId, orderId, body);
// Get more response info...
// const { statusCode, headers } = httpResponse;
} catch(error) {
if (error instanceof ApiError) {
const errors = error.result;
// const { statusCode, headers } = error;
}
}This endpoint is deprecated.
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.
async listPayments(
locationId: string,
order?: string,
beginTime?: string,
endTime?: string,
limit?: number,
batchToken?: string,
includePartial?: boolean,
requestOptions?: RequestOptions
): Promise<ApiResponse<V1Payment[]>>| Parameter | Type | Tags | Description |
|---|---|---|---|
locationId |
string |
Template, Required | 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 | undefined |
Query, Optional | The order in which payments are listed in the response. |
beginTime |
string | undefined |
Query, Optional | 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. |
endTime |
string | undefined |
Query, Optional | 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. |
limit |
number | undefined |
Query, Optional | The maximum number of payments to return in a single response. This value cannot exceed 200. |
batchToken |
string | undefined |
Query, Optional | A pagination cursor to retrieve the next set of results for your original query to the endpoint. |
includePartial |
boolean | undefined |
Query, Optional | 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. Default: false |
requestOptions |
RequestOptions | undefined |
Optional | Pass additional request options. |
const locationId = 'location_id4';
const order = 'DESC';
const beginTime = 'begin_time2';
const endTime = 'end_time2';
const limit = 172;
const batchToken = 'batch_token2';
const includePartial = false;
try {
const { result, ...httpResponse } = await v1TransactionsApi.listPayments(locationId, order, beginTime, endTime, limit, batchToken, includePartial);
// Get more response info...
// const { statusCode, headers } = httpResponse;
} catch(error) {
if (error instanceof ApiError) {
const errors = error.result;
// const { statusCode, headers } = error;
}
}This endpoint is deprecated.
Provides comprehensive information for a single payment.
async retrievePayment(
locationId: string,
paymentId: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<V1Payment>>| Parameter | Type | Tags | Description |
|---|---|---|---|
locationId |
string |
Template, Required | The ID of the payment's associated location. |
paymentId |
string |
Template, Required | 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. |
requestOptions |
RequestOptions | undefined |
Optional | Pass additional request options. |
const locationId = 'location_id4';
const paymentId = 'payment_id0';
try {
const { result, ...httpResponse } = await v1TransactionsApi.retrievePayment(locationId, paymentId);
// Get more response info...
// const { statusCode, headers } = httpResponse;
} catch(error) {
if (error instanceof ApiError) {
const errors = error.result;
// const { statusCode, headers } = error;
}
}This endpoint is deprecated.
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.
async listRefunds(
locationId: string,
order?: string,
beginTime?: string,
endTime?: string,
limit?: number,
batchToken?: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<V1Refund[]>>| Parameter | Type | Tags | Description |
|---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to list refunds for. |
order |
string | undefined |
Query, Optional | The order in which payments are listed in the response. |
beginTime |
string | undefined |
Query, Optional | 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. |
endTime |
string | undefined |
Query, Optional | 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. |
limit |
number | undefined |
Query, Optional | 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. |
batchToken |
string | undefined |
Query, Optional | A pagination cursor to retrieve the next set of results for your original query to the endpoint. |
requestOptions |
RequestOptions | undefined |
Optional | Pass additional request options. |
const locationId = 'location_id4';
const order = 'DESC';
const beginTime = 'begin_time2';
const endTime = 'end_time2';
const limit = 172;
const batchToken = 'batch_token2';
try {
const { result, ...httpResponse } = await v1TransactionsApi.listRefunds(locationId, order, beginTime, endTime, limit, batchToken);
// Get more response info...
// const { statusCode, headers } = httpResponse;
} catch(error) {
if (error instanceof ApiError) {
const errors = error.result;
// const { statusCode, headers } = error;
}
}This endpoint is deprecated.
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.
async createRefund(
locationId: string,
body: V1CreateRefundRequest,
requestOptions?: RequestOptions
): Promise<ApiResponse<V1Refund>>| Parameter | Type | Tags | Description |
|---|---|---|---|
locationId |
string |
Template, Required | The ID of the original payment's associated location. |
body |
V1CreateRefundRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
requestOptions |
RequestOptions | undefined |
Optional | Pass additional request options. |
const locationId = 'location_id4';
const contentType = null;
const bodyRefundedMoney: V1Money = {};
bodyRefundedMoney.amount = 222;
bodyRefundedMoney.currencyCode = 'CLF';
const body: V1CreateRefundRequest = {
paymentId: 'payment_id6',
type: 'FULL',
reason: 'reason8',
};
body.refundedMoney = bodyRefundedMoney;
body.requestIdempotenceKey = 'request_idempotence_key2';
try {
const { result, ...httpResponse } = await v1TransactionsApi.createRefund(locationId, body);
// Get more response info...
// const { statusCode, headers } = httpResponse;
} catch(error) {
if (error instanceof ApiError) {
const errors = error.result;
// const { statusCode, headers } = error;
}
}This endpoint is deprecated.
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.
async listSettlements(
locationId: string,
order?: string,
beginTime?: string,
endTime?: string,
limit?: number,
status?: string,
batchToken?: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<V1Settlement[]>>| Parameter | Type | Tags | Description |
|---|---|---|---|
locationId |
string |
Template, Required | The ID of the location to list settlements for. If you specify me, this endpoint returns settlements aggregated from all of the business's locations. |
order |
string | undefined |
Query, Optional | The order in which settlements are listed in the response. |
beginTime |
string | undefined |
Query, Optional | 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. |
endTime |
string | undefined |
Query, Optional | 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. |
limit |
number | undefined |
Query, Optional | The maximum number of settlements to return in a single response. This value cannot exceed 200. |
status |
string | undefined |
Query, Optional | Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). |
batchToken |
string | undefined |
Query, Optional | A pagination cursor to retrieve the next set of results for your original query to the endpoint. |
requestOptions |
RequestOptions | undefined |
Optional | Pass additional request options. |
const locationId = 'location_id4';
const order = 'DESC';
const beginTime = 'begin_time2';
const endTime = 'end_time2';
const limit = 172;
const status = 'SENT';
const batchToken = 'batch_token2';
try {
const { result, ...httpResponse } = await v1TransactionsApi.listSettlements(locationId, order, beginTime, endTime, limit, status, batchToken);
// Get more response info...
// const { statusCode, headers } = httpResponse;
} catch(error) {
if (error instanceof ApiError) {
const errors = error.result;
// const { statusCode, headers } = error;
}
}This endpoint is deprecated.
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.
async retrieveSettlement(
locationId: string,
settlementId: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<V1Settlement>>| Parameter | Type | Tags | Description |
|---|---|---|---|
locationId |
string |
Template, Required | The ID of the settlements's associated location. |
settlementId |
string |
Template, Required | The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint. |
requestOptions |
RequestOptions | undefined |
Optional | Pass additional request options. |
const locationId = 'location_id4';
const settlementId = 'settlement_id0';
try {
const { result, ...httpResponse } = await v1TransactionsApi.retrieveSettlement(locationId, settlementId);
// Get more response info...
// const { statusCode, headers } = httpResponse;
} catch(error) {
if (error instanceof ApiError) {
const errors = error.result;
// const { statusCode, headers } = error;
}
}