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 null while your business is still onboarding. Once onboarded it is one of Verified, Blocked, Dormant or Suspended.

Unlike most endpoints, it doesn't require your account to be able to take payments, so you can call it while you're still onboarding to check that your key works. 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 key for a blocked, suspended or dormant account returns 403 with ACCOUNT_BLOCKED. See Errors.

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

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