HSRCPAY Dökümantasyon
API v1

Get account

Returns one account by id (`acct_…` or internal id) when the caller has read access. Errors follow the standard v1 error envelope.

GET
/accounts/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

Use Authorization: Bearer <token>. The same header supports: (1) JWT access token from the configured auth provider; (2) secret API key whose value contains sk_ within the first 32 characters (e.g. sk_live_…, sk_test_…); (3) publishable key containing pk_. Sandbox keys typically include _test_ in the string; the server resolves repositories from that.

In: header

Path Parameters

id*Account ID

Account identifier (acct_… or server id format).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.hsrcpay.com/v1/accounts/string"
{
  "message": "success",
  "success": true,
  "data": {
    "object": "account",
    "id": "string",
    "user_id": "string",
    "workspace_id": "string",
    "name": "string",
    "country": "US",
    "prod_account_id": "string",
    "timezone": "Europe/Istanbul",
    "settings": [
      {
        "object": "account_setting",
        "id": "string",
        "key": "string",
        "value": "string",
        "created_at": null,
        "updated_at": null,
        "property1": null,
        "property2": null
      }
    ],
    "currency": "USD",
    "deleted": true,
    "created_at": null,
    "updated_at": null,
    "metadata": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}
{
  "message": "string",
  "success": false,
  "error": {
    "code": 0,
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}

List accounts GET

Returns every account the current principal may access. Context (user, workspace, membership) is taken from the token - **do not** pass workspace or membership ids in the query. Response `data` is an array of account DTOs (production and sandbox).

Create account POST

Creates a production or sandbox account. For sandbox (`sandbox_mode=true`), `prod_account_id` is required so the sandbox is linked to a live account. The handler may return **200** or **201** with the same success envelope.