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

The Operations API from Weavr — 9 operation(s) for operations.

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

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

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

9 operations 9 paths 37 schemas 1 PATCH8 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 Operations 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 9

Across 9 paths, the API surfaces 9 operations — 1 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 9
PATCH
/bulks/managed_cards/_id_/spend_rules
Update spend rules for a managed card
bulksManagedCardSpendRulesUpdate 1 param body → 201
POST
/bulks/transfers
Create transfer transactions in bulk
bulksTransferCreate 1 param body → 201
POST
/bulks/users
Create users in bulk
bulksUserCreate 1 param body → 201
POST
/bulks/users/_user_id_/invite
Send user invites in bulk
bulksUserInviteSend 1 param body → 201
POST
/bulks/managed_cards/_id_/block
Block cards in bulk
bulksManagedCardBlock 1 param body → 201
POST
/bulks/managed_cards/_id_/unblock
Unblock cards in bulk
bulksManagedCardUnblock 1 param body → 201
POST
/bulks/managed_cards/_id_/remove
Remove cards in bulk
bulksManagedCardRemove body → 201
POST
/bulks/sends
Create send transactions in bulk
bulksSendCreate 1 param body → 201
POST
/bulks/outgoing_wire_transfers
Create an outgoing wire transfer in bulk
bulksOutgoingWireTransferCreate 1 param body → 201

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are CommonLevelSpendRules (12 properties), FasterPaymentsBeneficiary (11 properties), RIXBeneficiary (9 properties), SEPABeneficiary (9 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
SpendLimit
object
3 properties 2 required
FasterPaymentsBankDetailsOrBACSBankDetails
object
Bank details used in case the wire transfer is executed over Faster Payments.
3 properties 2 required
BaseCardLevelSpendRules
Brand
string
Brand identifier used to determine the set of email and SMS user notification templates. Must be alphanumeric, up to 25 characters, and contain no spaces.
CommonLevelSpendRules
object
12 properties
UserId
string
Date
object
3 properties 3 required
UserLocale
string
BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
OutgoingWireTransferBeneficiary
object
Details of the beneficiary of the outgoing wire transfer. Deprecated: Use SEPABeneficiary for SEPA/IBAN transfers or FasterPaymentsBeneficiary for Faster Payme…
9 properties 2 required
ExternalAccountId
object
The id of an external account, such as a Linked Account, registered with the Weavr Platform.
2 properties 2 required
BeneficiaryId
object
1 property 1 required
CardLevelSpendRules
IBANDetails
object
Bank details used in case the wire transfer is executed over SEPA or RIX
2 properties 1 required
ScheduledTimestamp
string
The epoch timestamp at which the transaction is scheduled to be executed.
OutgoingWireTransferCreateRequest
object
8 properties 4 required
SEPABeneficiary
object
Beneficiary details for SEPA/IBAN wire transfers.
9 properties 2 required
ExternalAccountType
string
UpdateCardLevelSpendRules
SpendLimitInterval
string
The time period for which the spendLimit is valid. - DAILY: starting from 00:00:00 UTC of current day to 23:59:59 UTC of current day - WEEKLY: 00:00:00 UTC Mon…
DateOfBirth
string
The date of birth in ISO 8601 format (YYYY-MM-DD).
Email
string
E-mail Address of the user
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…
RIXBeneficiary
object
Beneficiary details for RIX wire transfers.
9 properties 2 required
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
Id
string
SWIFTBeneficiary
object
Beneficiary details for SWIFT wire transfers.
9 properties 4 required
Mobile
object
2 properties 2 required
UserPredefinedRole
string
SpendLimitUpdateMethod
string
The spend limit update method to apply. Currently supported: - OVERWRITE: (default option if nothing selected). Overwrites the previous values for the spendLim…
SendCreateRequest
object
7 properties 4 required
Nationality
string
Nationality of the user - using ISO 3166 alpha-2.
FasterPaymentsBeneficiary
object
Beneficiary details for Faster Payments wire transfers.
11 properties 4 required
RolloverPolicy
object
The rollover policy will dictate how Weavr handles any eventual overspending. This is possible if a merchant clears more funds than authorised, or when a merch…
1 property 1 required
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-operations-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