Management of card payment credentials under the ruling of PCI/DSS.
Guardian API (EAP)
Download OpenAPI description
Overview
URL
Starfish GmbH & Co. KG
License
Languages
Servers
Managed instance of Guardian CPA
https://{cluster_id}.on-hellgate.cloud/
API Keys
Management of API keys for service access.
The capabilities an API keys has access to can be scoped to these areas:
- API Keys- admin:api-keys:create
- admin:api-keys:read
- admin:api-keys:update
- admin:api-keys:delete
 
- Webhooks- admin:webhooks:create
- admin:webhooks:read
- admin:webhooks:delete
 
- PCI Tokens- pci:tokens:create
- pci:tokens:read
- pci:tokens:update
- pci:tokens:delete
- pci:tokens:forward
 
- Network Tokens- network:tokens:create
- network:tokens:read
- network:tokens:delete
- network:tokens:use
 
- Metadata Inquiries- metadata:inquiry:create
 
Operations
Webhooks
Management of webhooks for event notifications.
Guardian uses tiny events as notification payload. They give you the context of what happened and you can use this information to fetch more details via our API.
Please find the documentation about the callback on the endpoint that registers the webhook.
Operations
Bodyapplication/json
The list of events to subscribe to.
Items Enum"network.token.updated""pci.token.security-code.expired"
- Managed instance of Guardian CPAhttps://my-cluster-id.on-hellgate.cloud/api/admin/webhooks 
- curl
- Java
- Node.js
- Ruby
- Go
- Python
curl -i -X POST \
  https://my-cluster-id.on-hellgate.cloud/api/admin/webhooks \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "events": [
      "network.token.updated"
    ],
    "url": "http://example.com"
  }'Response
application/json
{ "id": "5d6b2c9a-9b0b-4b0c-8c7d-9e9d5d7e9d5d", "created_at": "2023-10-05T14:48:00.000Z", "url": "https://my-webhook-endpoint.com/webhooks", "events": [ "network.token.updated", "pci.token.security-code.expired" ], "masekd_hmac_key": "123xxxx" }
- Managed instance of Guardian CPAhttps://my-cluster-id.on-hellgate.cloud/api/admin/webhooks 
- curl
- Java
- Node.js
- Ruby
- Go
- Python
curl -i -X GET \
  'https://my-cluster-id.on-hellgate.cloud/api/admin/webhooks?limit=20' \
  -H 'x-api-key: YOUR_API_KEY_HERE'Response
application/json
{ "data": [ { … } ], "links": { "next": "https://my-cluster-id.on-hellgate.cloud/admin/webhooks?after=123e4567-e89b-12d3-a456-426614174000&limit=20" } }
- Managed instance of Guardian CPAhttps://my-cluster-id.on-hellgate.cloud/api/admin/webhooks/{id} 
- curl
- Java
- Node.js
- Ruby
- Go
- Python
curl -i -X GET \
  'https://my-cluster-id.on-hellgate.cloud/api/admin/webhooks/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created_at": "2019-08-24T14:15:22Z", "events": [ "network.token.updated" ], "masekd_hmac_key": "123xxxx", "url": "http://example.com" }