Execute interceptor

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": "1e7b9c0a-2d43-4f6a-8d29-c4a1f2d05b3e",
  "amount": 5000,
  "backend_results": [
    {
      "backend": "vdm",
      "backend_reference": "dec-xyz",
      "decision": "ALLOW",
      "error": "timeout",
      "latency_ms": 42,
      "link_execution_id": "3f8b2d16-71c4-4d29-a5e2-6b9c0d4f7a21",
      "link_timing": {
        "external": 120.5,
        "internal": 8.2,
        "total": 128.7
      },
      "live": true,
      "missing_fields": [
        "device.ip",
        "billing.postal_code"
      ],
      "raw_response": {
        "status": "ACCEPTED",
        "id": "dec-xyz"
      },
      "rule_id": "r1"
    }
  ],
  "context": "checkout",
  "credential_fingerprint": "crd_4ba218...",
  "credential_type": "pan",
  "currency": "USD",
  "customer_id": "customer-123",
  "decision": "ALLOW",
  "device_fingerprint": "fp-9c1e4b7a",
  "device_ip": "1.2.3.4",
  "evaluated_at": "2026-06-01T10:00:00Z",
  "events": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "occurred_at": "2026-06-01T10:04:00Z",
      "processed_at": "2026-06-01T10:04:02Z",
      "type": "authorization"
    }
  ],
  "has_backend_error": false,
  "integration": "interceptor",
  "interceptor_id": null,
  "latency_us": 4250,
  "masked_credential": "411111 •••••• 4242",
  "metadata": {
    "order_ref": "X36Q9C"
  },
  "resolution": {
    "action": "ACCEPTED",
    "resolved_at": "2026-06-01T11:30:00Z"
  },
  "ruleset_id": "6c1f4e8b-9a2d-4c7e-b5f3-8d1a6e9c4b2f",
  "ruleset_version": 7,
  "schema": {
    "name": "transaction",
    "version": 1
  },
  "source": "RULE_ENGINE",
  "transaction_reference": "X36Q9C",
  "triggered_rules": [
    {
      "action": "BLOCK",
      "name": "Block USD",
      "rule_id": "r1",
      "type": "condition"
    }
  ],
  "payload": {
    "billing": {
      "city": "[REDACTED]",
      "country": "[REDACTED]",
      "postal_code": "[REDACTED]"
    },
    "credential": {
      "pan": {
        "expiry_month": 7,
        "expiry_year": 2029,
        "value": "[REDACTED]"
      },
      "type": "pan"
    },
    "customer": {
      "id": "[REDACTED]"
    },
    "device": {
      "ip": "[REDACTED]"
    },
    "transaction": {
      "amount": 4900,
      "currency": "EUR",
      "reference": "ord_001"
    }
  },
  "payment_state": "authorized",
  "payment_type": "unknown"
}

{
  "classifier": "UNAUTHORIZED",
  "code": 401,
  "message": "No valid means of authentication was provided"
}

{
  "classifier": "FORBIDDEN",
  "code": 403,
  "message": "Not allowed to access this resource or feature"
}

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

{
  "classifier": "VALIDATION_ERROR",
  "code": 422,
  "validation_errors": [
    {
      "message": "must be a positive integer",
      "path": "limit"
    }
  ]
}

{
  "classifier": "VALIDATION_ERROR",
  "code": 422,
  "validation_errors": [
    {
      "message": "must be a positive integer",
      "path": "limit"
    }
  ]
}

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.

Example:

"authorization-and-capture"

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

Example:

"1e7b9c0a-2d43-4f6a-8d29-c4a1f2d05b3e"

amount

integer | null

Example:

5000

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 payment credential identifier

Example:

"crd_4ba218..."

credential_type

enum<string> | null

Type of credential supplied in the request

Available options:

pan,

masked_pan,

sepa,

paypal

currency

string | null

Example:

"USD"

customer_id

string | null

Example:

"customer-123"

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

pii

Example:

"fp-9c1e4b7a"

device_ip

string | null

pii

Example:

"1.2.3.4"

evaluated_at

string<date-time>

Example:

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

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

Example:

false

integration

string | null

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

Example:

"interceptor"

interceptor_id

string<uuid> | null

ID of the interceptor that originated this decision

Example:

null

latency_us

integer

Example:

4250

masked_credential

string | null

Display-safe masked representation, e.g. '411111 •••••• 4242' for cards or 's•••@example.com' for PayPal. Identifies nobody on its own, so it carries no classification marker and is not subject to retention.

Example:

"411111 •••••• 4242"

metadata

object | null

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

Show child attributes

Example:

{ "order_ref": "X36Q9C" }

resolution

object | null

Always null on a freshly evaluated decision.

Show child attributes

ruleset_id

string<uuid> | null

Example:

"6c1f4e8b-9a2d-4c7e-b5f3-8d1a6e9c4b2f"

ruleset_version

integer | null

Example:

7

schema

SchemaBinding · object

The (schema, version) the decision was evaluated against — the resolved ruleset's binding.

Show child attributes

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

Example:

"X36Q9C"

triggered_rules

TriggeredRule · object[]

Show child attributes

payload

object | null

Redacted copy of the mapped decision request, captured at intercept time (context omitted). Fields marked pii, pci-pan, or pci-sad and undeclared keys are replaced with [REDACTED]; unmarked fields are stored verbatim. Independent of markers, PAN-like and IBAN-like values and any target whose mapping row sets sensitive: true are removed. Values are removed, not masked.

Example:

{
  "billing": {
    "city": "[REDACTED]",
    "country": "[REDACTED]",
    "postal_code": "[REDACTED]"
  },
  "credential": {
    "pan": {
      "expiry_month": 7,
      "expiry_year": 2029,
      "value": "[REDACTED]"
    },
    "type": "pan"
  },
  "customer": { "id": "[REDACTED]" },
  "device": { "ip": "[REDACTED]" },
  "transaction": {
    "amount": 4900,
    "currency": "EUR",
    "reference": "ord_001"
  }
}

payment_state

enum<string> | null

Current payment lifecycle state. Advances as lifecycle events are submitted via POST /api/events. "fraud_reported" is a legacy value no longer written — fraud is tracked by the fraud marker fields, independent of payment_state.

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

⌘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": "1e7b9c0a-2d43-4f6a-8d29-c4a1f2d05b3e",
  "amount": 5000,
  "backend_results": [
    {
      "backend": "vdm",
      "backend_reference": "dec-xyz",
      "decision": "ALLOW",
      "error": "timeout",
      "latency_ms": 42,
      "link_execution_id": "3f8b2d16-71c4-4d29-a5e2-6b9c0d4f7a21",
      "link_timing": {
        "external": 120.5,
        "internal": 8.2,
        "total": 128.7
      },
      "live": true,
      "missing_fields": [
        "device.ip",
        "billing.postal_code"
      ],
      "raw_response": {
        "status": "ACCEPTED",
        "id": "dec-xyz"
      },
      "rule_id": "r1"
    }
  ],
  "context": "checkout",
  "credential_fingerprint": "crd_4ba218...",
  "credential_type": "pan",
  "currency": "USD",
  "customer_id": "customer-123",
  "decision": "ALLOW",
  "device_fingerprint": "fp-9c1e4b7a",
  "device_ip": "1.2.3.4",
  "evaluated_at": "2026-06-01T10:00:00Z",
  "events": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "occurred_at": "2026-06-01T10:04:00Z",
      "processed_at": "2026-06-01T10:04:02Z",
      "type": "authorization"
    }
  ],
  "has_backend_error": false,
  "integration": "interceptor",
  "interceptor_id": null,
  "latency_us": 4250,
  "masked_credential": "411111 •••••• 4242",
  "metadata": {
    "order_ref": "X36Q9C"
  },
  "resolution": {
    "action": "ACCEPTED",
    "resolved_at": "2026-06-01T11:30:00Z"
  },
  "ruleset_id": "6c1f4e8b-9a2d-4c7e-b5f3-8d1a6e9c4b2f",
  "ruleset_version": 7,
  "schema": {
    "name": "transaction",
    "version": 1
  },
  "source": "RULE_ENGINE",
  "transaction_reference": "X36Q9C",
  "triggered_rules": [
    {
      "action": "BLOCK",
      "name": "Block USD",
      "rule_id": "r1",
      "type": "condition"
    }
  ],
  "payload": {
    "billing": {
      "city": "[REDACTED]",
      "country": "[REDACTED]",
      "postal_code": "[REDACTED]"
    },
    "credential": {
      "pan": {
        "expiry_month": 7,
        "expiry_year": 2029,
        "value": "[REDACTED]"
      },
      "type": "pan"
    },
    "customer": {
      "id": "[REDACTED]"
    },
    "device": {
      "ip": "[REDACTED]"
    },
    "transaction": {
      "amount": 4900,
      "currency": "EUR",
      "reference": "ord_001"
    }
  },
  "payment_state": "authorized",
  "payment_type": "unknown"
}

{
  "classifier": "UNAUTHORIZED",
  "code": 401,
  "message": "No valid means of authentication was provided"
}

{
  "classifier": "FORBIDDEN",
  "code": 403,
  "message": "Not allowed to access this resource or feature"
}

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

{
  "classifier": "VALIDATION_ERROR",
  "code": 422,
  "validation_errors": [
    {
      "message": "must be a positive integer",
      "path": "limit"
    }
  ]
}

{
  "classifier": "VALIDATION_ERROR",
  "code": 422,
  "validation_errors": [
    {
      "message": "must be a positive integer",
      "path": "limit"
    }
  ]
}

Getting Started

Decisions

Lifecycle Events

Admin

Authorizations

Headers

Path Parameters

Body

Response