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

The Send transaction is used to send funds between managed accounts and managed cards belonging to different identities.

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

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

This API exposes 7 operations across 6 paths, and defines 21 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.

7 operations 6 paths 21 schemas 2 GET5 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 Sends 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 7

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

Sends 7

The Send transaction is used to send funds between managed accounts and managed cards belonging to different identities.

POST
/sends
Create a send transaction
sendCreate 1 param body → 200400401403409429500503
GET
/sends
Get all send transactions
sendsGet 12 params → 200400401403429500503default
GET
/sends/{id}
Get a send transaction
sendGet 1 param → 200400401403404429500503
POST
/sends/{id}/cancel
Cancel a send transaction
sendSingleCancel 1 param body → 200400401403404409429500
POST
/sends/{id}/challenges/otp/{channel}deprecated
Issue a one-time password that can be used to verify a send
sendSCAChallenge 2 params → 204400401403405409429500
POST
/sends/{id}/challenges/otp/{channel}/verifydeprecated
Verify a send using a one-time password
sendSCAVerify 2 params body → 204400401403409429500503
POST
/sends/{id}/challenges/push/{channel}deprecated
Issue a push notification that can be used to verify Send transaction
sendSCAChallengePush 2 params → 204400401403405409429500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Send (16 properties), SendCreateRequest (7 properties), InstrumentId (2 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
TransactionCancellationReason
string
The reason the scheduled transaction was cancelled.
Send
object
16 properties 7 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
BeneficiaryId
object
1 property 1 required
ScheduledTimestamp
string
The epoch timestamp at which the transaction is scheduled to be executed.
TransactionSingleCancelRequest
object
1 property
Nonce
string
A randomly generated one-time use code.
ChallengeExemptionReason
string
The Reason the transaction was exempted from SCA verification
SCAPushChannel
string
- "AUTHY": The push notification is sent on the user's device using [Twilio Authy](https://www.twilio.com/authy) - "BIOMETRIC": The push notification is sent t…
SCAOtpChannel
string
- "SMS": The one-time-password is sent as a text message
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
Error
object
2 properties
SendCreateRequest
object
7 properties 4 required
SendState
string
The state of the send transaction, as follows: - INVALID: The send transaction has failed initial validation checks. - INITIALISED: The initial state of a send…
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-sends-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