Hard-delete an API key (deprovision / error cleanup)

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

import requests

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

payload = {
    "meta": {
        "partner_request_id": "ee05...",
        "occurred_at": "2026-06-05T08:40:00Z",
        "sent_at": "2026-06-05T08:40:00Z",
        "api_version": "2026-06-01"
    },
    "context": { "merchant_id": "11111111-1111-1111-1111-111111111111" },
    "reason": "provisioning_error_cleanup"
}
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: 'ee05...',
      occurred_at: '2026-06-05T08:40:00Z',
      sent_at: '2026-06-05T08:40:00Z',
      api_version: '2026-06-01'
    },
    context: {merchant_id: '11111111-1111-1111-1111-111111111111'},
    reason: 'provisioning_error_cleanup'
  })
};

fetch('https://api.feddi.io/v1/partner/auth/keys/{keyId}/delete', 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}/delete",
  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' => 'ee05...',
        'occurred_at' => '2026-06-05T08:40:00Z',
        'sent_at' => '2026-06-05T08:40:00Z',
        'api_version' => '2026-06-01'
    ],
    'context' => [
        'merchant_id' => '11111111-1111-1111-1111-111111111111'
    ],
    'reason' => 'provisioning_error_cleanup'
  ]),
  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}/delete"

	payload := strings.NewReader("{\n  \"meta\": {\n    \"partner_request_id\": \"ee05...\",\n    \"occurred_at\": \"2026-06-05T08:40:00Z\",\n    \"sent_at\": \"2026-06-05T08:40:00Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"reason\": \"provisioning_error_cleanup\"\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}/delete")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meta\": {\n    \"partner_request_id\": \"ee05...\",\n    \"occurred_at\": \"2026-06-05T08:40:00Z\",\n    \"sent_at\": \"2026-06-05T08:40:00Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"reason\": \"provisioning_error_cleanup\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"ee05...\",\n    \"occurred_at\": \"2026-06-05T08:40:00Z\",\n    \"sent_at\": \"2026-06-05T08:40:00Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"reason\": \"provisioning_error_cleanup\"\n}"

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

{
  "ok": true,
  "data": {
    "key_id": "ak_01H9X2",
    "status": "deleted",
    "deleted_at": "2026-06-05T08:40:00Z"
  },
  "error": null,
  "meta": {
    "request_id": "req_kd1",
    "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

Hard-delete an API key (deprovision / error cleanup)

Permanently delete an API key record (deprovision a retired terminal or clean up a provisioning error). Modeled as POST (not HTTP DELETE) so it carries the canonical envelope and Idempotency-Key header uniformly with the rest of the mutating surface. After delete, the key fails verification and no JWT can be minted; unlike revoke, the record is removed (use revoke for a reversible, audited soft state, and delete for true deprovisioning). The audit event is preserved even though the record is removed. Idempotent on the Idempotency-Key header and idempotent by nature: deleting an already-deleted key replays a deleted-state result rather than a 404 when the same idempotency key is reused; a fresh request against an unknown id returns NOT_FOUND. The Idempotency-Key (not the key id) governs this outcome: replay of the original key returns 200, any fresh key against a removed record returns 404. Tenant-scoped: another integration’s key resolves to NOT_FOUND (404). Requires the integrations DELETE permission.

POST

auth

keys

{keyId}

delete

Hard-delete an API key (deprovision / error cleanup)

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

import requests

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

payload = {
    "meta": {
        "partner_request_id": "ee05...",
        "occurred_at": "2026-06-05T08:40:00Z",
        "sent_at": "2026-06-05T08:40:00Z",
        "api_version": "2026-06-01"
    },
    "context": { "merchant_id": "11111111-1111-1111-1111-111111111111" },
    "reason": "provisioning_error_cleanup"
}
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: 'ee05...',
      occurred_at: '2026-06-05T08:40:00Z',
      sent_at: '2026-06-05T08:40:00Z',
      api_version: '2026-06-01'
    },
    context: {merchant_id: '11111111-1111-1111-1111-111111111111'},
    reason: 'provisioning_error_cleanup'
  })
};

fetch('https://api.feddi.io/v1/partner/auth/keys/{keyId}/delete', 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}/delete",
  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' => 'ee05...',
        'occurred_at' => '2026-06-05T08:40:00Z',
        'sent_at' => '2026-06-05T08:40:00Z',
        'api_version' => '2026-06-01'
    ],
    'context' => [
        'merchant_id' => '11111111-1111-1111-1111-111111111111'
    ],
    'reason' => 'provisioning_error_cleanup'
  ]),
  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}/delete"

	payload := strings.NewReader("{\n  \"meta\": {\n    \"partner_request_id\": \"ee05...\",\n    \"occurred_at\": \"2026-06-05T08:40:00Z\",\n    \"sent_at\": \"2026-06-05T08:40:00Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"reason\": \"provisioning_error_cleanup\"\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}/delete")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meta\": {\n    \"partner_request_id\": \"ee05...\",\n    \"occurred_at\": \"2026-06-05T08:40:00Z\",\n    \"sent_at\": \"2026-06-05T08:40:00Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"reason\": \"provisioning_error_cleanup\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"ee05...\",\n    \"occurred_at\": \"2026-06-05T08:40:00Z\",\n    \"sent_at\": \"2026-06-05T08:40:00Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"reason\": \"provisioning_error_cleanup\"\n}"

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

{
  "ok": true,
  "data": {
    "key_id": "ak_01H9X2",
    "status": "deleted",
    "deleted_at": "2026-06-05T08:40:00Z"
  },
  "error": null,
  "meta": {
    "request_id": "req_kd1",
    "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 delete.

Body

application/json

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

Response

Key deleted (or idempotent replay of a prior delete).

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

Hard-delete an API key (deprovision / error cleanup)

Authorizations

Headers

Path Parameters

Body

Response