Weavr Operations API
The Operations API from Weavr — 9 operation(s) for operations.
OpenAPI Specification
openapi: 3.1.0
info:
version: v3
title: Weavr Multi Product BackOffice Access Token Operations API
x-logo:
url: https://storage.googleapis.com/weavr-cdn/weavr_logo-new.png
backgroundColor: '#FFFFFF'
altText: Weavr
description: 'Weavr Multi Back Office API allows you, as an innovator, to perform various back office operations concerning
identities and their instruments, without requiring the users to be logged in.
A token is to be obtained through the `access_token` method, and this will allow relevant operations
to be performed on behalf of this same identity.
'
contact:
name: Weavr
url: https://weavr.io
servers:
- description: Weavr Sandbox Environment
url: https://sandbox.weavr.io/multi/backoffice
tags:
- name: Operations
paths:
/bulks/managed_cards/_id_/spend_rules:
patch:
tags:
- Operations
summary: Update spend rules for a managed card
operationId: bulksManagedCardSpendRulesUpdate
description: 'Submit the details to update the spend rules of Managed Cards.
The bulkId returned in the response can subsequently be used to launch the updating of Managed Card spend rules process through <Execute bulk process>. A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any other Authorised User of the same identity of the user that submits the details.
The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.
The submission of data for a bulk process does not expire but it can be cancelled through <Cancel bulk process>.
The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations.
Each spend rules update operation in this bulk process is processed via <Managed Cards > Update a Managed Card.
'
parameters:
- $ref: '#/components/parameters/idempotency-ref'
responses:
'201':
description: Success - returning bulk process
content:
application/json:
schema:
type: object
properties:
bulkId:
type: string
operationCount:
type: integer
path:
type: string
security:
- auth_token: []
api_key: []
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
pathParams:
type: object
properties:
_id_:
type: string
pattern: ^[0-9]+$
requestBody:
$ref: '#/components/schemas/UpdateCardLevelSpendRules'
maxItems: 10000
minItems: 1
/bulks/transfers:
post:
tags:
- Operations
description: 'Submit the details for the creation of a batch of Transfers.
The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through [Execute Bulk Process](#tag/Manage/operation/bulkIdExecute). A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details.
The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.
The submission of data for a bulk process does not expire but it can be cancelled through [Cancel Bulk Process](#tag/Manage/operation/bulkIdCancel).
The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations.
Each individual operation in this bulk will be processed via [Create a Transfer Transaction](#tag/Transfers/operation/transferCreate).
'
summary: Create transfer transactions in bulk
operationId: bulksTransferCreate
parameters:
- $ref: '#/components/parameters/idempotency-ref'
responses:
'201':
description: Success - returning bulk process
content:
application/json:
schema:
type: object
properties:
bulkId:
type: string
operationCount:
type: integer
path:
type: string
security:
- auth_token: []
api_key: []
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
pathParams:
type: object
properties: {}
requestBody:
required:
- profileId
- source
- destination
- destinationAmount
type: object
properties:
profileId:
$ref: '#/components/schemas/ProfileId'
tag:
$ref: '#/components/schemas/Tag'
source:
description: The managed account or managed card from where the funds will be transferred.
$ref: '#/components/schemas/InstrumentId'
description:
type: string
maxLength: 255
pattern: ^[a-zA-Z0-9\/\-?:().$_,'+\s#=!"%&*<>;\{@\r\n]*$
description: The description details that are included in the transaction as reference.
destination:
description: The managed account or managed card to where the funds will be transferred.
$ref: '#/components/schemas/InstrumentId'
destinationAmount:
description: The amount, in same currency as the source and destination instruments, to be transferred to the destination (exclusive of any fee amount that may be specified in the profile).
$ref: '#/components/schemas/CurrencyAmount'
scheduledTimestamp:
$ref: '#/components/schemas/ScheduledTimestamp'
maxItems: 10000
minItems: 1
/bulks/users:
post:
x-permissions:
- i:users:create
tags:
- Operations
description: "Submit the details for the creation of a batch of Authorised Users \n\nThe bulkId returned in the response can subsequently be used to launch the execution of the bulk process through [Execute Bulk Process](#tag/Manage/operation/bulkIdExecute). A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details.\n\nThe status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.\n\nThe submission of data for a bulk process does not expire but it can be cancelled through [Cancel Bulk Process](#tag/Manage/operation/bulkIdCancel).\n\nThe system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations\n\nEach individual operation in this bulk will be processed via [Create a User](#tag/Setup/operation/userCreate).\n"
summary: Create users in bulk
operationId: bulksUserCreate
parameters:
- $ref: '#/components/parameters/idempotency-ref'
responses:
'201':
description: Success - returning bulk process
content:
application/json:
schema:
type: object
properties:
bulkId:
type: string
operationCount:
type: integer
path:
type: string
security:
- auth_token: []
api-key: []
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
pathParams:
type: object
properties: {}
requestBody:
required:
- email
- name
- surname
type: object
properties:
name:
minLength: 1
maxLength: 50
type: string
description: The first name of the user.
surname:
minLength: 1
maxLength: 50
type: string
description: The last name of the user.
email:
$ref: '#/components/schemas/Email'
mobile:
$ref: '#/components/schemas/Mobile'
dateOfBirth:
description: Date of birth of the authorised user.
$ref: '#/components/schemas/Date'
tag:
$ref: '#/components/schemas/Tag'
countryOfResidence:
type: string
maxLength: 2
minLength: 2
pattern: ^[A-Z]+$
locale:
$ref: '#/components/schemas/UserLocale'
brand:
$ref: '#/components/schemas/Brand'
roles:
type: array
items:
$ref: '#/components/schemas/UserPredefinedRole'
description: Optional roles to assign to the user. For a full description of the permissions associated with each role, see our product documentation.
maxItems: 10000
minItems: 1
/bulks/users/_user_id_/invite:
post:
x-permissions:
- i:users:send_invite
tags:
- Operations
summary: Send user invites in bulk
operationId: bulksUserInviteSend
description: 'Submit the details for the creation of a batch of Authorised User invites
The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through [Execute Bulk Process](#tag/Manage/operation/bulkIdExecute). A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details.
The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.
The submission of data for a bulk process does not expire but it can be cancelled through [Cancel Bulk Process](#tag/Manage/operation/bulkIdCancel).
The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations
Each individual operation in this bulk will be processed via [Send a User Invite](#tag/Authorised-Users/operation/userInviteSend).
'
parameters:
- $ref: '#/components/parameters/idempotency-ref'
responses:
'201':
description: Success - returning bulk process
content:
application/json:
schema:
type: object
properties:
bulkId:
type: string
operationCount:
type: integer
path:
type: string
security:
- auth_token: []
api-key: []
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
pathParams:
type: object
properties:
_user_id_:
$ref: '#/components/schemas/UserId'
maxItems: 10000
minItems: 1
/bulks/managed_cards/_id_/block:
post:
tags:
- Operations
description: 'Submit the details to block Managed Cards.
The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through [Execute Bulk Process](#tag/Manage/operation/bulkIdExecute). A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details.
The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.
The submission of data for a bulk process does not expire but it can be cancelled through [Cancel Bulk Process](#tag/Manage/operation/bulkIdCancel).
The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations.
Each individual operation in this bulk will be processed via [Block a Managed Card](#tag/Managed-Cards/operation/managedCardBlock).
'
summary: Block cards in bulk
operationId: bulksManagedCardBlock
x-permissions:
- i:managed_cards:block
- i:managed_cards:block:own
parameters:
- $ref: '#/components/parameters/idempotency-ref'
responses:
'201':
description: Success - returning bulk process
content:
application/json:
schema:
type: object
properties:
bulkId:
type: string
operationCount:
type: integer
path:
type: string
security:
- auth_token: []
api-key: []
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
pathParams:
type: object
properties:
_id_:
type: string
pattern: ^[0-9]+$
maxItems: 10000
minItems: 1
/bulks/managed_cards/_id_/unblock:
post:
tags:
- Operations
description: 'Submit the details to unblock Managed Cards.
The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through [Execute Bulk Process](#tag/Manage/operation/bulkIdExecute). A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details.
The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.
The submission of data for a bulk process does not expire but it can be cancelled through [Cancel Bulk Process](#tag/Manage/operation/bulkIdCancel).
The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations.
Each individual operation in this bulk will be processed via [Unblock a Managed Card](#tag/Managed-Cards/operation/managedCardUnblock).
'
summary: Unblock cards in bulk
operationId: bulksManagedCardUnblock
x-permissions:
- i:managed_cards:unblock
- i:managed_cards:unblock:own
parameters:
- $ref: '#/components/parameters/idempotency-ref'
responses:
'201':
description: Success - returning bulk process
content:
application/json:
schema:
type: object
properties:
bulkId:
type: string
operationCount:
type: integer
path:
type: string
security:
- auth_token: []
api-key: []
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
pathParams:
type: object
properties:
_id_:
type: string
pattern: ^[0-9]+$
maxItems: 10000
minItems: 1
/bulks/managed_cards/_id_/remove:
post:
tags:
- Operations
description: 'Submit the details to remove Managed Cards.
The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through [Execute Bulk Process](#tag/Manage/operation/bulkIdExecute). A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details.
The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.
The submission of data for a bulk process does not expire but it can be cancelled through [Cancel Bulk Process](#tag/Manage/operation/bulkIdCancel).
The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations.
Each individual operation in this bulk will be processed via [Remove a Managed Card](#tag/Managed-Cards/operation/managedCardRemove).
'
summary: Remove cards in bulk
operationId: bulksManagedCardRemove
x-permissions:
- i:managed_cards:remove
parameters: []
responses:
'201':
description: Success - returning bulk process
content:
application/json:
schema:
type: object
properties:
bulkId:
type: string
operationCount:
type: integer
path:
type: string
security:
- auth_token: []
api-key: []
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
pathParams:
type: object
properties:
_id_:
type: string
pattern: ^[0-9]+$
maxItems: 10000
minItems: 1
/bulks/sends:
post:
tags:
- Operations
description: 'Submit the details for the creation of a batch of Sends.
The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through [Execute Bulk Process](#tag/Manage/operation/bulkIdExecute). A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details.
The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.
The submission of data for a bulk process does not expire but it can be cancelled through [Cancel Bulk Process](#tag/Manage/operation/bulkIdCancel).
The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations.
Each individual operation in this bulk will be processed via [Create a Send Transaction](#tag/Sends/operation/sendCreate).
'
summary: Create send transactions in bulk
operationId: bulksSendCreate
x-permissions:
- i:sends:create
parameters:
- $ref: '#/components/parameters/idempotency-ref'
responses:
'201':
description: Success - returning bulk process
content:
application/json:
schema:
type: object
properties:
bulkId:
type: string
operationCount:
type: integer
path:
type: string
security:
- auth_token: []
api-key: []
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
pathParams:
type: object
properties: {}
requestBody:
$ref: '#/components/schemas/SendCreateRequest'
maxItems: 10000
minItems: 1
/bulks/outgoing_wire_transfers:
post:
tags:
- Operations
summary: Create an outgoing wire transfer in bulk
operationId: bulksOutgoingWireTransferCreate
x-permissions:
- i:owt:create
description: 'Submit the details for the creation of a batch of Outgoing Wire Transfers.
The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through [Execute Bulk Process](#tag/Manage/operation/bulkIdExecute). A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details.
The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.
The submission of data for a bulk process does not expire but it can be cancelled through [Cancel Bulk Process](#tag/Manage/operation/bulkIdCancel).
The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations.
Each individual operation in this bulk will be processed via [Create an Outgoing Wire Transaction](#tag/Outgoing-Wire-Transfers/operation/outgoingWireTransferCreate).
'
parameters:
- $ref: '#/components/parameters/idempotency-ref'
responses:
'201':
description: Success - returning bulk process
content:
application/json:
schema:
type: object
properties:
bulkId:
type: string
operationCount:
type: integer
path:
type: string
security:
- auth_token: []
api-key: []
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
pathParams:
type: object
properties: {}
requestBody:
$ref: '#/components/schemas/OutgoingWireTransferCreateRequest'
maxItems: 10000
minItems: 1
components:
schemas:
CurrencyAmount:
required:
- currency
- amount
type: object
properties:
currency:
$ref: '#/components/schemas/Currency'
amount:
type: integer
format: int64
description: 'The monetary amount, scaled to the lowest denomination of the currency.
Example, an amount of 1000 for a EUR currency is actually 1000 Euro cents or EUR 10.00.
'
description: The object representing a monetary amount in a particular currency.
SpendLimit:
type: object
required:
- value
- interval
properties:
startTimestamp:
description: The start timestamp of the spend limit, expressed in Epoch timestamp using millisecond precision.
type: integer
format: int64
value:
description: The spend limit, as amount and currency, (for the given interval).
$ref: '#/components/schemas/CurrencyAmount'
interval:
$ref: '#/components/schemas/SpendLimitInterval'
FasterPaymentsBankDetailsOrBACSBankDetails:
required:
- accountNumber
- sortCode
type: object
description: Bank details used in case the wire transfer is executed over Faster Payments.
properties:
accountNumber:
type: string
pattern: ^[0-9]{8}$
description: Account number, required for wire transfer over Faster Payments.
sortCode:
type: string
pattern: ^[0-9]{6}$
description: Sort code, required for wire transfer over Faster Payments.
secondaryReference:
type: string
BaseCardLevelSpendRules:
allOf:
- $ref: '#/components/schemas/CommonLevelSpendRules'
- type: object
properties:
spendLimit:
description: The total amount of funds that can be spent using this card, in a given time interval.
type: array
items:
$ref: '#/components/schemas/SpendLimit'
Brand:
type: string
pattern: ^[a-zA-Z0-9]+$
description: '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.
'
maxLength: 25
CommonLevelSpendRules:
type: object
properties:
allowedMerchantCategories:
type: array
maxItems: 200
items:
type: string
description: 'Whitelist MCC: A list of allowed merchant category codes (MCCs). If the MCC does not match, then the transaction will be declined. If an MCC is also in the blocked list, the blocked list will take precedence.'
blockedMerchantCategories:
type: array
maxItems: 200
items:
type: string
description: 'Blacklist MCC: A list of disallowed merchant category codes (MCCs). If the MCC matches, then the transaction will be declined. If an MCC is also in the allowed list, the blocked list will take precedence.'
allowedMerchantIds:
type: array
maxItems: 200
items:
type: string
description: 'Whitelist Merchant Id: A list of allowed merchant IDs. If the Merchant Id does not match, then the transaction will be declined. If a Merchant Id is also provided in the blocked list, the blocked list will take precedence.'
blockedMerchantIds:
type: array
maxItems: 200
items:
type: string
description: 'Blacklist Merchant Id: A list of disallowed merchant IDs. If the Merchant Id matches, then the transaction will be declined. If a Merchant Id is also in the allowed list, the blocked list will take precedence.'
allowedMerchantCountries:
type: array
maxItems: 50
items:
maxLength: 2
minLength: 2
pattern: ^[A-Z]{2}$
type: string
description: 'Whitelist Merchant Country: A list of allowed merchant countries, in ISO 3166-1 alpha-2 format. If the Merchant country does not match, then the transaction will be declined. If a Merchant Country is also provided in the blocked list, the blocked list will take precedence.'
blockedMerchantCountries:
type: array
maxItems: 50
items:
maxLength: 2
minLength: 2
pattern: ^[A-Z]{2}$
type: string
description: 'Blacklist Merchant Country: A list of disallowed merchant countries, in ISO 3166-1 alpha-2 format. If the Merchant country matches, then the transaction will be declined. If a Merchant Country is also in the allowed list, the blocked list will take precedence.'
allowContactless:
type: boolean
description: Indicates if a contactless transaction is allowed on the card.
allowAtm:
type: boolean
description: Indicates if an ATM Withdrawal transaction is allowed on the card.
allowECommerce:
type: boolean
description: Indicates if an online transaction is allowed on the card.
allowCashback:
type: boolean
description: Indicates if a cashback transaction at a physical terminal is allowed on the card.
allowCreditAuthorisations:
type: boolean
description: Indicates if a the card can receive a credit transaction.
rolloverPolicy:
$ref: '#/components/schemas/RolloverPolicy'
UserId:
type: string
pattern: ^[0-9]+$
Date:
required:
- year
- month
- day
type: object
properties:
year:
type: integer
format: int32
maximum: 2100
minimum: 1900
month:
type: integer
format: int32
maximum: 12
minimum: 1
day:
type: integer
format: int32
maximum: 31
minimum: 1
UserLocale:
type: string
pattern: ^[a-z]{2}(-[A-Z]{2})?$
description: 'BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.
'
maxLength: 5
example: en-GB
OutgoingWireTransferBeneficiary:
deprecated: true
required:
- name
- bankAccountDetails
type: object
description: 'Details of the beneficiary of the outgoing wire transfer.
**Deprecated**: Use `SEPABeneficiary` for SEPA/IBAN transfers or `FasterPaymentsBeneficiary` for Faster Payments transfers instead.
'
properties:
name:
type: string
description: 'The beneficiary''s full name. The allowed length and pattern is dependent on the bank account details type:
`IBANDetails`: >= `1` character and <= `150` characters. An extended character set is accepted to cater for all European languages. If `SEPA` does not support a particular character, it is automatically converted to an acceptable alternative, in line with `SEPA` scheme guidance.
`FasterPaymentsBankDetailsOrBACSBankDetails`: >= `1` character and <= `140` characters with a pattern of `^[a-zA-Z0-9\/\-?:().,’+\s#=!"%&*<>;\{@\r\n]*$`
(please note that the `’` symbol is the unicode value U+2019 (right single quotation mark) and not the unicode value U+0027 (apostrophe))
'
type:
type: string
description: The type of beneficiary account. Required only when `FasterPaymentsBankDetailsOrBACSBankDetails` are specified
enum:
- PERSONAL
- BUSINESS
address:
maxLength: 150
minLength: 1
type: string
description: 'The beneficiary’s address. For `SEPA`, an extended character set is accepted to cater for all European languages. If `SEPA` does not support a particular character, it is automatically converted to an acceptable alternative, in line with `SEPA` scheme guidance.
'
bankName:
type: string
description: The beneficiary's bank name.
bankAddress:
maxLength: 150
minLength: 1
type: string
description: The beneficiary's bank address.
bankCountry:
type: string
description: The beneficiary's bank country in ISO 3166 alpha-2 format.
maxLength: 2
minLength: 2
pattern: ^[A-Z]{2}$
bankAccountDetails:
description: Details of the beneficiary bank account, depending on the type of transfer chosen.
oneOf:
- $ref: '#/components/schem
# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/weavr/refs/heads/main/openapi/weavr-operations-api-openapi.yml