Payments

$paymentsApi = $client->getPaymentsApi();

Class Name

PaymentsApi

Methods

List Payments
Create Payment
Cancel Payment by Idempotency Key
Get Payment
Update Payment
Cancel Payment
Complete Payment

List Payments

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,
    ?bool $isOfflinePayment = false,
    ?string $offlineBeginTime = null,
    ?string $offlineEndTime = null
): ApiResponse

Parameters

Parameter	Type	Tags	Description
`beginTime`	`?string`	Query, Optional	Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the `created_at` field for each Payment. Inclusive. Default: The current time minus one year.
`endTime`	`?string`	Query, Optional	Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the `created_at` field for each Payment. Default: The current time.
`sortOrder`	`?string`	Query, Optional	The order in which results are listed by `Payment.created_at`: - `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`
`isOfflinePayment`	`?bool`	Query, Optional	Whether the payment was taken offline or not. Default: `false`
`offlineBeginTime`	`?string`	Query, Optional	Indicates the start of the time range for which to retrieve offline payments, in RFC 3339 format for timestamps. The range is determined using the `offline_payment_details.client_created_at` field for each Payment. If set, payments without a value set in `offline_payment_details.client_created_at` will not be returned. Default: The current time.
`offlineEndTime`	`?string`	Query, Optional	Indicates the end of the time range for which to retrieve offline payments, in RFC 3339 format for timestamps. The range is determined using the `offline_payment_details.client_created_at` field for each Payment. If set, payments without a value set in `offline_payment_details.client_created_at` will not be returned. Default: The current time.

Response Type

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

Example Usage

$isOfflinePayment = false;

$apiResponse = $paymentsApi->listPayments(
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    $isOfflinePayment
);

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

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Create Payment

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

Parameters

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.

Response Type

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

Example Usage

$body = CreatePaymentRequestBuilder::init(
    'ccof:GaJGNaZa8x4OgDJn4GB',
    '7b0f3ec5-086a-4871-8f13-3c81b3875218'
)
    ->amountMoney(
        MoneyBuilder::init()
            ->amount(1000)
            ->currency(Currency::USD)
            ->build()
    )
    ->appFeeMoney(
        MoneyBuilder::init()
            ->amount(10)
            ->currency(Currency::USD)
            ->build()
    )
    ->autocomplete(true)
    ->customerId('W92WH6P11H4Z77CTET0RNTGFW8')
    ->locationId('L88917AVBK2S5')
    ->referenceId('123456')
    ->note('Brief description')
    ->build();

$apiResponse = $paymentsApi->createPayment($body);

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

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Cancel Payment by Idempotency Key

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

Parameters

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.

Response Type

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

Example Usage

$body = CancelPaymentByIdempotencyKeyRequestBuilder::init(
    'a7e36d40-d24b-11e8-b568-0800200c9a66'
)->build();

$apiResponse = $paymentsApi->cancelPaymentByIdempotencyKey($body);

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

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Get Payment

Retrieves details for a specific payment.

function getPayment(string $paymentId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`paymentId`	`string`	Template, Required	A unique ID for the desired payment.

Response Type

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

Example Usage

$paymentId = 'payment_id0';

$apiResponse = $paymentsApi->getPayment($paymentId);

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

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Update Payment

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

Parameters

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.

Response Type

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

Example Usage

$paymentId = 'payment_id0';

$body = UpdatePaymentRequestBuilder::init(
    '956f8b13-e4ec-45d6-85e8-d1d95ef0c5de'
)
    ->payment(
        PaymentBuilder::init()
            ->amountMoney(
                MoneyBuilder::init()
                    ->amount(1000)
                    ->currency(Currency::USD)
                    ->build()
            )
            ->tipMoney(
                MoneyBuilder::init()
                    ->amount(100)
                    ->currency(Currency::USD)
                    ->build()
            )
            ->versionToken('ODhwVQ35xwlzRuoZEwKXucfu7583sPTzK48c5zoGd0g6o')
            ->build()
    )
    ->build();

$apiResponse = $paymentsApi->updatePayment(
    $paymentId,
    $body
);

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

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Cancel Payment

Cancels (voids) a payment. You can use this endpoint to cancel a payment with the APPROVED status.

function cancelPayment(string $paymentId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`paymentId`	`string`	Template, Required	The ID of the payment to cancel.

Response Type

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

Example Usage

$paymentId = 'payment_id0';

$apiResponse = $paymentsApi->cancelPayment($paymentId);

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

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Complete Payment

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

Parameters

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.

Response Type

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

Example Usage

$paymentId = 'payment_id0';

$body = CompletePaymentRequestBuilder::init()->build();

$apiResponse = $paymentsApi->completePayment(
    $paymentId,
    $body
);

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

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

payments.md

payments.md

Payments

Class Name

Methods

List Payments

Parameters

Response Type

Example Usage

Create Payment

Parameters

Response Type

Example Usage

Cancel Payment by Idempotency Key

Parameters

Response Type

Example Usage

Get Payment

Parameters

Response Type

Example Usage

Update Payment

Parameters

Response Type

Example Usage

Cancel Payment

Parameters

Response Type

Example Usage

Complete Payment

Parameters

Response Type

Example Usage

Files

payments.md

Latest commit

History

payments.md

File metadata and controls

Payments

Class Name

Methods

List Payments

Parameters

Response Type

Example Usage

Create Payment

Parameters

Response Type

Example Usage

Cancel Payment by Idempotency Key

Parameters

Response Type

Example Usage

Get Payment

Parameters

Response Type

Example Usage

Update Payment

Parameters

Response Type

Example Usage

Cancel Payment

Parameters

Response Type

Example Usage

Complete Payment

Parameters

Response Type

Example Usage