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

The Events API from Xflow — 2 operation(s) for events.

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

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

This API exposes 2 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/.

2 operations 2 paths 2 schemas 2 GET

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 Events 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 2

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

Events 2
GET
/v1/events
Returns a list of events.
ListEvents 13 params → 200default
GET
/v1/events/{event}
Retrieves the details of an event.
RetrieveEvent 2 params → 200default

Schemas 2

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

event
object
Events are Xflow's way of letting you know when something interesting happens in your account. When an interesting event occurs, we create a new event object.…
8 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-events-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 ExchangeRates API
Xflow FeePlans API
Xflow Files API
Xflow PaymentLinks API
Xflow Payments API
Xflow Payouts API