Skip to main content
GET
Get Account Info

Get Account Info

Intro

Returns the merchant account tied to the calling API key — its ID, name, country, and settlement currency — without you having to already know or configure any of that.

Context

This is the endpoint integrations call first, before anything else, to self-configure. The WooCommerce plugin uses it to auto-detect the merchant ID and settlement currency instead of asking the merchant to type them in by hand. Authentication works exactly as described in Authentication — the X-API-Key header, no separate setup.

Hows

Request

No body required. Authentication is via the X-API-Key header.

Response

Errors

Whys

settlement_currency is sourced from the merchant’s KYC record rather than a self-reported profile field, because that’s the actual source of truth for which currency payouts land in — a merchant can’t accidentally desync this endpoint’s answer from what they’re really getting paid in. Keeping the response to four fields (rather than the full merchant profile) is intentional: this endpoint exists for auto-configuration, and every extra field is another thing a plugin has to handle if it’s absent or changes shape.

Why nots

This endpoint doesn’t return anything about the API key itself (its permissions, rate limit, or webhook config) — for that, use the key-management endpoints in Authentication, which require a dashboard session rather than the API key. It also isn’t a general merchant-profile endpoint — it won’t return catalog data, balances, or KYC status; those live on their own endpoints.