Skip to content
/Metadata Inquiries

Guardian API (EAP)

Download OpenAPI description
guardian-openapi.json
guardian-openapi.yaml
Overview
URL

https://hellgate.io/guardian

Starfish GmbH & Co. KG

hello@starfish.team

License

Hellgate API Terms

Languages
Servers
Managed instance of Guardian CPA

https://{cluster_id}.on-hellgate.cloud/

PCI Tokens

Management of card payment credentials under the ruling of PCI/DSS.

Operations

Network Tokens

Management of network tokens, including cryptograms for secure transactions.

Operations

Metadata Inquiries

Inquiries for card metadata based on PAN, PCI tokens, or network tokens.

Operations

Create inquiry

Request

Create a new inquiry for card metadata based on either a PAN, an existing PCI token, or a network token.

Security
APIKey or AdminToken
Headers
x-idempotency-keystring

Optional idempotency key to prevent duplicate processing

Example: order_12345_retry_001
Bodyapplication/json
sourceobjectrequired
source.​typestringrequired
Discriminator
source.​account_numberstringrequired

The card number (without separators)

Example: "4111111111111111"
source.​cardholder_namestring

The name of the cardholder

Example: "Bob Holder"
source.​expiry_yearinteger>= 2000required

The expiry year of the card

Example: 2025
source.​expiry_monthinteger[ 1 .. 12 ]required

The expiry month of the card

Example: 4
source.​security_codestring[ 3 .. 4 ] characters

The security code of the card

Information

The system will not permanently store the security code, but keep it in a ephemeral position for immediate use.

Example: "321"
curl -i -X POST \
  https://my-cluster-id.on-hellgate.cloud/api/metadata/inquiries \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-idempotency-key: order_12345_retry_001' \
  -d '{
    "source": {
      "type": "pan",
      "account_number": "4111111111111111",
      "expiry_month": 12,
      "expiry_year": 2025,
      "security_code": "123"
    }
  }'

Responses

Success response

Bodyapplication/json
binstring[ 6 .. 8 ] charactersrequired
Example: "411111"
schemestringrequired
Enum"visa""mastercard""american express""discover""diners club""jcb""unionpay"
Example: "visa"
typestring
Enum"credit""debit""prepaid""other"
Example: "credit"
segmentstring
Enum"consumer""commercial"
Example: "consumer"
billing_currency_codestring= 3 characters
Example: "EUR"
issuer_namestring
Example: "Starfish Bank"
issuer_country_codestring
Example: "DE"
product_codestring
Example: "VISA-PLATINUM"
product_namestring
Example: "Visa Platinum Card"
Response
application/json
{
  "bin": "411111",
  "scheme": "visa",
  "type": "credit",
  "segment": "consumer",
  "billing_currency_code": "EUR",
  "issuer_name": "Starfish Bank",
  "issuer_country_code": "DE",
  "product_code": "VISA-PLATINUM",
  "product_name": "Visa Platinum Card"
}

Administration

Administrative operations for managing a Guardian instance, such as API keys.

Operations
Starfish GmbH & Co. KG © 2025