Skip to content
/
Update spend rules for a...

Weavr Multi Product BackOffice API (v3)

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.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://weavr.io
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/multi-backoffice/openapi
Weavr Sandbox Environment
https://sandbox.weavr.io/multi/backoffice

Access Token

Acquire a token granting you access to perform sensitive operations on behalf of an identity.

Operations

User Impersonation

Operations

Corporates

Operations

Consumers

Operations

Authorised Users

Corporate and Consumer identities can invite authorised users to access their account. Once on-boarded, authorised users can create and manage instruments and transactions on behalf of the identity they are on-boarded with.
With the access_token representing the identity and the consent of the identity, you will be able to create and invite authorised users for the Identity.

Creating and inviting users on behalf of identities are restricted features; by default these endpoints are not available for use.

Operations

Managed Accounts

Managed Accounts are a type of financial instrument offered by Weavr. They hold funds for their owner, and can be upgraded to IBANs so as to receive and send funds to instruments outside of the Weavr Platform, via Wire Transfers. These accounts can also be used as sources and destinations in the transfer transaction.

With the access_token representing the identity and the consent of the identity, you will be able to operations on the identity's managed accounts, such as getting a managed account's details and retrieving its statement.

Operations

Managed Cards

Managed Cards are a type of financial instrument offered by Weavr. Cards created in prepaid mode have their own balance, whereas those created in debit mode tap into the balance of their parent Managed Accounts. Apart from being used at merchants for puchases, prepaid mode cards can also be used as sources and destinations in the transfer transaction.

With the access_token representing the identity and the consent of the identity, you will be able to perform operations on the identity's Managed Cards, such as getting a Managed Card's details and managing its spend rules.

Operations

Transfers

Operations

Fees

Operations

Operations

Operations

Update spend rules for a managed card

Request

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 . 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 .

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 Update a Managed Card.

Security
auth_token and api_key
Headers
idempotency-refstring

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Bodyapplication/jsonArray [
pathParamsobject
requestBodyobject(UpdateCardLevelSpendRules)
]
curl -i -X PATCH \
  https://api.weavr.io/_mock/products/multi-backoffice/openapi/bulks/managed_cards/_id_/spend_rules \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '[
    {
      "pathParams": {
        "_id_": "string"
      },
      "requestBody": {
        "allowedMerchantCategories": [
          "string"
        ],
        "blockedMerchantCategories": [
          "string"
        ],
        "allowedMerchantIds": [
          "string"
        ],
        "blockedMerchantIds": [
          "string"
        ],
        "allowedMerchantCountries": [
          "st"
        ],
        "blockedMerchantCountries": [
          "st"
        ],
        "allowContactless": true,
        "allowAtm": true,
        "allowECommerce": true,
        "allowCashback": true,
        "allowCreditAuthorisations": true,
        "rolloverPolicy": {
          "rolloverNegative": true
        },
        "spendLimit": [
          {
            "startTimestamp": 0,
            "value": {
              "currency": "str",
              "amount": 0
            },
            "interval": "DAILY"
          }
        ],
        "minTransactionAmount": 0,
        "maxTransactionAmount": 0,
        "updateSpendLimitMethod": "OVERWRITE"
      }
    }
  ]'

Responses

Success - returning bulk process

Bodyapplication/json
bulkIdstring
operationCountinteger
pathstring
Response
application/json
{
  "bulkId": "string",
  "operationCount": 0,
  "path": "string"
}

Create transfer transactions in bulk

Request

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. 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.

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.

Security
auth_token and api_key
Headers
idempotency-refstring

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Bodyapplication/jsonArray [
pathParamsobject
requestBodyobject
]
curl -i -X POST \
  https://api.weavr.io/_mock/products/multi-backoffice/openapi/bulks/transfers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '[
    {
      "pathParams": {},
      "requestBody": {
        "profileId": "string",
        "tag": "string",
        "source": {
          "id": "string",
          "type": "managed_cards"
        },
        "description": "string",
        "destination": {
          "id": "string",
          "type": "managed_cards"
        },
        "destinationAmount": {
          "currency": "str",
          "amount": 0
        },
        "scheduledTimestamp": "string"
      }
    }
  ]'

Responses

Success - returning bulk process

Bodyapplication/json
bulkIdstring
operationCountinteger
pathstring
Response
application/json
{
  "bulkId": "string",
  "operationCount": 0,
  "path": "string"
}

Manage

Operations