v20

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-214885191.3 KB

Merchant

Get merchant identity for the authenticated provider

Returns the subset of provider data safe to render in a customer-facing checkout: display name, legal name, support contact, terms and privacy URLs, and logo. Used by SDK components like MandateText and CheckoutSummary.

get/v1/sdk/merchant

Response

Merchant identity

companyNumberstring

Company registration number (EIN, Companies House No, Org No)

countrystring

ISO-3166 alpha-2 country code of the merchant

defaultCurrencystring

ISO-4217 default settlement currency

displayNamestring required

Brand name shown in UI

iconUrlstring

Absolute URL to the square app icon / logomark. Consumed by MCP host chromes, mobile avatar slots, and any surface where the landscape logoUrl would need letterboxing.

legalNamestring required

Legal entity name used in SCA mandate copy

logoUrlstring

Absolute URL to the merchant logo

privacyUrlstring

statementDescriptorstring

Descriptor appearing on the customer card statement

supportedTopupCurrenciesstring[]

Full set of currencies a customer may pay credit topups in, including the default currency. Omitted/single-entry means single-currency behavior.

supportEmailstring

supportUrlstring

taxIdstring

Tax identification number (US: EIN)

termsUrlstring

vatNumberstring

VAT identification number (UK/EU)

Example response

{
  "companyNumber": "HRB12345",
  "country": "US",
  "defaultCurrency": "usd",
  "displayName": "Acme",
  "iconUrl": "https://cdn.acme.com/icon.png",
  "legalName": "Acme Inc.",
  "logoUrl": "https://cdn.acme.com/logo.png",
  "privacyUrl": "https://acme.com/privacy",
  "statementDescriptor": "ACME INC",
  "supportedTopupCurrencies": [
    "USD",
    "EUR",
    "GBP"
  ],
  "supportEmail": "support@acme.com",
  "supportUrl": "https://acme.com/support",
  "taxId": "12-3456789",
  "termsUrl": "https://acme.com/terms",
  "vatNumber": "DE123456789"
}