Provision a scoped integration API key for a POS terminal

curl --request POST \
  --url https://api.feddi.io/v1/partner/auth/keys \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "meta": {
    "partner_request_id": "9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e",
    "occurred_at": "2026-06-05T08:00:00Z",
    "sent_at": "2026-06-05T08:00:01Z",
    "api_version": "2026-06-01"
  },
  "context": {
    "merchant_id": "11111111-1111-1111-1111-111111111111"
  },
  "enterprise_id": "11111111-1111-1111-1111-111111111111",
  "brand_id": "44444444-4444-4444-4444-444444444444",
  "branch_id": "22222222-2222-2222-2222-222222222222",
  "label": "Al-Olaya Branch POS-360-0007"
}
'

import requests

url = "https://api.feddi.io/v1/partner/auth/keys"

payload = {
    "meta": {
        "partner_request_id": "9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e",
        "occurred_at": "2026-06-05T08:00:00Z",
        "sent_at": "2026-06-05T08:00:01Z",
        "api_version": "2026-06-01"
    },
    "context": { "merchant_id": "11111111-1111-1111-1111-111111111111" },
    "enterprise_id": "11111111-1111-1111-1111-111111111111",
    "brand_id": "44444444-4444-4444-4444-444444444444",
    "branch_id": "22222222-2222-2222-2222-222222222222",
    "label": "Al-Olaya Branch POS-360-0007"
}
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: '9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e',
      occurred_at: '2026-06-05T08:00:00Z',
      sent_at: '2026-06-05T08:00:01Z',
      api_version: '2026-06-01'
    },
    context: {merchant_id: '11111111-1111-1111-1111-111111111111'},
    enterprise_id: '11111111-1111-1111-1111-111111111111',
    brand_id: '44444444-4444-4444-4444-444444444444',
    branch_id: '22222222-2222-2222-2222-222222222222',
    label: 'Al-Olaya Branch POS-360-0007'
  })
};

fetch('https://api.feddi.io/v1/partner/auth/keys', 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",
  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' => '9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e',
        'occurred_at' => '2026-06-05T08:00:00Z',
        'sent_at' => '2026-06-05T08:00:01Z',
        'api_version' => '2026-06-01'
    ],
    'context' => [
        'merchant_id' => '11111111-1111-1111-1111-111111111111'
    ],
    'enterprise_id' => '11111111-1111-1111-1111-111111111111',
    'brand_id' => '44444444-4444-4444-4444-444444444444',
    'branch_id' => '22222222-2222-2222-2222-222222222222',
    'label' => 'Al-Olaya Branch POS-360-0007'
  ]),
  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"

	payload := strings.NewReader("{\n  \"meta\": {\n    \"partner_request_id\": \"9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e\",\n    \"occurred_at\": \"2026-06-05T08:00:00Z\",\n    \"sent_at\": \"2026-06-05T08:00:01Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"enterprise_id\": \"11111111-1111-1111-1111-111111111111\",\n  \"brand_id\": \"44444444-4444-4444-4444-444444444444\",\n  \"branch_id\": \"22222222-2222-2222-2222-222222222222\",\n  \"label\": \"Al-Olaya Branch POS-360-0007\"\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")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meta\": {\n    \"partner_request_id\": \"9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e\",\n    \"occurred_at\": \"2026-06-05T08:00:00Z\",\n    \"sent_at\": \"2026-06-05T08:00:01Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"enterprise_id\": \"11111111-1111-1111-1111-111111111111\",\n  \"brand_id\": \"44444444-4444-4444-4444-444444444444\",\n  \"branch_id\": \"22222222-2222-2222-2222-222222222222\",\n  \"label\": \"Al-Olaya Branch POS-360-0007\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e\",\n    \"occurred_at\": \"2026-06-05T08:00:00Z\",\n    \"sent_at\": \"2026-06-05T08:00:01Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"enterprise_id\": \"11111111-1111-1111-1111-111111111111\",\n  \"brand_id\": \"44444444-4444-4444-4444-444444444444\",\n  \"branch_id\": \"22222222-2222-2222-2222-222222222222\",\n  \"label\": \"Al-Olaya Branch POS-360-0007\"\n}"

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

{
  "ok": true,
  "data": {
    "key_id": "ak_01H9X2",
    "raw_key": "fddi_odo_3pQ8r2kL9wX1mN7vB4tY6zC0sD5fG8hJ",
    "key_prefix": "fddi_odo_3pQ8",
    "key_last_four": "8hJ",
    "scope": "branch",
    "enterprise_id": "11111111-1111-1111-1111-111111111111",
    "brand_id": "44444444-4444-4444-4444-444444444444",
    "branch_id": "22222222-2222-2222-2222-222222222222",
    "label": "Al-Olaya Branch POS-360-0007",
    "is_sandbox": false,
    "status": "active",
    "expires_at": null,
    "created_at": "2026-06-05T08:00:01Z"
  },
  "error": null,
  "meta": {
    "request_id": "req_k1a2",
    "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

Provision a scoped integration API key for a POS terminal

Provisions a new integration API key for a POS terminal or platform integration. The key’s authority scope is determined by which of enterprise_id, brand_id, or branch_id are supplied (most-specific wins): a branch-scoped key can only act on one branch, a brand-scoped key on any branch under that brand, and an enterprise-scoped key on any branch under the enterprise. The raw key is formatted as fddi_<segment>_<base64url(24 random bytes)> and stored only as a hash, alongside a key_prefix (prefix plus 4 chars, used for quick-reject during verification) and key_last_four (for list views). The <segment> is currently odo for ALL providers regardless of POS platform (a historical artifact, not provider-derived): treat key_prefix as an opaque value, never parse a provider out of it, and use the key_prefix field returned here for matching. The raw key is returned EXACTLY ONCE in this response and is never retrievable again: a lost key must be regenerated, not recovered. When a branch_id is supplied, it is validated against the caller’s own authority scope; a branch outside that scope returns FORBIDDEN (403). This is the platform-to-tenant minting handshake: a platform-scoped credential provisions per-merchant or per-branch keys, never a flat shared key. The tenant is the calling integration, and merchant_id is key-enforced, never free-text. Requires the integrations CREATE permission. Idempotent on the Idempotency-Key header: a retried create with the same key and same payload replays the original key record (including the same one-time raw key bytes) with meta.idempotency_replayed: true, while a same-key-different-payload request returns IDEMPOTENCY_KEY_REUSED (422).

POST

auth

keys

curl --request POST \
  --url https://api.feddi.io/v1/partner/auth/keys \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "meta": {
    "partner_request_id": "9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e",
    "occurred_at": "2026-06-05T08:00:00Z",
    "sent_at": "2026-06-05T08:00:01Z",
    "api_version": "2026-06-01"
  },
  "context": {
    "merchant_id": "11111111-1111-1111-1111-111111111111"
  },
  "enterprise_id": "11111111-1111-1111-1111-111111111111",
  "brand_id": "44444444-4444-4444-4444-444444444444",
  "branch_id": "22222222-2222-2222-2222-222222222222",
  "label": "Al-Olaya Branch POS-360-0007"
}
'

import requests

url = "https://api.feddi.io/v1/partner/auth/keys"

payload = {
    "meta": {
        "partner_request_id": "9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e",
        "occurred_at": "2026-06-05T08:00:00Z",
        "sent_at": "2026-06-05T08:00:01Z",
        "api_version": "2026-06-01"
    },
    "context": { "merchant_id": "11111111-1111-1111-1111-111111111111" },
    "enterprise_id": "11111111-1111-1111-1111-111111111111",
    "brand_id": "44444444-4444-4444-4444-444444444444",
    "branch_id": "22222222-2222-2222-2222-222222222222",
    "label": "Al-Olaya Branch POS-360-0007"
}
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: '9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e',
      occurred_at: '2026-06-05T08:00:00Z',
      sent_at: '2026-06-05T08:00:01Z',
      api_version: '2026-06-01'
    },
    context: {merchant_id: '11111111-1111-1111-1111-111111111111'},
    enterprise_id: '11111111-1111-1111-1111-111111111111',
    brand_id: '44444444-4444-4444-4444-444444444444',
    branch_id: '22222222-2222-2222-2222-222222222222',
    label: 'Al-Olaya Branch POS-360-0007'
  })
};

fetch('https://api.feddi.io/v1/partner/auth/keys', 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",
  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' => '9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e',
        'occurred_at' => '2026-06-05T08:00:00Z',
        'sent_at' => '2026-06-05T08:00:01Z',
        'api_version' => '2026-06-01'
    ],
    'context' => [
        'merchant_id' => '11111111-1111-1111-1111-111111111111'
    ],
    'enterprise_id' => '11111111-1111-1111-1111-111111111111',
    'brand_id' => '44444444-4444-4444-4444-444444444444',
    'branch_id' => '22222222-2222-2222-2222-222222222222',
    'label' => 'Al-Olaya Branch POS-360-0007'
  ]),
  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"

	payload := strings.NewReader("{\n  \"meta\": {\n    \"partner_request_id\": \"9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e\",\n    \"occurred_at\": \"2026-06-05T08:00:00Z\",\n    \"sent_at\": \"2026-06-05T08:00:01Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"enterprise_id\": \"11111111-1111-1111-1111-111111111111\",\n  \"brand_id\": \"44444444-4444-4444-4444-444444444444\",\n  \"branch_id\": \"22222222-2222-2222-2222-222222222222\",\n  \"label\": \"Al-Olaya Branch POS-360-0007\"\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")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meta\": {\n    \"partner_request_id\": \"9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e\",\n    \"occurred_at\": \"2026-06-05T08:00:00Z\",\n    \"sent_at\": \"2026-06-05T08:00:01Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"enterprise_id\": \"11111111-1111-1111-1111-111111111111\",\n  \"brand_id\": \"44444444-4444-4444-4444-444444444444\",\n  \"branch_id\": \"22222222-2222-2222-2222-222222222222\",\n  \"label\": \"Al-Olaya Branch POS-360-0007\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"9a1c4e22-7b3f-4d0a-8e21-0f9c2d3b4a5e\",\n    \"occurred_at\": \"2026-06-05T08:00:00Z\",\n    \"sent_at\": \"2026-06-05T08:00:01Z\",\n    \"api_version\": \"2026-06-01\"\n  },\n  \"context\": {\n    \"merchant_id\": \"11111111-1111-1111-1111-111111111111\"\n  },\n  \"enterprise_id\": \"11111111-1111-1111-1111-111111111111\",\n  \"brand_id\": \"44444444-4444-4444-4444-444444444444\",\n  \"branch_id\": \"22222222-2222-2222-2222-222222222222\",\n  \"label\": \"Al-Olaya Branch POS-360-0007\"\n}"

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

{
  "ok": true,
  "data": {
    "key_id": "ak_01H9X2",
    "raw_key": "fddi_odo_3pQ8r2kL9wX1mN7vB4tY6zC0sD5fG8hJ",
    "key_prefix": "fddi_odo_3pQ8",
    "key_last_four": "8hJ",
    "scope": "branch",
    "enterprise_id": "11111111-1111-1111-1111-111111111111",
    "brand_id": "44444444-4444-4444-4444-444444444444",
    "branch_id": "22222222-2222-2222-2222-222222222222",
    "label": "Al-Olaya Branch POS-360-0007",
    "is_sandbox": false,
    "status": "active",
    "expires_at": null,
    "created_at": "2026-06-05T08:00:01Z"
  },
  "error": null,
  "meta": {
    "request_id": "req_k1a2",
    "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).

Body

application/json

Provision a scoped integration API key. Scope is set by which of enterprise/brand/branch are supplied (most-specific wins). merchant_id in context is key-enforced.

Response

Key provisioned. raw_key is present ONLY in this response (or an idempotent replay of it) and is never returned again.

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

Provision a scoped integration API key for a POS terminal

Authorizations

Headers

Body

Response