HSRCPAY Dökümantasyon
API v1

List API keys

Paginated keys for the account. Use `managed` to split platform-managed vs custom integrations. Requires `account:api:key:read`.

GET
/api-keys/

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

Query Parameters

account_id*Account ID
page*Page

1-based page index.

Default1
Range0 < value
limit*Limit

Page size.

Default10
Range0 < value
managed?Managed filter

If true, only standard (platform-managed) keys. If false, only custom keys. Omit for all keys.

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/api-keys/?account_id=string&page=1&limit=10"
{
  "message": "success",
  "success": true,
  "data": [
    {
      "object": "api_key",
      "id": "string",
      "account_id": "string",
      "name": "string",
      "type": "SECRET",
      "key": "string",
      "last_used_ip": "string",
      "metadata": {
        "property1": null,
        "property2": null
      },
      "permissions": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "status": "ACTIVE",
      "last_used_at": null,
      "expires_at": null,
      "managed": true,
      "deleted": true,
      "created_at": null,
      "updated_at": null,
      "property1": null,
      "property2": null
    }
  ],
  "total": 0,
  "page": 9007199254740991,
  "limit": 9007199254740991,
  "pages": 0,
  "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
}

Delete payment method DELETE

Void success envelope when the handler returns no body.

Get API key GET

Fetches metadata for one key (secret is never returned after creation). Requires `account:api:key:read`.