Get tokens

GET

tokens

Get tokens

curl --request GET \
  --url https://sandbox.hellgate.io/tokens \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://sandbox.hellgate.io/tokens"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://sandbox.hellgate.io/tokens', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.hellgate.io/tokens",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.hellgate.io/tokens"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.hellgate.io/tokens")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.hellgate.io/tokens")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "5d6b2c9a-9b0b-4b0c-8c7d-9e9d5d7e9d5d",
      "cardholder_name": "John Doe",
      "card_art_url": "https://api.hellgate.io/tokens/card-art/374c911a-8125-40eb-acb8-a26efd25f02b",
      "created_at": "2023-10-01T00:00:00Z",
      "expiry_month": 4,
      "expiry_year": 2033,
      "expires_at": "2023-10-07T00:00:00Z",
      "issuer_identification_number": "424242",
      "masked_account_number": "424242******4242",
      "network_token_status": "active",
      "scheme": "VISA"
    }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 1,
    "total_items": 1,
    "total_pages": 1
  }
}

{
  "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"
}

Authorizations

X-API-Key

string

header

required

Query Parameters

limit

integer

The desired amount of records per page. The parameter defaults to 50 if it is omitted and has a maximum of 500.

Required range: 1 <= x <= 500

page

integer

The desired number of the page to return.

Required range: x >= 1

from

string<date-time>

Return only network tokens created from this date (YYYY-MM-DD).

string<date-time>

Return only network tokens created up to this date (YYYY-MM-DD).

sort

string

It allows sorting the result by created_at. e.g sort=created_at+asc or sort=created_at+desc

network_token_status

enum<string>

Requested status in list format e.g network_token_status=active or network_token_status=active,inactive

The status of the associated network token.

Status	Description
`active`	The network token is active and can be used.
`inactive`	The network token is inactive, which prevents using it. The reason can be for example suspended network token.
`pending`	A network token is currently being provisioned. As soon as this is available, the status is changed to `active`.
`failed`	A network token failed to be provisioned.
`deleted`	The network token is deleted and cannot be used again. It is also not possible to activate the network token again.
`not_available`	A network token can not be provisioned with the current configuration.

Available options:

active,

inactive,

pending,

deleted,

failed,

not_available

scheme

enum<string>

Requested card schemes in list format e.g scheme=VISA or scheme=VISA,MASTERCARD

The scheme in which the card was issued

Available options:

VISA,

Mastercard,

American Express,

Discover,

Diners Club,

JCB,

UnionPay,

Unknown

business_key

string

Request tokens which the exact match of this value.

The business key is a reference of the original ID under which the cardholder data was stored on the system from which it was imported to Commerce.

Response

Success response

data

object[]

Show child attributes

pagination

object

The meta-data describing lists of data from the Commerce API. The pages are indexed from 1 up to the total_pages.

Show child attributes

Example:

{
  "current_page": 1,
  "page_size": 1,
  "total_items": 1,
  "total_pages": 1
}

Get token detailsGet a Commerce token by its identifer.

⌘I

Get tokens

curl --request GET \
  --url https://sandbox.hellgate.io/tokens \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://sandbox.hellgate.io/tokens"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://sandbox.hellgate.io/tokens', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.hellgate.io/tokens",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.hellgate.io/tokens"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.hellgate.io/tokens")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.hellgate.io/tokens")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "5d6b2c9a-9b0b-4b0c-8c7d-9e9d5d7e9d5d",
      "cardholder_name": "John Doe",
      "card_art_url": "https://api.hellgate.io/tokens/card-art/374c911a-8125-40eb-acb8-a26efd25f02b",
      "created_at": "2023-10-01T00:00:00Z",
      "expiry_month": 4,
      "expiry_year": 2033,
      "expires_at": "2023-10-07T00:00:00Z",
      "issuer_identification_number": "424242",
      "masked_account_number": "424242******4242",
      "network_token_status": "active",
      "scheme": "VISA"
    }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 1,
    "total_items": 1,
    "total_pages": 1
  }
}

{
  "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"
}

Getting Started

Payments

Authentications

Customer Data

Tokens

Configuration

Automation

Authorizations

Query Parameters

Response