Skip to main content
POST
Create a sandbox account

Body

application/json

Optional. An empty body is valid.

name
string

Your account name. Defaults to email, then to "sandbox tenant".

Required string length: 1 - 120
email
string<email>

Contact address. Not verified, not emailed.

Maximum string length: 200

Response

Account created.

tenantId
string<uuid>
required
name
string
required
sandboxOnly
boolean
required
sandboxMerchants
string[]
required

The only hosts this account can check out at until it is activated.

Example:
apiKey
string
required

Shown once. Only a SHA-256 hash is stored — nothing can recover it.

Example:

"ck_test_3sQd7yQ0mHq9pP2rVwXk1tLb"