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

Weavr Multi Product API (3.63.5)

Weavr Multi API provides a simple and flexible way to issue cards and accounts to your customers.

By integrating Weavr Multi API in your application you can embed banking capabilities within your app and provide a seamless experience for your customers.

Authentication

Each request to the Multi API must include an api-key that represents your account. You can obtain an API Key by registering for a Multi account here.

Almost all endpoints require a secondary authentication token auth_token that represents the user for whom the request is being executed.

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

Access

Manage authentication for your users.

Operations

Passwords

Manage your users' passwords.

Operations

Authentication Factors

Operations

Step-up Challenges

Operations

Confirmation Challenges

Operations

Corporates

Corporates are identities representing companies. Once on-boarded, Corporates can create and manage their own instruments via your application.

Operations

Consumers

Consumers are identities representing individuals. Once on-boarded, Consumers can create and manage their own instruments via your application.

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.

In case of Corporate Identities, authorised users are typically employees who have access to company's banking products such as cards and bank accounts.

In case of Consumer Identities, authorised users are typically children/teens whose parents want them to have access to banking products such as cards and bank accounts.

Note that the /users GET endpoints return all users including root users. However, modification operations (create, update, activate, deactivate) on /users endpoints only apply to authorised users. To modify root user details, use the respective /consumers or /corporates endpoints.

Operations

Beneficiaries

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.

Managed accounts can also be used as source and destination instruments in the transfer and send transactions.

Operations

Managed Cards

Managed Cards are a type of financial instrument offered by Weavr.

You can create virtual or physical cards that are issued to the consumer or corporate identity.

A card created in prepaid mode has its own balance, whereas a card created in debit mode does not have its own balance but taps into the balance of its parent managed account.

Operations

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/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
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/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/openapi/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 '{
    "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

Update spend rules for a managed card

Request

Must be user after a POST, to update individual spend rules associated with the managed card identified by the id path parameter.

Security
auth_token and api-key
Path
idstring^[0-9]+$required
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/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.

updateSpendLimitMethodstring(SpendLimitUpdateMethod)

The spend limit update method to apply. Currently supported:

  • OVERWRITE: (default option if nothing selected). Overwrites the previous values for the spendLimit object i.e. sets new limits
  • INCREMENT : This will increase the existing value of the spend limit by the amount input the value field. If used in conjunction with an ALWAYS interval, this can be used to increment a spend limit on a periodic basis (controlled by you, e.g. monthly), and means that any 'unused' balance from the previous period will still available to spend. See examples in our documentation
Enum"OVERWRITE""INCREMENT"
curl -i -X PATCH \
  'https://api.weavr.io/_mock/products/multi/openapi/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 '{
    "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 - 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

Linked Accounts

Linked Accounts are external bank accounts that users connect to their profiles within the Weavr Platform.

These accounts allow users to link their existing bank accounts, held at external financial institutions, to the Weavr Platform, enabling secure and efficient transfer of funds between their own accounts.

Linked Accounts are designed to streamline the process of moving money between a user’s various bank accounts, providing a convenient and integrated way to manage personal finances across different financial institutions.

Operations

Sends

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

Operations

Transfers

The Transfer transaction is used to transfer funds between managed accounts and managed cards belonging to same identity.

Operations

Outgoing Wire Transfers

The Outgoing Wire Transfer transaction is used to transfer funds from managed accounts to an external bank account.

Operations

Incoming Wire Transfers

Webhooks

Operations

Operations

Manage

Operations