Skip to navigation
API ReferenceMerchants

Retrieve your Merchant account

Returns the Merchant that owns the API key: its tier, the key’s mode, the balance not yet paid out in that mode, and the Payout schedule. A cheap way to check a key works and which mode it’s in.

Authentication

AuthorizationBearer

Your secret key: sk_test_… in Test mode, sk_live_… in Live mode.

Response

The calling Merchant's own account.
tierenum
Merchant's account tier.
Allowed values:
modeenum
Mode of the API key used for this request.
Allowed values:
balanceinteger

Earned balance not yet swept into a Payout, in FJD cents (minor units).

payoutScheduleenum

When Payouts are made, in UTC: daily; weekly on Mondays (the default); fortnightly on every other Monday; monthly on the 1st; or manual, where a Payout is made only when the Merchant asks for one from the dashboard. Set on the dashboard.

Allowed values:

Errors

401
Unauthorized Error