How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Formance Payments API

Unified payments connectivity, connectors, and transfers.

Formance Payments API is one of 8 APIs that Formance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 24 operations across 17 paths. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://{organization}.{environment}.formance.cloud.

24 operations 17 paths 0 schemas 3 DELETE13 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://{organization}.{environment}.formance.cloud/api/ledger
Authentication
OAuth 2.0
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Formance Payments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 6 scopes. By default, every request must be authenticated.

  • oauth2 — OAuth2 client-credentials flow. Exchange a client id and secret at /api/auth/oauth/token for a Bearer access token, then send it as Authorization: Bearer .

Paths & Operations 24

Across 17 paths, the API surfaces 24 operations — 3 DELETE, 13 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 24

Unified payments connectivity, connectors, and transfers.

GET
/api/payments/v1/connectors
List all installed connectors
listAllConnectors → 200
GET
/api/payments/v1/connectors/configs
List the configs of each available connector
listConfigsAvailableConnectors → 200
POST
/api/payments/v1/connectors/{connector}
Install a connector
installConnector 1 param → 201
DELETE
/api/payments/v1/connectors/{connector}/{connectorId}
Uninstall a connector
uninstallConnectorV1 2 params → 204
POST
/api/payments/v1/connectors/transfers
Transfer funds between accounts on a connector
connectorsTransfer → 200
GET
/api/payments/v1/accounts
List accounts
listAccountsPayments → 200
POST
/api/payments/v1/accounts
Create an account
createAccount → 200
GET
/api/payments/v1/accounts/{accountId}/balances
Get account balances
getAccountBalances 1 param → 200
GET
/api/payments/v1/payments
List payments
listPayments → 200
POST
/api/payments/v1/payments
Create a payment
createPayment → 200
GET
/api/payments/v1/payments/{paymentId}
Get a payment
getPayment 1 param → 200
GET
/api/payments/v1/bank-accounts
List bank accounts
listBankAccounts → 200
POST
/api/payments/v1/bank-accounts
Create a bank account
createBankAccount → 200
GET
/api/payments/v1/bank-accounts/{bankAccountId}
Get a bank account
getBankAccount 1 param → 200
GET
/api/payments/v1/transfer-initiations
List transfer initiations
listTransferInitiations → 200
POST
/api/payments/v1/transfer-initiations
Create a transfer initiation
createTransferInitiation → 200
GET
/api/payments/v1/transfer-initiations/{transferId}
Get a transfer initiation
getTransferInitiation 1 param → 200
DELETE
/api/payments/v1/transfer-initiations/{transferId}
Delete a transfer initiation
deleteTransferInitiation 1 param → 204
POST
/api/payments/v1/transfer-initiations/{transferId}/status
Update the status of a transfer initiation
updateTransferInitiationStatus 1 param → 204
GET
/api/payments/v1/pools
List pools
listPools → 200
POST
/api/payments/v1/pools
Create a pool
createPool → 200
GET
/api/payments/v1/pools/{poolId}
Get a pool
getPool 1 param → 200
DELETE
/api/payments/v1/pools/{poolId}
Delete a pool
deletePool 1 param → 204
GET
/api/payments/v1/pools/{poolId}/balances
Get pool balances
getPoolBalances 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

formance-payments-api-openapi.yml Raw ↑

Other APIs Formance publishes across the network.

Formance Auth API
Formance Ledger API
Formance Orchestration API
Formance Reconciliation API
Formance Search API
Formance Wallets API
Formance Webhooks API
Where this information came from

This is an independent, third-party profile of Formance Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.