SOsolvapay
Merchant

Get merchant identity for the authenticated provider

Changed on

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

Request

Response

Merchant identity

citystring

City from the legal entity address

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

stateOrCountystring

State, county, or region from the legal entity address. Free text — values like "Greater London" are valid.

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)

websiteUrlstring

Merchant public website. Distinct from supportUrl so the same URL is not emitted twice.

Example response

{
  "city": "London",
  "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",
  "stateOrCounty": "Greater London",
  "supportedTopupCurrencies": [
    "USD",
    "EUR",
    "GBP"
  ],
  "supportEmail": "support@acme.com",
  "supportUrl": "https://acme.com/support",
  "taxId": "12-3456789",
  "termsUrl": "https://acme.com/terms",
  "vatNumber": "DE123456789",
  "websiteUrl": "https://acme.com"
}

Changes

  • aacdf8ae7816Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • bbc2ff2bc849Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status