Sandbox Test Values

Test Square API operations in the Square Sandbox using test values.

Sandbox test values are used to test the client and server sides of payment processing in the Square Sandbox.

Sandbox payments

Square platform clients, such as the payment form and In-App Payments applications, accept payment cards and return one-time use encrypted nonces to be submitted to Square API payment endpoints to take payments. You can avoid testing your code with a real payment card by testing in the Sandbox.

Test client-side card-present logic in your payment form or In-App Payments application by using test credit card numbers to generate nonces for use with the Square API payments and card-on-file endpoints in the Sandbox.

If you do not need to test your client-side nonce-generation logic, use the nonces provided in the Square endpoint testing section to submit payments in the Sandbox with test nonces.

Client-side testing

You can use test credit cards with the payment form and In-App Payments SDK to input card numbers that generate a testable payment nonce.

Card present success state values

The Sandbox supports a collection of credit card numbers for all Square-supported card brands for simulating the client side of payment scenarios.

Test cards

Notes:

• You can set the card expiration date to any future month and year.

• Payments in USD (United States), CAD (Canada), or GBP (the United Kingdom) require a valid postal code.

• When testing the SCA flow with one of the European Union test cards, the verification code simulates the SMS verification code sent to the buyer's mobile phone during an actual transaction.

• The Sandbox simulates the use of payment cards in Square-supported countries. In production, card brand and country support might be different. Before releasing your application into production, review Supported Payment Methods by Country.

Error state values

You can reproduce certain error states in the Sandbox by providing special values in the Square payment form or In-App Payments SDK.

If you use one of the following values, the nonce returned generates an error when it is processed by the CreatePayment endpoint:

SCA testing in the payment form

To test SCA in the Sandbox, you cannot use a nonce returned by the payment form in the cardNonceResponseReceived event after entering Sandbox credit card numbers or personal credit card numbers. Instead, use a test nonce from the following table.

Use the SqPaymentForm.verifyBuyer function for card present and card on file (CoF) SCA challenges with the following test values:

The SCA flow requires buyers to provide a code sent to the their mobile phone in an SMS message. When testing in the Sandbox, use the verification code to simulate the code sent using SMS.

The SCA flow and these test values are not supported in the legacy Sandbox.

Square API endpoint testing

Test your payments logic that uses the CreatePayment endpoint to take a payment or the CreateCustomerCard endpoint to store a customer card on file.

If you are using the Square Payments API to generate payments in the Sandbox, you can use one of the Sandbox test nonces as the source_id in the payment request. You can also use a nonce generated with one of the test payment cards in the Client-side testing section.

Generating error states

You can reproduce certain error states in the Square payment endpoint by using the following test values:

Terminal API endpoint testing

Sandbox test values can be used to test payments and terminal checkouts in the Square Sandbox. The Terminal API supports a collection of special device_id values you can use to simulate terminal checkouts without connecting to an actual Square Terminal. Successful Sandbox checkout requests result in a payment generated in the Sandbox and shown in the Seller Dashboard for your test account.

Use the following information to generate Sandbox terminal checkouts:

Example POST request

This example creates a checkout in the Sandbox:

curl -X POST \
  https://connect.squareupsandbox.com/v2/terminals/checkouts \
  -H 'Authorization: Bearer SANDBOX_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -d '{
    "idempotency_key": "RANDOM_STRING",
    "checkout": {
        "type": "DEVICE",
        "amount_money": {
            "amount": 100,
            "currency": "USD"
        },
        "reference_id": "YOUR REFERENCE ID",
        "device_options": {
            "device_id": "9fa747a2-25ff-48ee-b078-04381f7c828f"
        }
    }
}'

Sandbox locations

Your Sandbox account comes with one mock location per application. This location is unrelated to the production locations listed in the Square Developer Dashboard.

The Sandbox location ID is listed on the Locations tab for each application in the Developer Dashboard. You can also fetch the location ID programmatically by calling ListLocations with a Sandbox access token.

Sandbox loyalty

You test the sample walkthrough in the Square Sandbox environment. After creating a loyalty program, you need a phone number to set up a loyalty account. In the Sandbox, you provide a Sandbox phone number, instead of a real phone number, using the following format:

+1<valid-area-code>555<any-four-digits>

For example, +14255551111. For more information and other Sandbox values, see Sandbox values.

Sandbox disputes

Use these predefined payment amounts that map to specific dispute reasons. When you set one of these amounts in a CreatePayment request, Square generates a Sandbox dispute with the corresponding reason.

The amounts shown are in the lowest denomination of the currency you provide in the CreatePayment request. For example, for USD, the amount is in cents.