Skip to main content

Merchants

Register a merchant

string
required
Display name of the business, e.g. "Acme Digital Goods".
apiKey is displayed exactly once. Only its SHA-256 hash is stored.

List my merchants (console)

Every business registered under your workspace, newest first. Powers the business switcher in the console.
Each entry carries balance_minor (USD cents) and paid_charges so the overview can render without an extra call per business. The sk_mch_ key is not returned here; it lives only in the caller’s storage.

Get my balance

balanceMinor is USD cents. It increases every time one of your charges is paid.

Set payout address

Where settled money goes. The address is screened automatically (KYT); blocked addresses are rejected with 403.
Errors:

List my charges

Last 100 charges, newest first.
See the charge object for field details.

Screen an address (console)

Standalone KYT screening; useful before paying out to an arbitrary address.

Export transactions (console)

Accounting export straight from the audit chain; every row carries its sequence number and event hash.
Defaults to the last 30 days when no range is given. Response is text/csv.