Documentation

Ping

Confirm your API key, business, and environment.

Requires a valid Merchant API key. No scope is required. Useful as a health check after rotating keys or changing IP allowlists.

GET/ping

Scope: none (valid API key required)

Returns identity metadata for the authenticated credential.

Request

curl -X GET "https://api.bitstac.io/api/v1/merchant/ping" \
  -H "Authorization: Bearer $BITSTAC_API_KEY" \
  -H "Accept: application/json"

Example response

{
  "success": true,
  "data": {
    "ok": true,
    "business_id": "3f2c…",
    "business_name": "Acme Imports Ltd",
    "environment": "test",
    "key_prefix": "bst_test_abcd1234efgh"
  }
}