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

Weavr Fees API

The Fees API from Weavr — 4 operation(s) for fees.

Weavr Fees API is one of 43 APIs that Weavr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Fees. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 4 paths, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version v3.

Requests are made against a single base URL, https://sandbox.weavr.io/multi/backoffice.

4 operations 4 paths 15 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v3
Base URL
https://api.weavr.io/multi
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Weavr Fees API declares 2 security schemes for authenticating requests. An API key is passed in the header as api-key (api_key). It accepts HTTP bearer tokens (JWT) (auth_token).

  • api_key — The API Key representing your Multi account.
  • auth_token — The authentication token representing the user. This will be included in the login response object.

Paths & Operations 4

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

Fees 4
POST
/fees/charge
Charge identity a pre-defined custom fee
chargeFee 1 param body → 200400401403404409500503
POST
/corporates/fees/charge
Charge fee to a corporate
corporateChargeFee 1 param body → 200400401403404409429500
GET
/fees
(NEW) Get all fees
feesGet 5 params → 200400401403429500503default
POST
/consumers/fees/charge
Charge fee to a consumer
consumerChargeFee 1 param body → 200400401403409429500503

Schemas 15

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

CurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties 2 required
FeeSubtype
string
The category of fee — indicates the activity or instrument-lifecycle event the fee relates to.
Fee
object
2 properties 2 required
SyntaxError
object
Is returned as part of an HTTP error response whenever a syntax error is detected. A list of the fields together with their syntax error will be provided.
1 property
TransactionState
string
Status of the transaction.
FeeTransactionList
object
A paginated list of fee transactions.
3 properties
FeeTransactionStatus
string
Lifecycle status of a fee transaction: - PENDING: Fee accompanies a transaction that is still processing; it may still be cancelled. - COMPLETED: Fee was charg…
TransactionId
object
2 properties 2 required
FeeTransaction
object
A fee charged or reversed on an instrument. Surfaced through GET /fees, GET /transactions (Transaction Activity), and as line items on statements.
9 properties 6 required
ChargeFee
object
7 properties 8 required
InstrumentType
string
InstrumentId
object
2 properties 2 required
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
Id
string
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-fees-api-openapi.yml Raw ↑

Other APIs Weavr publishes across the network.

Weavr Access Token API
Weavr Access Tokens API
Weavr Accounts API
Weavr Additional Factors API
Weavr Authentication Factors API
Weavr Authorised Signatories API
Weavr Authorised Users API
Weavr Buyer Authorised Users API
Weavr Buyers API
Weavr Card Payments API
Weavr Cards API
Weavr Confirmation Challenges API