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

The Transfers API from Weavr — 3 operation(s) for transfers.

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

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

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

Transfers 4
POST
/transfers
Create a transfer transaction
transferCreate 1 param body → 200400401403409500503default
GET
/transfers
Get all transfer transactions
transfersGet 8 params → 200400401403500503default
GET
/transfers/{id}
Get a transfer transaction
transferGet 1 param → 200400401403404500503default
POST
/transfers/bulk/cancel
Cancel transfer transactions
transferCancel body → 200400401429500503default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Transfer (12 properties), TransactionCancelResponse (3 properties), Error (2 properties), TransactionCancelRequest (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
ValidationError
array
Is returned as part of an HTTP error response whenever a validation error is detected. A list of the fields together with their syntax error will be provided.
TransactionCancellationReason
string
The reason the scheduled transaction was cancelled.
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.
ScheduledTimestamp
string
The epoch timestamp at which the transaction is scheduled to be executed.
Transfer
object
12 properties 7 required
TransactionCancelResponse
object
3 properties 2 required
TransactionBulkCancelRequest
object
1 property 1 required
InstrumentType
string
InstrumentId
object
2 properties 2 required
ProfileId
string
The profile Id which a specific identity, instrument or transaction type is linked to. Profiles contain configuration and determine behavioral aspects of the n…
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
Id
string
TransactionBulkCancelResponse
object
1 property 1 required
TransactionCancelRequest
object
2 properties 1 required
Error
object
2 properties
ExecutionTimestamp
string
The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.
Tag
string
The tag field is a custom field that can be used to search and filter.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-transfers-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