Fetch business info

Returns the business that owns your API key: its business_name, its business_tag (the slug used in your payment URLs), its website, and its account_status.

account_status is one of:

  • Verified: the account can take payments.
  • Blocked: the account is blocked. This endpoint still returns 200, and every other endpoint returns 403 with ACCOUNT_BLOCKED. Blocked can also appear on an account under review that can still take payments; the other endpoints then keep working.
  • null: the business isn't verified (for example it failed verification).

A suspended or dormant account has its API keys revoked, so every endpoint, this one included, returns 403 with ACCOUNT_BLOCKED. A 200 from this endpoint therefore never contains Dormant or Suspended; those values can still arrive in the account.status_updated webhook.

Unlike most endpoints, it works even when your account can't take payments (for example when it is blocked), so you can use it to check your key and account status. To be told when the status changes, subscribe to the account.status_updated event with Create webhook.

An invalid key returns 403 with UNAUTHORIZED. A suspended or dormant account's keys are revoked, so they return 403 with ACCOUNT_BLOCKED; a Blocked account's key still gets 200. See Errors.

Recipes
🧪
Get sandbox access and make your first test payment
Open Recipe
Responses

429

Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.

500

Unexpected error

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json