Execute interceptor - Hellgate Cloud Platform

POST

api

interceptors

{ref}

Execute interceptor

curl --request POST \
  --url https://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref}', 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://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "backend_results": [
    {
      "backend": "<string>",
      "error": "<string>",
      "latency_ms": 123,
      "link_execution_id": "<string>",
      "link_timing": {
        "external": 123,
        "internal": 123,
        "total": 123
      },
      "live": true,
      "missing_fields": [
        "<string>"
      ],
      "raw_response": {},
      "rule_id": "<string>"
    }
  ],
  "context": "checkout",
  "credential_fingerprint": "crd_4ba218...",
  "currency": "<string>",
  "customer_id": "<string>",
  "device_fingerprint": "<string>",
  "device_ip": "<string>",
  "evaluated_at": "2023-11-07T05:31:56Z",
  "events": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "occurred_at": "2023-11-07T05:31:56Z",
      "processed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_backend_error": true,
  "integration": "<string>",
  "interceptor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "latency_us": 4250,
  "masked_credential": "411111 ****** 4242",
  "metadata": {},
  "resolution": {
    "resolved_at": "2023-11-07T05:31:56Z"
  },
  "ruleset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ruleset_version": 123,
  "transaction_reference": "<string>",
  "triggered_rules": [
    {
      "action": "BLOCK",
      "name": "Block USD",
      "rule_id": "r1",
      "type": "condition"
    }
  ],
  "payload": {}
}

{
  "classifier": "NOT_FOUND",
  "code": 404,
  "message": "The requested resource does not exist"
}

{
  "classifier": "NOT_FOUND",
  "code": 404,
  "message": "The requested resource does not exist"
}

{
  "classifier": "NOT_FOUND",
  "code": 404,
  "message": "The requested resource does not exist"
}

Authorizations

Authorization

string

header

required

HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (see Authentication).

Headers

payment-type

string

Payment type declared by the merchant. Controls the initial payment state on the decision.

Path Parameters

ref

string

required

The interceptor's reference

Body

application/json

Acquirer request body

The body is of type object.

Response

Interceptor outcome. On ALLOW the merchant's request is forwarded and the destination's response is returned verbatim. On BLOCK/REVIEW the body is either the configured template response or, in decision mode, the decision result shown below.

Decision body returned by the interceptor runtime endpoint when it produces a decision (BLOCK or REVIEW in decision response mode). Identical to the standard decision result plus the interceptor-specific payment_type, payment_state, and payload fields.

string<uuid>

Unique decision identifier

amount

integer | null

backend_results

BackendResult · object[]

One entry per backend rule that was executed.

Show child attributes

context

string

Example:

"checkout"

credential_fingerprint

string

Deterministic HMAC-SHA256 card instrument identifier

Example:

"crd_4ba218..."

credential_type

enum<string> | null

Type of credential supplied in the request

Available options:

pan,

masked_pan,

sepa

currency

string | null

customer_id

string | null

decision

enum<string>

BLOCK terminates on first match. REVIEW accumulates. ALLOW is the default when no rules match.

Available options:

ALLOW,

BLOCK,

REVIEW,

PROVISIONAL

device_fingerprint

string | null

device_ip

string | null

evaluated_at

string<date-time>

events

object[]

Always empty on a freshly evaluated decision.

Show child attributes

has_backend_error

boolean

True if any backend_results entry carries a non-nil error (e.g. "backend_capability_disabled").

integration

string | null

Integration type that originated this decision (e.g. 'interceptor')

interceptor_id

string<uuid> | null

ID of the interceptor that originated this decision

latency_us

integer

Example:

4250

masked_credential

string | null

Display-safe masked representation, e.g. '411111 ****** 4242'

Example:

"411111 ****** 4242"

metadata

object | null

Merchant-supplied key-value pairs stored with the decision.

Show child attributes

resolution

object | null

Always null on a freshly evaluated decision.

Show child attributes

ruleset_id

string<uuid> | null

ruleset_version

integer | null

source

enum<string>

RULE_ENGINE — condition rules only. BACKEND — backend rule(s) only. COMBINED — both.

Available options:

RULE_ENGINE,

BACKEND,

COMBINED

transaction_reference

string | null

triggered_rules

TriggeredRule · object[]

Show child attributes

payload

object | null

Masked raw request body captured at intercept time.

payment_state

enum<string> | null

Current payment lifecycle state. Advances as lifecycle events are submitted via POST /api/events.

Available options:

authorized,

captured,

voided,

fraud_reported,

chargedback,

failed

payment_type

enum<string> | null

Payment type declared by the merchant via the payment-type request header.

Available options:

unknown,

authorization,

authorization-and-capture

Ingest lifecycle eventReport a payment lifecycle event for a prior decision so Specter can keep the case and your fraud backends up to date. Reference the decision via `decision_id`. Specter advances the decision's payment state, forwards the event to the backends that participated in that decision, and stores a log entry with each backend's delivery status. A backend that does not support the event type is reported as `skipped` rather than failing the request.

⌘I

Execute interceptor

curl --request POST \
  --url https://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref}', 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://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.{env}.on-hellgate.cloud/api/interceptors/{ref}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "backend_results": [
    {
      "backend": "<string>",
      "error": "<string>",
      "latency_ms": 123,
      "link_execution_id": "<string>",
      "link_timing": {
        "external": 123,
        "internal": 123,
        "total": 123
      },
      "live": true,
      "missing_fields": [
        "<string>"
      ],
      "raw_response": {},
      "rule_id": "<string>"
    }
  ],
  "context": "checkout",
  "credential_fingerprint": "crd_4ba218...",
  "currency": "<string>",
  "customer_id": "<string>",
  "device_fingerprint": "<string>",
  "device_ip": "<string>",
  "evaluated_at": "2023-11-07T05:31:56Z",
  "events": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "occurred_at": "2023-11-07T05:31:56Z",
      "processed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_backend_error": true,
  "integration": "<string>",
  "interceptor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "latency_us": 4250,
  "masked_credential": "411111 ****** 4242",
  "metadata": {},
  "resolution": {
    "resolved_at": "2023-11-07T05:31:56Z"
  },
  "ruleset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ruleset_version": 123,
  "transaction_reference": "<string>",
  "triggered_rules": [
    {
      "action": "BLOCK",
      "name": "Block USD",
      "rule_id": "r1",
      "type": "condition"
    }
  ],
  "payload": {}
}

{
  "classifier": "NOT_FOUND",
  "code": 404,
  "message": "The requested resource does not exist"
}

{
  "classifier": "NOT_FOUND",
  "code": 404,
  "message": "The requested resource does not exist"
}

{
  "classifier": "NOT_FOUND",
  "code": 404,
  "message": "The requested resource does not exist"
}