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 Web Payments SDK and In-App Payments SDK applications, accept payment cards and return one-time use encrypted payment tokens (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 Web Payments SDK or In-App Payments SDK application by using test credit card numbers to generate payment tokens 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 payment token logic, use the test payment tokens provided in the Square endpoint testing section to submit payments in the Sandbox.

Web and mobile client testing

You can use Sandbox credit cards with the Web Payments SDK and In-App Payments SDK to input card numbers that generate a payment token for Sandbox testing.

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.

Notes:

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

• Payments in USD (United States), CAD (Canada), or GBP (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.

ACH Bank Transfer success state values

The Sandbox supports ACH Bank Transfer by accepting the test user name user_good and the test password pass_good. These test values are provided by the Plaid API and might change in the future. For more information, see the Plaid Sandbox test credentials page.

Error state values

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

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

SCA testing in Web Payments SDK

To test SCA in the Sandbox environment, you should use a payment token returned by the Web Payments SDK. To test different SCA scenarios, use the cards provided in the following table.

Use the Payments.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.

Payments API endpoint testing

Test your payments logic that uses the CreatePayment endpoint to take a payment or the CreateCard endpoint to store a customer's 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 payment tokens as the source_id in the payment request.

Payments API

Use the values in the following table with calls to the CreatePayment endpoint that succeed in creating a payment.

In addition, if you want to test errors in the Square CreatePayment endpoint, you can use the following test values:

Payment tokens for ACH Bank Transfer payments

Note the following:

• The resulting payment has PENDING as the initial status, which updates to COMPLETED after one minute.

• For failed requests, The resulting payment has PENDING as the initial status, which updates to FAILED after one minute.

PAYMENT TOKENS FOR TESTING UPDATE PAYMENT REQUESTS

You can also use the following test values to create payments using CreatePayment. The benefit of using these token values is that updates to these payments using UpdatePayment always return the following predictable results.

Cards API

You can use a payment token generated with one of the test payment cards in the Client-side testing section or you can use the values in the following table that are used with calls to CreateCard and successfully create a card on file for a customer.

Terminal API - checkouts

Sandbox test values can be used to test 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 a physical Square Terminal. Successful Sandbox 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:

Terminal checkout test device IDs

Example checkout 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"
        }
    }
}'

Terminal API - Interac refunds

Sandbox test values can be used to test terminal Interac refunds in the Square Sandbox. Successful Sandbox requests result in a refund generated in the Sandbox and shown in the Seller Dashboard for your test account.

Terminal Interac refund test device IDs

Before you can test your integration for an Interac refund, you must create an Interac checkout/payment using an Interac device ID in the previous table.

Use the following to generate Sandbox terminal Interac refunds:

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.

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.

Sandbox payment risk evaluation

In Sandbox, the following payment amounts in a CreatePayment request generate a Payment object with risk_evaluation identifying the specific risk levels.