Checkout

$checkoutApi = $client->getCheckoutApi();

Class Name

CheckoutApi

Methods

Create Checkout
Retrieve Location Settings
Update Location Settings
Retrieve Merchant Settings
Update Merchant Settings
List Payment Links
Create Payment Link
Delete Payment Link
Retrieve Payment Link
Update Payment Link

Create Checkout

This endpoint is deprecated.

Links a checkoutId to a checkout_page_url that customers are directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.

NOTE: The Checkout API has been updated with new features. For more information, see Checkout API highlights.

function createCheckout(string $locationId, CreateCheckoutRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
`locationId`	`string`	Template, Required	The ID of the business location to associate the checkout with.
`body`	`CreateCheckoutRequest`	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 CreateCheckoutResponse.

Example Usage

$locationId = 'location_id4';

$body = CreateCheckoutRequestBuilder::init(
    '86ae1696-b1e3-4328-af6d-f1e04d947ad6',
    CreateOrderRequestBuilder::init()
        ->order(
            OrderBuilder::init(
                'location_id'
            )
                ->referenceId('reference_id')
                ->customerId('customer_id')
                ->lineItems(
                    [
                        OrderLineItemBuilder::init(
                            '2'
                        )
                            ->name('Printed T Shirt')
                            ->appliedTaxes(
                                [
                                    OrderLineItemAppliedTaxBuilder::init(
                                        '38ze1696-z1e3-5628-af6d-f1e04d947fg3'
                                    )->build()
                                ]
                            )
                            ->appliedDiscounts(
                                [
                                    OrderLineItemAppliedDiscountBuilder::init(
                                        '56ae1696-z1e3-9328-af6d-f1e04d947gd4'
                                    )->build()
                                ]
                            )
                            ->basePriceMoney(
                                MoneyBuilder::init()
                                    ->amount(1500)
                                    ->currency(Currency::USD)
                                    ->build()
                            )
                            ->build(),
                        OrderLineItemBuilder::init(
                            '1'
                        )
                            ->name('Slim Jeans')
                            ->basePriceMoney(
                                MoneyBuilder::init()
                                    ->amount(2500)
                                    ->currency(Currency::USD)
                                    ->build()
                            )
                            ->build(),
                        OrderLineItemBuilder::init(
                            '3'
                        )
                            ->name('Woven Sweater')
                            ->basePriceMoney(
                                MoneyBuilder::init()
                                    ->amount(3500)
                                    ->currency(Currency::USD)
                                    ->build()
                            )
                            ->build()
                    ]
                )
                ->taxes(
                    [
                        OrderLineItemTaxBuilder::init()
                            ->uid('38ze1696-z1e3-5628-af6d-f1e04d947fg3')
                            ->type(OrderLineItemTaxType::INCLUSIVE)
                            ->percentage('7.75')
                            ->scope(OrderLineItemTaxScope::LINE_ITEM)
                            ->build()
                    ]
                )
                ->discounts(
                    [
                        OrderLineItemDiscountBuilder::init()
                            ->uid('56ae1696-z1e3-9328-af6d-f1e04d947gd4')
                            ->type(OrderLineItemDiscountType::FIXED_AMOUNT)
                            ->amountMoney(
                                MoneyBuilder::init()
                                    ->amount(100)
                                    ->currency(Currency::USD)
                                    ->build()
                            )
                            ->scope(OrderLineItemDiscountScope::LINE_ITEM)
                            ->build()
                    ]
                )
                ->build()
        )
        ->idempotencyKey('12ae1696-z1e3-4328-af6d-f1e04d947gd4')
        ->build()
)
    ->askForShippingAddress(true)
    ->merchantSupportEmail('merchant+support@website.com')
    ->prePopulateBuyerEmail('example@email.com')
    ->prePopulateShippingAddress(
        AddressBuilder::init()
            ->addressLine1('1455 Market St.')
            ->addressLine2('Suite 600')
            ->locality('San Francisco')
            ->administrativeDistrictLevel1('CA')
            ->postalCode('94103')
            ->country(Country::US)
            ->firstName('Jane')
            ->lastName('Doe')
            ->build()
    )
    ->redirectUrl('https://merchant.website.com/order-confirm')
    ->additionalRecipients(
        [
            ChargeRequestAdditionalRecipientBuilder::init(
                '057P5VYJ4A5X1',
                'Application fees',
                MoneyBuilder::init()
                    ->amount(60)
                    ->currency(Currency::USD)
                    ->build()
            )->build()
        ]
    )->build();

$apiResponse = $checkoutApi->createCheckout(
    $locationId,
    $body
);

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

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

Retrieve Location Settings

Retrieves the location-level settings for a Square-hosted checkout page.

function retrieveLocationSettings(string $locationId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`locationId`	`string`	Template, Required	The ID of the location for which to retrieve settings.

Response Type

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

Example Usage

$locationId = 'location_id4';

$apiResponse = $checkoutApi->retrieveLocationSettings($locationId);

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

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

Update Location Settings

Updates the location-level settings for a Square-hosted checkout page.

function updateLocationSettings(string $locationId, UpdateLocationSettingsRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
`locationId`	`string`	Template, Required	The ID of the location for which to retrieve settings.
`body`	`UpdateLocationSettingsRequest`	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 UpdateLocationSettingsResponse.

Example Usage

$locationId = 'location_id4';

$body = UpdateLocationSettingsRequestBuilder::init(
    CheckoutLocationSettingsBuilder::init()->build()
)->build();

$apiResponse = $checkoutApi->updateLocationSettings(
    $locationId,
    $body
);

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

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

Retrieve Merchant Settings

Retrieves the merchant-level settings for a Square-hosted checkout page.

function retrieveMerchantSettings(): ApiResponse

Response Type

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

Example Usage

$apiResponse = $checkoutApi->retrieveMerchantSettings();

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

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

Update Merchant Settings

Updates the merchant-level settings for a Square-hosted checkout page.

function updateMerchantSettings(UpdateMerchantSettingsRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
`body`	`UpdateMerchantSettingsRequest`	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 UpdateMerchantSettingsResponse.

Example Usage

$body = UpdateMerchantSettingsRequestBuilder::init(
    CheckoutMerchantSettingsBuilder::init()->build()
)->build();

$apiResponse = $checkoutApi->updateMerchantSettings($body);

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

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

List Payment Links

Lists all payment links.

function listPaymentLinks(?string $cursor = null, ?int $limit = null): ApiResponse

Parameters

Parameter	Type	Tags	Description
`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. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see Pagination.
`limit`	`?int`	Query, Optional	A limit on the number of results to return per page. The limit is advisory and the implementation might return more or less results. If the supplied limit is negative, zero, or greater than the maximum limit of 1000, it is ignored. Default value: `100`

Response Type

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

Example Usage

$apiResponse = $checkoutApi->listPaymentLinks();

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

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

Create Payment Link

Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services.

function createPaymentLink(CreatePaymentLinkRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
`body`	`CreatePaymentLinkRequest`	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 CreatePaymentLinkResponse.

Example Usage

$body = CreatePaymentLinkRequestBuilder::init()
    ->idempotencyKey('cd9e25dc-d9f2-4430-aedb-61605070e95f')
    ->quickPay(
        QuickPayBuilder::init(
            'Auto Detailing',
            MoneyBuilder::init()
                ->amount(10000)
                ->currency(Currency::USD)
                ->build(),
            'A9Y43N9ABXZBP'
        )->build()
    )->build();

$apiResponse = $checkoutApi->createPaymentLink($body);

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

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

Delete Payment Link

Deletes a payment link.

function deletePaymentLink(string $id): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the payment link to delete.

Response Type

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

Example Usage

$id = 'id0';

$apiResponse = $checkoutApi->deletePaymentLink($id);

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

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

Retrieve Payment Link

Retrieves a payment link.

function retrievePaymentLink(string $id): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of link to retrieve.

Response Type

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

Example Usage

$id = 'id0';

$apiResponse = $checkoutApi->retrievePaymentLink($id);

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

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

Update Payment Link

Updates a payment link. You can update the payment_link fields such as description, checkout_options, and pre_populated_data. You cannot update other fields such as the order_id, version, URL, or timestamp field.

function updatePaymentLink(string $id, UpdatePaymentLinkRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
`id`	`string`	Template, Required	The ID of the payment link to update.
`body`	`UpdatePaymentLinkRequest`	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 UpdatePaymentLinkResponse.

Example Usage

$id = 'id0';

$body = UpdatePaymentLinkRequestBuilder::init(
    PaymentLinkBuilder::init(
        1
    )
        ->checkoutOptions(
            CheckoutOptionsBuilder::init()
                ->askForShippingAddress(true)
                ->build()
        )
        ->build()
)->build();

$apiResponse = $checkoutApi->updatePaymentLink(
    $id,
    $body
);

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

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

Files

checkout.md

Latest commit

History

checkout.md

File metadata and controls

Checkout

Class Name

Methods

Create Checkout

Parameters

Response Type

Example Usage

Retrieve Location Settings

Parameters

Response Type

Example Usage

Update Location Settings

Parameters

Response Type

Example Usage

Retrieve Merchant Settings

Response Type

Example Usage

Update Merchant Settings

Parameters

Response Type

Example Usage

List Payment Links

Parameters

Response Type

Example Usage

Create Payment Link

Parameters

Response Type

Example Usage

Delete Payment Link

Parameters

Response Type

Example Usage

Retrieve Payment Link

Parameters

Response Type

Example Usage

Update Payment Link

Parameters

Response Type

Example Usage