Skip to content
Xaalis

Create a test-only merchant account and receive secrets once

POST
/v1/sandbox/signups
curl --request POST \
  --url http://localhost:4000/v1/sandbox/signups \
  --header 'Content-Type: application/json' \
  --data '{ "email": "[email protected]", "business_name": "example", "webhook_url": "https://example.com" }'

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters”
idempotency-key
string
>= 1 characters <= 255 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
required
string format: email
<= 254 characters
business_name
required
string
>= 2 characters <= 120 characters
webhook_url
string format: uri
Examplegenerated
{
  "email": "[email protected]",
  "business_name": "example",
  "webhook_url": "https://example.com"
}

Responses

Section titled “ Responses ”

201

Section titled “201”

Sandbox credentials, shown once

Media typeapplication/json
object
object
required
string
Allowed values: sandbox_signup
merchant
required
object
id
required
string
object
required
string
Allowed values: merchant
name
required
string
email
required
string
status
required
string
Allowed values: pending_review
secret_key
required
string
webhook_secret
required
string
Example
{
  "object": "sandbox_signup",
  "merchant": {
    "object": "merchant",
    "status": "pending_review"
  }
}

400

Section titled “400”

Invalid signup

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404”

Test keys disabled

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Section titled “409”

Idempotency conflict or secret unavailable

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

429

Section titled “429”

Signup rate limit

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

503

Section titled “503”

Rate limiter unavailable

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}