Create inquiry - Hellgate Cloud Platform

POST

/

api

/

metadata

/

inquiries

curl --request POST \
  --url https://{cluster_id}.on-hellgate.cloud/api/metadata/inquiries \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "source": {
    "type": "pan",
    "account_number": "4111111111111111"
  }
}
'

{
  "bin": "411111",
  "schemes": [
    "visa"
  ],
  "type": "credit",
  "segment": "consumer",
  "currency_code": "EUR",
  "issuer_name": "Starfish Bank",
  "issuer_country_code": "DE"
}

{
  "code": 401,
  "message": "No valid means of authentication was provided",
  "classifier": "UNAUTHORIZED"
}

{
  "code": 403,
  "message": "Not allowed to access this resource or feature",
  "classifier": "FORBIDDEN"
}

{
  "code": 409,
  "message": "Conflict",
  "classifier": "CONFLICT"
}

{
  "code": 422,
  "classifier": "VALIDATION_ERROR",
  "message": "Validation error",
  "validation_errors": [
    {
      "path": "json-path",
      "message": "human readable error message"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Body

application/json

source

From PAN · object

required

From PAN
From PCI Token
From Network Token

Show child attributes

Response

Success response

bin

string

required

The bank identification number.

schemes

enum<string>[]

required

Scheme defines the brand of the card. A co-branded card will return multiple schemes.

Available options:

visa,

mastercard,

american express,

discover,

diners club,

jcb,

unionpay,

cartes bancaires,

airplus

type

enum<string>

The funding type of the card.

Available options:

credit,

debit,

prepaid,

charge,

deferred,

unknown

segment

enum<string>

The segment or category of the card.

Available options:

consumer,

commercial

currency_code

string

The three letter currency code of the card. See: ISO-4217

Required string length: 3

issuer_name

string

The name of the issuing bank.

issuer_country_code

string

A two-letter country code of the issuer (ISO 3166-1 alpha-2). ISO 3166-1 alpha-2

Required string length: 2

Create API keyCreates a new API key with the specified scopes and expiry defined via `expires_in` (seconds).

⌘I

curl --request POST \
  --url https://{cluster_id}.on-hellgate.cloud/api/metadata/inquiries \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "source": {
    "type": "pan",
    "account_number": "4111111111111111"
  }
}
'

{
  "bin": "411111",
  "schemes": [
    "visa"
  ],
  "type": "credit",
  "segment": "consumer",
  "currency_code": "EUR",
  "issuer_name": "Starfish Bank",
  "issuer_country_code": "DE"
}

{
  "code": 401,
  "message": "No valid means of authentication was provided",
  "classifier": "UNAUTHORIZED"
}

{
  "code": 403,
  "message": "Not allowed to access this resource or feature",
  "classifier": "FORBIDDEN"
}

{
  "code": 409,
  "message": "Conflict",
  "classifier": "CONFLICT"
}

{
  "code": 422,
  "classifier": "VALIDATION_ERROR",
  "message": "Validation error",
  "validation_errors": [
    {
      "path": "json-path",
      "message": "human readable error message"
    }
  ]
}