V1 Transactions

$v1TransactionsApi = $client->getV1TransactionsApi();

Class Name

V1TransactionsApi

Methods

List Bank Accounts

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.

function listBankAccounts(string $locationId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`locationId`	`string`	Template, Required	The ID of the location to list bank accounts for.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type V1BankAccount[].

Example Usage

$locationId = 'location_id4';

$apiResponse = $v1TransactionsApi->listBankAccounts($locationId);

if ($apiResponse->isSuccess()) {
    $v1BankAccount = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Retrieve Bank Account

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.

function retrieveBankAccount(string $locationId, string $bankAccountId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`locationId`	`string`	Template, Required	The ID of the bank account's associated location.
`bankAccountId`	`string`	Template, Required	The bank account's Square-issued ID. You obtain this value from Settlement objects returned.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type V1BankAccount.

Example Usage

$locationId = 'location_id4';
$bankAccountId = 'bank_account_id0';

$apiResponse = $v1TransactionsApi->retrieveBankAccount($locationId, $bankAccountId);

if ($apiResponse->isSuccess()) {
    $v1BankAccount = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

List Orders

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

function listOrders(
    string $locationId,
    ?string $order = null,
    ?int $limit = null,
    ?string $batchToken = null
): ApiResponse

Parameters

Parameter	Type	Tags	Description
`locationId`	`string`	Template, Required	The ID of the location to list online store orders for.
`order`	`?string (SortOrder)`	Query, Optional	TThe order in which payments are listed in the response.
`limit`	`?int`	Query, Optional	The maximum number of payments to return in a single response. This value cannot exceed 200.
`batchToken`	`?string`	Query, Optional	A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type V1Order[].

Example Usage

$locationId = 'location_id4';
$order = Models\SortOrder::DESC;
$limit = 172;
$batchToken = 'batch_token2';

$apiResponse = $v1TransactionsApi->listOrders($locationId, $order, $limit, $batchToken);

if ($apiResponse->isSuccess()) {
    $v1Order = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Retrieve Order

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

function retrieveOrder(string $locationId, string $orderId): ApiResponse

Parameters

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

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type V1Order.

Example Usage

$locationId = 'location_id4';
$orderId = 'order_id6';

$apiResponse = $v1TransactionsApi->retrieveOrder($locationId, $orderId);

if ($apiResponse->isSuccess()) {
    $v1Order = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Update Order

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

function updateOrder(string $locationId, string $orderId, V1UpdateOrderRequest $body): ApiResponse

Parameters

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.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type V1Order.

Example Usage

$locationId = 'location_id4';
$orderId = 'order_id6';
$body_action = Models\V1UpdateOrderRequestAction::REFUND;
$body = new Models\V1UpdateOrderRequest(
    $body_action
);
$body->setShippedTrackingNumber('shipped_tracking_number6');
$body->setCompletedNote('completed_note6');
$body->setRefundedNote('refunded_note0');
$body->setCanceledNote('canceled_note4');

$apiResponse = $v1TransactionsApi->updateOrder($locationId, $orderId, $body);

if ($apiResponse->isSuccess()) {
    $v1Order = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

List Payments

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.

function listPayments(
    string $locationId,
    ?string $order = null,
    ?string $beginTime = null,
    ?string $endTime = null,
    ?int $limit = null,
    ?string $batchToken = null,
    ?bool $includePartial = false
): ApiResponse

Parameters

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 (SortOrder)`	Query, Optional	The order in which payments are listed in the response.
`beginTime`	`?string`	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`	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`	`?int`	Query, Optional	The maximum number of payments to return in a single response. This value cannot exceed 200.
`batchToken`	`?string`	Query, Optional	A pagination cursor to retrieve the next set of results for your original query to the endpoint.
`includePartial`	`?bool`	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.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type V1Payment[].

Example Usage

$locationId = 'location_id4';
$order = Models\SortOrder::DESC;
$beginTime = 'begin_time2';
$endTime = 'end_time2';
$limit = 172;
$batchToken = 'batch_token2';
$includePartial = false;

$apiResponse = $v1TransactionsApi->listPayments($locationId, $order, $beginTime, $endTime, $limit, $batchToken, $includePartial);

if ($apiResponse->isSuccess()) {
    $v1Payment = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Retrieve Payment

Provides comprehensive information for a single payment.

function retrievePayment(string $locationId, string $paymentId): ApiResponse

Parameters

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.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type V1Payment.

Example Usage

$locationId = 'location_id4';
$paymentId = 'payment_id0';

$apiResponse = $v1TransactionsApi->retrievePayment($locationId, $paymentId);

if ($apiResponse->isSuccess()) {
    $v1Payment = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

List Refunds

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.

function listRefunds(
    string $locationId,
    ?string $order = null,
    ?string $beginTime = null,
    ?string $endTime = null,
    ?int $limit = null,
    ?string $batchToken = null
): ApiResponse

Parameters

Parameter	Type	Tags	Description
`locationId`	`string`	Template, Required	The ID of the location to list refunds for.
`order`	`?string (SortOrder)`	Query, Optional	TThe order in which payments are listed in the response.
`beginTime`	`?string`	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`	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`	`?int`	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`	Query, Optional	A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type V1Refund[].

Example Usage

$locationId = 'location_id4';
$order = Models\SortOrder::DESC;
$beginTime = 'begin_time2';
$endTime = 'end_time2';
$limit = 172;
$batchToken = 'batch_token2';

$apiResponse = $v1TransactionsApi->listRefunds($locationId, $order, $beginTime, $endTime, $limit, $batchToken);

if ($apiResponse->isSuccess()) {
    $v1Refund = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Create Refund

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.

function createRefund(string $locationId, V1CreateRefundRequest $body): ApiResponse

Parameters

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.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type V1Refund.

Example Usage

$locationId = 'location_id4';
$body_paymentId = 'payment_id6';
$body_type = Models\V1CreateRefundRequestType::FULL;
$body_reason = 'reason8';
$body = new Models\V1CreateRefundRequest(
    $body_paymentId,
    $body_type,
    $body_reason
);
$body->setRefundedMoney(new Models\V1Money);
$body->getRefundedMoney()->setAmount(222);
$body->getRefundedMoney()->setCurrencyCode(Models\Currency::CLF);
$body->setRequestIdempotenceKey('request_idempotence_key2');

$apiResponse = $v1TransactionsApi->createRefund($locationId, $body);

if ($apiResponse->isSuccess()) {
    $v1Refund = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

List Settlements

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.

function listSettlements(
    string $locationId,
    ?string $order = null,
    ?string $beginTime = null,
    ?string $endTime = null,
    ?int $limit = null,
    ?string $status = null,
    ?string $batchToken = null
): ApiResponse

Parameters

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 (SortOrder)`	Query, Optional	The order in which settlements are listed in the response.
`beginTime`	`?string`	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`	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`	`?int`	Query, Optional	The maximum number of settlements to return in a single response. This value cannot exceed 200.
`status`	`?string (V1ListSettlementsRequestStatus)`	Query, Optional	Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED).
`batchToken`	`?string`	Query, Optional	A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type V1Settlement[].

Example Usage

$locationId = 'location_id4';
$order = Models\SortOrder::DESC;
$beginTime = 'begin_time2';
$endTime = 'end_time2';
$limit = 172;
$status = Models\V1ListSettlementsRequestStatus::SENT;
$batchToken = 'batch_token2';

$apiResponse = $v1TransactionsApi->listSettlements($locationId, $order, $beginTime, $endTime, $limit, $status, $batchToken);

if ($apiResponse->isSuccess()) {
    $v1Settlement = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Retrieve Settlement

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.

function retrieveSettlement(string $locationId, string $settlementId): ApiResponse

Parameters

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.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type V1Settlement.

Example Usage

$locationId = 'location_id4';
$settlementId = 'settlement_id0';

$apiResponse = $v1TransactionsApi->retrieveSettlement($locationId, $settlementId);

if ($apiResponse->isSuccess()) {
    $v1Settlement = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

FilesExpand file tree

v1-transactions.md

Latest commit

History

v1-transactions.md

File metadata and controls

V1 Transactions

Class Name

Methods

List Bank Accounts

Parameters

Response Type

Example Usage

Retrieve Bank Account

Parameters

Response Type

Example Usage

List Orders

Parameters

Response Type

Example Usage

Retrieve Order

Parameters

Response Type

Example Usage

Update Order

Parameters

Response Type

Example Usage

List Payments

Parameters

Response Type

Example Usage

Retrieve Payment

Parameters

Response Type

Example Usage

List Refunds

Parameters

Response Type

Example Usage

Create Refund

Parameters

Response Type

Example Usage

List Settlements

Parameters

Response Type

Example Usage

Retrieve Settlement

Parameters

Response Type

Example Usage