Skip to main content
GET
/
credentials
/
{id}
Get credential details
curl --request GET \
  --url https://sandbox.hellgate.io/credentials/{id} \
  --header 'X-API-Key: <api-key>'
{
  "type": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "cardholder_name": "<string>",
  "expiry_month": 123,
  "expiry_year": 123,
  "masked_account_number": "<string>",
  "issuer": {
    "account": {
      "funding": "credit",
      "country_code": "<string>",
      "currency": "<string>"
    },
    "identification_number": "<string>",
    "name": "<string>",
    "scheme": "<string>",
    "segment": "consumer"
  }
}

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

The ID of the credential

Response

Success response

The underlying payment-method type of this stored credential.

type
string
required

The type of the credential

id
string<uuid>
required

The ID of the credential on file

created_at
string<date-time>
required

The date-time the credential was created (following ISO 8601)

cardholder_name
string
required

The name of the owner of the card

expiry_month
integer
required

The number of month in a year (e.g. April is 4)

expiry_year
integer
required

The year given as four digit number (e.g. 2023)

masked_account_number
string
required

The full lenght of the card number, but masked to conform to PCI/DSS requirments

issuer
object