Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xflow FeePlans API

The FeePlans API from Xflow — 2 operation(s) for feeplans.

Xflow FeePlans API is one of 18 APIs that Xflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 2024-02-05.

Requests are made against a single base URL, https://api.xflowpay.com/.

4 operations 2 paths 2 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2024-02-05
Base URL
https://api.xflowpay.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Xflow FeePlans API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

FeePlans 4
GET
/v1/fee_plans
Returns a list of FeePlans.
ListFeePlans 22 params → 200default
POST
/v1/fee_plans
Create a FeePlan.
CreateFeePlan 1 param body → 200default
GET
/v1/fee_plans/{fee_plan}
Retrieves the details of an account.
RetrieveFeePlan 2 params → 200default
POST
/v1/fee_plans/{fee_plan}
Update the details of a FeePlan.
UpdateFeePlan 2 params body → 200default

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are fee_plan (15 properties), error_object (3 properties). Each schema is shown below with its type and property counts.

fee_plan
object
The FeePlan object models the different fees for a platform, direct user and connected user.
15 properties
error_object
object
Xflow uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in…
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xflow-feeplans-api-openapi.yml Raw ↑

Other APIs Xflow publishes across the network.

Xflow Accounts API
Xflow AccountSettings API
Xflow Addresses API
Xflow Balance API
Xflow BalanceTransactions API
Xflow Deposits API
Xflow Events API
Xflow ExchangeRates API
Xflow Files API
Xflow PaymentLinks API
Xflow Payments API
Xflow Payouts API