mirror of
https://github.com/hanzo-fi/stack.git
synced 2026-10-30 20:34:43 +00:00
97 lines
2.2 KiB
YAML
97 lines
2.2 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
|
|
- url: https://{organization}.{environment}.formance.cloud
|
|
description: A per-organization and per-environment API
|
|
variables:
|
|
organization:
|
|
description: The organization name. Defaults to a generic organization.
|
|
default: orgID-stackID
|
|
environment:
|
|
description: The environment name. Defaults to the production environment.
|
|
default: sandbox
|
|
enum:
|
|
- sandbox
|
|
- eu-west-1
|
|
- us-east-1
|
|
|
|
tags:
|
|
- name: ledger.v1
|
|
- name: ledger.v2
|
|
- name: payments.v1
|
|
- name: auth.v1
|
|
- name: orchestration.v1
|
|
- name: orchestration.v2
|
|
- name: reconciliation.v1
|
|
- name: search.v1
|
|
- name: webhooks.v1
|
|
- name: wallets.v1
|
|
|
|
components:
|
|
securitySchemes:
|
|
Authorization:
|
|
type: oauth2
|
|
flows:
|
|
clientCredentials:
|
|
tokenUrl: '/api/auth/oauth/token'
|
|
refreshUrl: '/api/auth/oauth/token'
|
|
scopes: {}
|
|
NoAuthorization:
|
|
type: oauth2
|
|
flows:
|
|
clientCredentials:
|
|
tokenUrl: '/api/auth/oauth/token'
|
|
refreshUrl: '/api/auth/oauth/token'
|
|
scopes: {}
|
|
|
|
x-tagGroups:
|
|
- name: Auth
|
|
tags:
|
|
- auth.v1
|
|
- name: Ledger
|
|
tags:
|
|
- ledger.v1
|
|
- ledger.v2
|
|
- name: Payments
|
|
tags:
|
|
- payments.v1
|
|
- name: Search
|
|
tags:
|
|
- search.v1
|
|
- name: Wallets
|
|
tags:
|
|
- wallets.v1
|
|
- name: Webhooks
|
|
tags:
|
|
- webhooks.v1
|
|
- name: Flows
|
|
tags:
|
|
- orchestration.v1
|
|
- orchestration.v2
|
|
- name: Reconciliation
|
|
tags:
|
|
- reconciliation.v1 |