Initial MakePay OpenAPI workspace

Author: Ethan Carter

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @makepayio

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 5

.github/workflows/validate.yml

@@ -0,0 +1,22 @@
+name: validate
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - run: npm ci
+      - run: npm run validate

.gitignore

@@ -0,0 +1,7 @@
+node_modules/
+.DS_Store
+.env
+.env.*
+!.env.example
+coverage/
+dist/

.redocly.yaml

@@ -0,0 +1,5 @@
+extends:
+  - recommended
+
+rules:
+  operation-4xx-response: off

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+Thanks for helping improve the MakePay API artifacts.
+
+## Development
+
+```bash
+npm install
+npm run validate
+```
+
+## Pull Requests
+
+- Keep OpenAPI operation IDs stable unless an endpoint is intentionally
+  replaced.
+- Add or update a Postman request when adding a new endpoint group.
+- Use example values only. Never commit live merchant credentials, webhook
+  secrets, wallet private keys, customer data, or production payload dumps.
+- Keep compatibility with generators that consume OpenAPI 3.1.
+
+## Release Checklist
+
+- `npm run validate` passes.
+- The Postman collection imports without JSON errors.
+- New endpoint descriptions include authentication, idempotency, and webhook
+  behavior where relevant.
+- Branch protection and required validation checks are enabled for `main`.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MakeCrypto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,68 @@
+# MakePay OpenAPI and Postman
+
+Canonical OpenAPI and Postman artifacts for MakePay partner, hosted checkout,
+webhook, Simple Shop, subscription, POS, product, branding, and bookkeeping
+APIs.
+
+## Contents
+
+- `openapi/makepay.openapi.yaml` - OpenAPI 3.1 description for MakePay.
+- `postman/makepay.postman_collection.json` - Postman collection with common
+  merchant, checkout, and bookkeeping workflows.
+- `postman/makepay.postman_environment.json` - Postman environment variables.
+- `docs/ROADMAP.md` - planning and ownership notes for this integration.
+- `docs/REPOSITORY_PROTECTION.md` - required GitHub repository settings.
+
+## Quick Start
+
+```bash
+npm install
+npm run validate
+```
+
+Import the collection and environment into Postman, then set:
+
+- `makepayKeyId`
+- `makepayKeySecret`
+- `paymentLinkUid` after creating a test payment link
+- `sessionId` after quoting a public checkout session
+
+## Authentication
+
+Server-side partner API calls use API key headers:
+
+```http
+X-MakeCrypto-Key-Id: <key id>
+X-MakeCrypto-Key-Secret: <key secret>
+```
+
+The API also accepts `X-MakePay-Key-Id` / `X-MakePay-Key-Secret` and
+`X-Api-Key` / `X-Api-Secret` aliases for compatible integrations.
+
+Never expose key secrets in browser code, mobile apps, public repositories, or
+client-side logs.
+
+## Webhooks
+
+MakePay sends signed webhook events with:
+
+```http
+X-MakePay-Signature: t=<unix timestamp>,v1=<hmac sha256 hex digest>
+```
+
+Verify the signature against:
+
+```text
+<timestamp>.<raw request body>
+```
+
+using the merchant webhook secret. Reject stale timestamps, compare signatures
+in constant time, and deduplicate deliveries by `deliveryId`.
+
+## Publishing
+
+This repository is intended to be published as `makecryptoio/makepay-openapi`.
+The `main` branch should require the `validate` GitHub Actions workflow before
+merge.
+
+Maintainer: Ethan Carter (`makepayio`).

SECURITY.md

@@ -0,0 +1,17 @@
+# Security Policy
+
+## Supported Artifacts
+
+The current supported artifacts are:
+
+- `openapi/makepay.openapi.yaml`
+- `postman/makepay.postman_collection.json`
+- `postman/makepay.postman_environment.json`
+
+## Reporting Vulnerabilities
+
+Email security reports to `info@makepay.io`.
+
+Do not include live API key secrets, webhook secrets, wallet private keys, or
+customer data in an issue or pull request. Use redacted examples and include
+enough detail to reproduce the problem safely.