Revoke an API key immediately (soft, status flag)

curl --request POST \
  --url https://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "meta": {
    "partner_request_id": "cc03...",
    "occurred_at": "2026-06-05T08:20:00Z",
    "sent_at": "2026-06-05T08:20:00Z",
    "api_version": "2026-06-01"
  },
  "context": {
    "merchant_id": "11111111-1111-1111-1111-111111111111"
  },
  "reason": "terminal_decommissioned"
}
'

import requests

url = "https://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke"

payload = {
    "meta": {
        "partner_request_id": "cc03...",
        "occurred_at": "2026-06-05T08:20:00Z",
        "sent_at": "2026-06-05T08:20:00Z",
        "api_version": "2026-06-01"
    },
    "context": { "merchant_id": "11111111-1111-1111-1111-111111111111" },
    "reason": "terminal_decommissioned"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    meta: {
      partner_request_id: 'cc03...',
      occurred_at: '2026-06-05T08:20:00Z',
      sent_at: '2026-06-05T08:20:00Z',
      api_version: '2026-06-01'
    },
    context: {merchant_id: '11111111-1111-1111-1111-111111111111'},
    reason: 'terminal_decommissioned'
  })
};

fetch('https://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke', 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://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke",
  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([
    'meta' => [
        'partner_request_id' => 'cc03...',
        'occurred_at' => '2026-06-05T08:20:00Z',
        'sent_at' => '2026-06-05T08:20:00Z',
        'api_version' => '2026-06-01'
    ],
    'context' => [
        'merchant_id' => '11111111-1111-1111-1111-111111111111'
    ],
    'reason' => 'terminal_decommissioned'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke"

	payload := strings.NewReader("{\n  \"meta\": {\n    \"partner_request_id\": \"cc03...\",\n    \"occurred_at\": \"2026-06-05T08:20:00Z\",\n    \"sent_at\": \"2026-06-05T08:20:00Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"reason\": \"terminal_decommissioned\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("x-api-key", "<api-key>")
	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://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meta\": {\n    \"partner_request_id\": \"cc03...\",\n    \"occurred_at\": \"2026-06-05T08:20:00Z\",\n    \"sent_at\": \"2026-06-05T08:20:00Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"reason\": \"terminal_decommissioned\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"meta\": {\n    \"partner_request_id\": \"cc03...\",\n    \"occurred_at\": \"2026-06-05T08:20:00Z\",\n    \"sent_at\": \"2026-06-05T08:20:00Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"reason\": \"terminal_decommissioned\"\n}"

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

{
  "ok": true,
  "data": {
    "key_id": "ak_01H9X2",
    "status": "inactive",
    "revoked_at": "2026-06-05T08:20:00Z"
  },
  "error": null,
  "meta": {
    "request_id": "req_kr1",
    "idempotency_replayed": false,
    "api_version": "2026-06-01"
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

auth

Revoke an API key immediately (soft, status flag)

Revoke an API key immediately by flipping its status to INACTIVE (a soft revoke: the record is preserved for audit). After revoke, the key fails verification, so no further requests authenticate and no fresh POS terminal JWT can be minted from it; JWTs already minted remain valid until their own 600-second TTL expires (there is no JWT revocation list, the short TTL is the bound). Idempotent on the Idempotency-Key header and idempotent by nature: re-revoking an already-INACTIVE key is a no-op that returns the current revoked state rather than an error. Tenant-scoped: another integration’s key resolves to NOT_FOUND (404). Emits an audit event. Requires the integrations UPDATE permission.

POST

auth

keys

{keyId}

revoke

Revoke an API key immediately (soft, status flag)

curl --request POST \
  --url https://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "meta": {
    "partner_request_id": "cc03...",
    "occurred_at": "2026-06-05T08:20:00Z",
    "sent_at": "2026-06-05T08:20:00Z",
    "api_version": "2026-06-01"
  },
  "context": {
    "merchant_id": "11111111-1111-1111-1111-111111111111"
  },
  "reason": "terminal_decommissioned"
}
'

import requests

url = "https://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke"

payload = {
    "meta": {
        "partner_request_id": "cc03...",
        "occurred_at": "2026-06-05T08:20:00Z",
        "sent_at": "2026-06-05T08:20:00Z",
        "api_version": "2026-06-01"
    },
    "context": { "merchant_id": "11111111-1111-1111-1111-111111111111" },
    "reason": "terminal_decommissioned"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    meta: {
      partner_request_id: 'cc03...',
      occurred_at: '2026-06-05T08:20:00Z',
      sent_at: '2026-06-05T08:20:00Z',
      api_version: '2026-06-01'
    },
    context: {merchant_id: '11111111-1111-1111-1111-111111111111'},
    reason: 'terminal_decommissioned'
  })
};

fetch('https://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke', 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://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke",
  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([
    'meta' => [
        'partner_request_id' => 'cc03...',
        'occurred_at' => '2026-06-05T08:20:00Z',
        'sent_at' => '2026-06-05T08:20:00Z',
        'api_version' => '2026-06-01'
    ],
    'context' => [
        'merchant_id' => '11111111-1111-1111-1111-111111111111'
    ],
    'reason' => 'terminal_decommissioned'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke"

	payload := strings.NewReader("{\n  \"meta\": {\n    \"partner_request_id\": \"cc03...\",\n    \"occurred_at\": \"2026-06-05T08:20:00Z\",\n    \"sent_at\": \"2026-06-05T08:20:00Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"reason\": \"terminal_decommissioned\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("x-api-key", "<api-key>")
	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://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meta\": {\n    \"partner_request_id\": \"cc03...\",\n    \"occurred_at\": \"2026-06-05T08:20:00Z\",\n    \"sent_at\": \"2026-06-05T08:20:00Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"reason\": \"terminal_decommissioned\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.feddi.io/v1/partner/auth/keys/{keyId}/revoke")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"meta\": {\n    \"partner_request_id\": \"cc03...\",\n    \"occurred_at\": \"2026-06-05T08:20:00Z\",\n    \"sent_at\": \"2026-06-05T08:20:00Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"reason\": \"terminal_decommissioned\"\n}"

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

{
  "ok": true,
  "data": {
    "key_id": "ak_01H9X2",
    "status": "inactive",
    "revoked_at": "2026-06-05T08:20:00Z"
  },
  "error": null,
  "meta": {
    "request_id": "req_kr1",
    "idempotency_replayed": false,
    "api_version": "2026-06-01"
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

{
  "ok": true,
  "meta": {
    "request_id": "<string>",
    "api_version": "2026-06-01",
    "idempotency_replayed": true,
    "data_completeness_score": 50,
    "decision_trace_id": "<string>",
    "capabilities": {}
  },
  "data": {},
  "error": {
    "message": "<string>",
    "details": {}
  }
}

Authorizations

x-api-key

string

header

required

Partner API key (platform- or merchant-scoped). Contract key-enforces context.merchant_id.

Headers

Idempotency-Key

string<uuid>

required

Partner-generated UUID; the ONE dedup key for all mutating endpoints. 24h TTL. Same key + same payload -> byte-identical replay; same key + different payload -> IDEMPOTENCY_KEY_REUSED (422).

Path Parameters

keyId

string

required

The API key id to revoke.

Body

application/json

Generic envelope for a no-body key mutation (revoke / regenerate / delete). The canonical envelope plus an optional audit reason.

Response

Key revoked (or already-revoked replay).

The standard response envelope that every enveloped endpoint serializes through. ok is a boolean discriminator: when ok is true, the typed result is carried in data; when ok is false, a typed error object is returned instead. The meta object is uniform across the entire API surface.

boolean

required

Overview

Endpoints

Revoke an API key immediately (soft, status flag)

Authorizations

Headers

Path Parameters

Body

Response