Skip to content
/
Get all 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

Unblock a managed card

Request

Unblocks the managed card identified by the id path parameter. The managed card must have state.blockedReason as USER so that it can be unblocked. If the managed card was blocked by SYSTEM, users cannot unblock it.

Security
auth_token and api_key
Path
idstring^[0-9]+$required

The unique identifier of the managed card.

curl -i -X POST \
  'https://api.weavr.io/_mock/products/multi-backoffice/openapi/managed_cards/{id}/unblock' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success - No Content.

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Response
No content

Get all spend rules for a managed card

Request

Fetch the list of spend rules associated with the managed card identified by the id path parameter.

Security
auth_token and api_key
Path
idstring^[0-9]+$required
curl -i -X GET \
  'https://api.weavr.io/_mock/products/multi-backoffice/openapi/managed_cards/{id}/spend_rules' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
cardLevelSpendRulesobject(CardLevelSpendRules)
profileLevelSpendRulesobject(ProfileLevelSpendRules)
identityLevelSpendRulesobject(IdentityLevelSpendRules)
allowedMerchantCategoriesArray of strings<= 200 itemsDeprecated

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. This field is deprecated - use "cardLevelSpendRules"."allowedMerchantCategories" instead.

blockedMerchantCategoriesArray of strings<= 200 itemsDeprecated

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. This field is deprecated - use "cardLevelSpendRules"."blockedMerchantCategories" instead.

allowedMerchantIdsArray of strings<= 200 itemsDeprecated

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. This field is deprecated - use "cardLevelSpendRules"."allowedMerchantIds" instead.

blockedMerchantIdsArray of strings<= 200 itemsDeprecated

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. This field is deprecated - use "cardLevelSpendRules"."blockedMerchantIds" instead.

allowedMerchantCountriesArray of strings<= 50 itemsDeprecated

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. This field is deprecated - use "cardLevelSpendRules"."allowedMerchantCountries" instead.

blockedMerchantCountriesArray of strings<= 50 itemsDeprecated

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. This field is deprecated - use "cardLevelSpendRules"."blockedMerchantCountries" instead.

allowContactlessbooleanDeprecated

Indicates if a contactless transaction is allowed on the card. This field is deprecated - use "cardLevelSpendRules"."allowContactless" instead.

allowAtmbooleanDeprecated

Indicates if an ATM Withdrawal transaction is allowed on the card. This field is deprecated - use "cardLevelSpendRules"."allowAtm" instead.

allowECommercebooleanDeprecated

Indicates if an online transaction is allowed on the card. This field is deprecated - use "cardLevelSpendRules"."allowECommerce" instead.

allowCashbackbooleanDeprecated

Indicates if a cashback transaction at a physical terminal is allowed on the card. This field is deprecated - use "cardLevelSpendRules"."allowCashback" instead.

allowCreditAuthorisationsbooleanDeprecated

Indicates if a the card can receive a credit transaction. This field is deprecated - use "cardLevelSpendRules"."allowCashback" instead.

minTransactionAmountinteger(int64)>= 0Deprecated

The minimum transaction amount, in card currency, that is allowed. If the transaction amount is less than this value, then the transaction will be declined. Omit this, or set to 0 if no maximum transaction amount is to be set. This field is deprecated - use "cardLevelSpendRules"."minTransactionAmount" instead.

maxTransactionAmountinteger(int64)>= 0Deprecated

The maximum transaction amount, in card currency, that is allowed. If the transaction amount is greater than this value, then the transaction will be declined. Omit this, or set to 0 if no maximum transaction amount is to be set. This field is deprecated - use "cardLevelSpendRules"."maxTransactionAmount" instead.

spendLimitArray of objects(SpendLimit)Deprecated

The total amount of funds that can be spent using this card, in a given time interval. This field is deprecated - use "cardLevelSpendRules"."spendLimit" instead.

Response
application/json
{
  "allowedMerchantCategories": [
    "string"
  ],
  "blockedMerchantCategories": [
    "string"
  ],
  "allowedMerchantIds": [
    "string"
  ],
  "blockedMerchantIds": [
    "string"
  ],
  "allowedMerchantCountries": [
    "st"
  ],
  "blockedMerchantCountries": [
    "st"
  ],
  "allowContactless": true,
  "allowAtm": true,
  "allowECommerce": true,
  "allowCashback": true,
  "allowCreditAuthorisations": true,
  "minTransactionAmount": 0,
  "maxTransactionAmount": 0,
  "spendLimit": [
    { … }
  ],
  "cardLevelSpendRules": {
    "allowedMerchantCategories": [ … ],
    "blockedMerchantCategories": [ … ],
    "allowedMerchantIds": [ … ],
    "blockedMerchantIds": [ … ],
    "allowedMerchantCountries": [ … ],
    "blockedMerchantCountries": [ … ],
    "allowContactless": true,
    "allowAtm": true,
    "allowECommerce": true,
    "allowCashback": true,
    "allowCreditAuthorisations": true,
    "rolloverPolicy": { … },
    "spendLimit": [ … ],
    "minTransactionAmount": 0,
    "maxTransactionAmount": 0
  },
  "profileLevelSpendRules": {
    "allowedMerchantCategories": [ … ],
    "blockedMerchantCategories": [ … ],
    "allowedMerchantIds": [ … ],
    "blockedMerchantIds": [ … ],
    "allowedMerchantCountries": [ … ],
    "blockedMerchantCountries": [ … ],
    "allowContactless": true,
    "allowAtm": true,
    "allowECommerce": true,
    "allowCashback": true,
    "allowCreditAuthorisations": true,
    "rolloverPolicy": { … },
    "authForwardingEnabled": true
  },
  "identityLevelSpendRules": {
    "allowedMerchantCategories": [ … ],
    "blockedMerchantCategories": [ … ],
    "allowedMerchantIds": [ … ],
    "blockedMerchantIds": [ … ],
    "allowedMerchantCountries": [ … ],
    "blockedMerchantCountries": [ … ],
    "allowContactless": true,
    "allowAtm": true,
    "allowECommerce": true,
    "allowCashback": true,
    "allowCreditAuthorisations": true,
    "rolloverPolicy": { … },
    "minTransactionAmount": 0,
    "maxTransactionAmount": 0
  }
}

Create spend rules for a managed card

Request

Create the spend rules associated with the managed card identified by the id path parameter.

Security
auth_token and api_key
Path
idstring^[0-9]+$required
Bodyapplication/jsonrequired
allowedMerchantCategoriesArray of strings<= 200 items

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.

blockedMerchantCategoriesArray of strings<= 200 items

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.

allowedMerchantIdsArray of strings<= 200 items

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.

blockedMerchantIdsArray of strings<= 200 items

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.

allowedMerchantCountriesArray of strings<= 50 items

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.

blockedMerchantCountriesArray of strings<= 50 items

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.

allowContactlessboolean

Indicates if a contactless transaction is allowed on the card.

allowAtmboolean

Indicates if an ATM Withdrawal transaction is allowed on the card.

allowECommerceboolean

Indicates if an online transaction is allowed on the card.

allowCashbackboolean

Indicates if a cashback transaction at a physical terminal is allowed on the card.

allowCreditAuthorisationsboolean

Indicates if a the card can receive a credit transaction.

rolloverPolicyobject(RolloverPolicy)

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 merchant clears funds without authorising, resulting in the availableToSpend value to go into negative. Rollover is relative to a spendLimit.interval

spendLimitArray of objects(SpendLimit)

The total amount of funds that can be spent using this card, in a given time interval.

minTransactionAmountinteger(int64)>= 0

The minimum transaction amount, in card currency, that is allowed. If the transaction amount is less than this value, then the transaction will be declined.

maxTransactionAmountinteger(int64)>= 0

The maximum transaction amount, in card currency, that is allowed. If the transaction amount is greater than this value, then the transaction will be declined.

curl -i -X POST \
  'https://api.weavr.io/_mock/products/multi-backoffice/openapi/managed_cards/{id}/spend_rules' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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
  }'

Responses

Success - No Content.

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Response
No content

Transfers

Operations

Fees

Operations

Operations

Operations

Manage

Operations