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 AccountSettings API

The AccountSettings API from Xflow — 3 operation(s) for accountsettings.

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

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

This API exposes 4 operations across 3 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 3 paths 2 schemas 3 GET1 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 AccountSettings 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 3 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

AccountSettings 4
GET
/v1/account_settings
This endpoint returns all AccountSettings (filtered by the applied below query parameters) associated with the platform, connected user or direct user in question.
ListAccountSettings 17 params → 200default
GET
/v1/account_settings/connected
This endpoint returns all AccountSettings (filtered by the applied below query parameters) associated with the connected users of a platform.
ListAccountSettingsConnected 17 params → 200default
GET
/v1/account_settings/{account_setting}
Retrieves the details of an AccountSetting.
RetrieveAccountSetting 2 params → 200default
POST
/v1/account_settings/{account_setting}
Update the details of an AccountSetting.
UpdateAccountSetting 2 params body → 200default

Schemas 2

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

account_setting
object
Account objects are fundamental to Xflow and model entities like direct users, connected users, partners and platforms. Depending on whether you are setup as a…
9 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-accountsettings-api-openapi.yml Raw ↑

Other APIs Xflow publishes across the network.

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