mirror of
https://github.com/hanzo-fi/stack.git
synced 2026-10-30 20:34:43 +00:00
127 lines
2.4 KiB
YAML
127 lines
2.4 KiB
YAML
openapi: 3.0.3
|
|
info:
|
|
title: Formance Stack API
|
|
description: |
|
|
Open, modular foundation for unique payments flows
|
|
|
|
# Introduction
|
|
This API is documented in **OpenAPI format**.
|
|
|
|
# Authentication
|
|
Formance Stack offers one forms of authentication:
|
|
- OAuth2
|
|
OAuth2 - an open protocol to allow secure authorization in a simple
|
|
and standard method from web, mobile and desktop applications.
|
|
<SecurityDefinitions />
|
|
contact:
|
|
name: Formance
|
|
url: https://www.formance.com
|
|
email: [email protected]
|
|
x-logo:
|
|
url: https://avatars.githubusercontent.com/u/84325077?s=200&v=4
|
|
altText: Formance
|
|
version: "SDK_VERSION"
|
|
|
|
servers:
|
|
- url: http://localhost
|
|
description: local server
|
|
|
|
security:
|
|
- Authorization: []
|
|
|
|
components:
|
|
securitySchemes:
|
|
Authorization:
|
|
type: oauth2
|
|
flows:
|
|
clientCredentials:
|
|
tokenUrl: '/api/auth/oauth/token'
|
|
refreshUrl: '/api/auth/oauth/token'
|
|
scopes: {}
|
|
|
|
schemas:
|
|
Version:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
version:
|
|
type: string
|
|
health:
|
|
type: boolean
|
|
required:
|
|
- name
|
|
- version
|
|
- health
|
|
GetVersionsResponse:
|
|
type: object
|
|
properties:
|
|
region:
|
|
type: string
|
|
env:
|
|
type: string
|
|
versions:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Version'
|
|
required:
|
|
- region
|
|
- env
|
|
- versions
|
|
|
|
x-tagGroups:
|
|
- name: Auth
|
|
tags:
|
|
- Clients
|
|
- Scopes
|
|
- Users
|
|
- Auth
|
|
- name: Ledger
|
|
tags:
|
|
- Ledger
|
|
- Server
|
|
- Accounts
|
|
- Mapping
|
|
- Script
|
|
- Stats
|
|
- Transactions
|
|
- Balances
|
|
- server
|
|
- accounts
|
|
- mapping
|
|
- script
|
|
- stats
|
|
- transactions
|
|
- balances
|
|
- name: Payments
|
|
tags:
|
|
- Payments
|
|
- name: Search
|
|
tags:
|
|
- Search
|
|
- name: Wallets
|
|
tags:
|
|
- Wallets
|
|
- name: Webhooks
|
|
tags:
|
|
- Webhooks
|
|
- name: Flows
|
|
tags:
|
|
- Orchestration
|
|
- name: Reconciliation
|
|
tags:
|
|
- Reconciliation
|
|
|
|
paths:
|
|
/versions:
|
|
get:
|
|
summary: Show stack version information
|
|
operationId: getVersions
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetVersionsResponse'
|