$paymentsApi = $client->getPaymentsApi();
PaymentsApi
- List Payments
- Create Payment
- Cancel Payment by Idempotency Key
- Get Payment
- Update Payment
- Cancel Payment
- Complete Payment
Retrieves a list of payments taken by the account making the request.
Results are eventually consistent, and new payments or changes to payments might take several seconds to appear.
The maximum results per page is 100.
function listPayments(
?string $beginTime = null,
?string $endTime = null,
?string $sortOrder = null,
?string $cursor = null,
?string $locationId = null,
?int $total = null,
?string $last4 = null,
?string $cardBrand = null,
?int $limit = null
): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
beginTime |
?string |
Query, Optional | The timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year. |
endTime |
?string |
Query, Optional | The timestamp for the end of the reporting period, in RFC 3339 format. Default: The current time. |
sortOrder |
?string |
Query, Optional | The order in which results are listed: - ASC - Oldest to newest.- DESC - Newest to oldest (default). |
cursor |
?string |
Query, Optional | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see Pagination. |
locationId |
?string |
Query, Optional | Limit results to the location supplied. By default, results are returned for the default (main) location associated with the seller. |
total |
?int |
Query, Optional | The exact amount in the total_money for a payment. |
last4 |
?string |
Query, Optional | The last four digits of a payment card. |
cardBrand |
?string |
Query, Optional | The brand of the payment card (for example, VISA). |
limit |
?int |
Query, Optional | The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: 100 |
$apiResponse = $paymentsApi->listPayments();
if ($apiResponse->isSuccess()) {
$listPaymentsResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Creates a payment using the provided source. You can use this endpoint
to charge a card (credit/debit card or
Square gift card) or record a payment that the seller received outside of Square
(cash payment from a buyer or a payment that an external entity
processed on behalf of the seller).
The endpoint creates a
Payment
object and returns it in the response.
function createPayment(CreatePaymentRequest $body): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
body |
CreatePaymentRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
$body_sourceId = 'ccof:GaJGNaZa8x4OgDJn4GB';
$body_idempotencyKey = '7b0f3ec5-086a-4871-8f13-3c81b3875218';
$body_amountMoney = new Models\Money;
$body_amountMoney->setAmount(1000);
$body_amountMoney->setCurrency(Models\Currency::USD);
$body = new Models\CreatePaymentRequest(
$body_sourceId,
$body_idempotencyKey,
$body_amountMoney
);
$body->setAppFeeMoney(new Models\Money);
$body->getAppFeeMoney()->setAmount(10);
$body->getAppFeeMoney()->setCurrency(Models\Currency::USD);
$body->setAutocomplete(true);
$body->setCustomerId('W92WH6P11H4Z77CTET0RNTGFW8');
$body->setLocationId('L88917AVBK2S5');
$body->setReferenceId('123456');
$body->setNote('Brief description');
$apiResponse = $paymentsApi->createPayment($body);
if ($apiResponse->isSuccess()) {
$createPaymentResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Cancels (voids) a payment identified by the idempotency key that is specified in the request.
Use this method when the status of a CreatePayment
request is unknown (for example, after you send a
CreatePayment
request, a network error occurs and you do not get a response). In this case, you can
direct Square to cancel the payment using this endpoint. In the request, you provide the same
idempotency key that you provided in your CreatePayment
request that you want to cancel. After
canceling the payment, you can submit your CreatePayment
request again.
Note that if no payment with the specified idempotency key is found, no action is taken and the endpoint returns successfully.
function cancelPaymentByIdempotencyKey(CancelPaymentByIdempotencyKeyRequest $body): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
body |
CancelPaymentByIdempotencyKeyRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
CancelPaymentByIdempotencyKeyResponse
$body_idempotencyKey = 'a7e36d40-d24b-11e8-b568-0800200c9a66';
$body = new Models\CancelPaymentByIdempotencyKeyRequest(
$body_idempotencyKey
);
$apiResponse = $paymentsApi->cancelPaymentByIdempotencyKey($body);
if ($apiResponse->isSuccess()) {
$cancelPaymentByIdempotencyKeyResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Retrieves details for a specific payment.
function getPayment(string $paymentId): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
paymentId |
string |
Template, Required | A unique ID for the desired payment. |
$paymentId = 'payment_id0';
$apiResponse = $paymentsApi->getPayment($paymentId);
if ($apiResponse->isSuccess()) {
$getPaymentResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Updates a payment with the APPROVED status.
You can update the amount_money
and tip_money
using this endpoint.
function updatePayment(string $paymentId, UpdatePaymentRequest $body): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
paymentId |
string |
Template, Required | The ID of the payment to update. |
body |
UpdatePaymentRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
$paymentId = 'payment_id0';
$body_idempotencyKey = '956f8b13-e4ec-45d6-85e8-d1d95ef0c5de';
$body = new Models\UpdatePaymentRequest(
$body_idempotencyKey
);
$body->setPayment(new Models\Payment);
$body->getPayment()->setAmountMoney(new Models\Money);
$body->getPayment()->getAmountMoney()->setAmount(1000);
$body->getPayment()->getAmountMoney()->setCurrency(Models\Currency::USD);
$body->getPayment()->setTipMoney(new Models\Money);
$body->getPayment()->getTipMoney()->setAmount(100);
$body->getPayment()->getTipMoney()->setCurrency(Models\Currency::USD);
$body->getPayment()->setVersionToken('ODhwVQ35xwlzRuoZEwKXucfu7583sPTzK48c5zoGd0g6o');
$apiResponse = $paymentsApi->updatePayment($paymentId, $body);
if ($apiResponse->isSuccess()) {
$updatePaymentResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Cancels (voids) a payment. You can use this endpoint to cancel a payment with
the APPROVED status
.
function cancelPayment(string $paymentId): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
paymentId |
string |
Template, Required | The ID of the payment to cancel. |
$paymentId = 'payment_id0';
$apiResponse = $paymentsApi->cancelPayment($paymentId);
if ($apiResponse->isSuccess()) {
$cancelPaymentResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Completes (captures) a payment. By default, payments are set to complete immediately after they are created.
You can use this endpoint to complete a payment with the APPROVED status
.
function completePayment(string $paymentId, CompletePaymentRequest $body): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
paymentId |
string |
Template, Required | The unique ID identifying the payment to be completed. |
body |
CompletePaymentRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
$paymentId = 'payment_id0';
$body = new Models\CompletePaymentRequest;
$apiResponse = $paymentsApi->completePayment($paymentId, $body);
if ($apiResponse->isSuccess()) {
$completePaymentResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();