Spend controls

List card spend rules

Returns the spend rules in force for the managed card identified by the id path parameter.

The response separates the two levels at which rules are configured: the profile-level rules that apply to every card on the Managed Card Profile, and the card-level rules set for this card alone. An authorization must satisfy both, so read them together when working out why a transaction was declined.

Each spend limit is returned with its interval and its rollover policy. When rolloverNegative is enabled, overspend is carried into subsequent intervals and reduces the card's available-to-spend amount until it becomes positive.

:::note The merchant, MCC, and country lists at the top level of the response are deprecated. Read the equivalent fields under cardLevelSpendRules instead. :::

get/managed_cards/{id}/spend_rules

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/managed_cards/{id}/spend_rules
  • Auth: HTTP bearer and API key in header api-key

Path parameters

idstring required
Example:123456789

The unique identifier of the managed card.

Response

Success

allowedMerchantCategoriesstring[]

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

blockedMerchantCategoriesstring[]

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

allowedMerchantIdsstring[]

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

blockedMerchantIdsstring[]

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

allowedMerchantCountriesstring[]

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

blockedMerchantCountriesstring[]

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

allowContactlessboolean

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

allowAtmboolean

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

allowECommerceboolean

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

allowCashbackboolean

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

allowCreditAuthorisationsboolean

Indicates whether the card can receive a credit transaction. This field is deprecated - use cardLevelSpendRules.allowCreditAuthorisations instead.

minTransactionAmountinteger

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 minimum transaction amount is to be set. This field is deprecated - use cardLevelSpendRules.minTransactionAmount instead.

maxTransactionAmountinteger

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.

Example response

{
  "allowContactless": true,
  "allowAtm": true,
  "allowECommerce": true,
  "allowCashback": true,
  "allowCreditAuthorisations": true,
  "minTransactionAmount": 100,
  "maxTransactionAmount": 50000,
  "spendLimit": [
    {
      "startTimestamp": 1767225600000,
      "value": {
        "currency": "GBP",
        "amount": 1250
      }
    }
  ],
  "cardLevelSpendRules": {
    "allowContactless": true,
    "allowAtm": true,
    "allowECommerce": true,
    "allowCashback": true,
    "allowCreditAuthorisations": true,
    "spendLimit": [
      {
        "startTimestamp": 1767225600000,
        "value": {
          "currency": "GBP",
          "amount": 1250
        }
      }
    ],
    "minTransactionAmount": 100,
    "maxTransactionAmount": 50000
  },
  "profileLevelSpendRules": {
    "allowContactless": true,
    "allowAtm": true,
    "allowECommerce": true,
    "allowCashback": true,
    "allowCreditAuthorisations": true
  },
  "identityLevelSpendRules": {
    "allowContactless": true,
    "allowAtm": true,
    "allowECommerce": true,
    "allowCashback": true,
    "allowCreditAuthorisations": true,
    "minTransactionAmount": 100,
    "maxTransactionAmount": 50000
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.