Get an authentication

GET

authentications

{id}

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

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

fetch('https://sandbox.hellgate.io/authentications/{id}', 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/authentications/{id}",
  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/authentications/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.hellgate.io/authentications/{id}")

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

{
  "id": "7dcb4365-a948-4b41-a2d2-a7bffa2d3994",
  "amount": 1000,
  "currency_code": "EUR",
  "action_requirement": {
    "type": "use_sdk",
    "session_id": "d5b8e449-13da-4594-bf00-643146fb35d1"
  },
  "created_at": "2023-10-10T00:00:00Z",
  "challenge_preference": "CHALLENGE",
  "purchase_date": "20241010000000",
  "use_case": "ONE_OFF",
  "source": {
    "type": "token",
    "token_id": "71820e49-6822-4df1-8db5-d245456172b6"
  },
  "status": "PROCESSING"
}

{
  "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": 404,
  "message": "The requested resource was not found.",
  "classifier": "NOT_FOUND"
}

Beta Feature

Authorizations

X-API-Key

string

header

required

Path Parameters

string<uuid>

required

The ID of the authentication.

Response

Success response

string<uuid>

required

The ID of the authentication

Example:

"3e9b5d1f-7a2c-4c8e-b4d6-1f8a5c3e9b7d"

amount

integer

required

The amount given in minor units (e.g. use 700 for 7€). Some currencies do not support minor units (e.g. Japanese Yen). In this case send in the full value, .i.e. 100 for 100 JPY.

Required range: x >= 0

Example:

700

created_at

string<datetime>

required

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

Example:

"2026-06-01T10:00:00Z"

currency_code

string

required

The three letter currency code. See: ISO-4217

Example:

"EUR"

status

enum<string>

required

Available options:

PROCESSING,

COMPLETED,

FAILED

source

object

required

The payment credentials for this authentication request.

Type	Description
token	An already existing Commerce token can be used as source for the authentication.

Show child attributes

use_case

enum<string>

required

Available options:

ONE_OFF,

INITIAL_RECURRING,

INITIAL_INSTALLMENT,

SUBSEQUENT_RECURRING,

SUBSEQUENT_INSTALLMENT

action_requirement

object

Show child attributes

authentication_result

object

The final result of the authentication. It holds in the cardholder authentication data (CAVV) and if there is a network token present, the token authentication data (TAVV).

Show child attributes

challenge_preference

enum<string>

default:CHALLENGE

The preference with respect to an eventual challenge.

There is no guarantee that the preference can be fulfilled.

Available options:

CHALLENGE,

NO_PREFERENCE,

NO_CHALLENGE

recurring_expiry

string

The date when the latest subsequent authentication can happen. Requires the format yyyyMMdd.

Example:

"2027-06-01"

recurring_frequency

integer

Indicates the minimum number of days between authentications.

Example:

30

failure_details

object[]

The reasons why an authentication failed during processing in Commerce.

Show child attributes

finished_at

string<datetime>

The date-time the authentication was finished (following ISO 8601)

Example:

"2026-06-01T10:00:04Z"

original_authentication

string<uuid>

The ID of the original authentication in case of subsequent authentications

Example:

"9d5f1b7e-3c8a-4a2d-b6f4-7e2c9a5d1f8b"

merchant_id

string<uuid>

The ID of the merchant for whom the authentication is requested

Example:

"5d6b2c9a-9b0b-4b0c-8c7d-9e9d5d7e9d5d"

number_of_installments

integer

Indicates the maximum number of authorisations permitted for installment payments.

Example:

6

purchase_date

string

The data when the purchase was made. Requires the format yyyyMMddHHmmss and defaults to now.

Example:

"2026-06-01"

⌘I

Get an authentication

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

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

fetch('https://sandbox.hellgate.io/authentications/{id}', 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/authentications/{id}",
  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/authentications/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.hellgate.io/authentications/{id}")

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

{
  "id": "7dcb4365-a948-4b41-a2d2-a7bffa2d3994",
  "amount": 1000,
  "currency_code": "EUR",
  "action_requirement": {
    "type": "use_sdk",
    "session_id": "d5b8e449-13da-4594-bf00-643146fb35d1"
  },
  "created_at": "2023-10-10T00:00:00Z",
  "challenge_preference": "CHALLENGE",
  "purchase_date": "20241010000000",
  "use_case": "ONE_OFF",
  "source": {
    "type": "token",
    "token_id": "71820e49-6822-4df1-8db5-d245456172b6"
  },
  "status": "PROCESSING"
}

{
  "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": 404,
  "message": "The requested resource was not found.",
  "classifier": "NOT_FOUND"
}

Getting Started

Payments

Authentications

Customer Data

Tokens

Configuration

Automation

Authorizations

Path Parameters

Response