Retrieve merchant settingsBeta

GET

/v2/online-checkout/merchant-settings

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

Permissions:MERCHANT_PROFILE_READ, PAYMENT_METHODS_READ

Guide

Checkout Settings API

Try in API Explorer

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

merchant_settings

The merchant settings.

Link to section

Examples

GET /v2/online-checkout/merchant-settings

curl https://connect.squareup.com/v2/online-checkout/merchant-settings \
  -H 'Square-Version: 2024-04-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "merchant_settings": {
    "merchant_id": "MERCHANT_ID",
    "updated_at": "2022-06-16T22:25:35Z",
    "payment_methods": {
      "apple_pay": {
        "enabled": true
      },
      "google_pay": {
        "enabled": true
      },
      "cash_app_pay": {
        "enabled": true
      },
      "afterpay_clearpay": {
        "enabled": true,
        "order_eligibility_range": {
          "min": {
            "amount": 100,
            "currency": "USD"
          },
          "max": {
            "amount": 10000,
            "currency": "USD"
          }
        },
        "item_eligibility_range": {
          "min": {
            "amount": 100,
            "currency": "USD"
          },
          "max": {
            "amount": 10000,
            "currency": "USD"
          }
        }
      }
    }
  }
}