Create inquiry

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

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

Authorizations

Authorization

string

header

required

JWT bearer token obtained via the OAuth2 client-credentials grant from the platform Authentication API. The token's scopes gate the endpoints it may call, and its audience names the Guardian instance. This is the standard way to authenticate to Guardian.

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

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

Getting Started

Tokens

Metadata

Admin

Authorizations

Body

Response