Manage spending limits - Equals Documentation

When a spending limit on a card is updated, it does not reset the time period or the spending amount already used. Instead, the existing tracking continues as if the limit had not been changed. If a transaction is refunded, the refunded amount is reinstated to the spending limit, but the transaction still counts against the usage limit. For example, if a card has a weekly limit of £1,000, and the user spends £600, they have £400 remaining for that week. If you update the limit to £2,000, the system does not reset the spent amount. The user will now have £1,400 remaining for the rest of the week, not a fresh £2,000. If the £600 spent was refunded, the user will now have £2,000 remaining for the rest of the week. A card can have both a spending limit and a transaction limit. Learn more about transaction limits.

The endpoints described in this guide are currently in beta mode.

Create a spending limit

POST /v2/cards/{cardId}/spending-limits

Request

Use this request to create a new spending limit for a given card.

curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/e9293471-5eb3-4dbc-916c-dbaf9e2deefd/spending-limits?accountId=F12345&budgetId=775596ae-2624-40af-a9dc-9756110a4a03' \
  -H 'Authorization: ApiKey 9cd30b49-812e-46ac-a222-7ce73e9c9dbc' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 100.5,
    "active": false,
    "currencyCode": "GBP",
    "limitTurnedOff": true,
    "limitWindow": "DAY"
  }'

curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/{cardId}/spending-limits?accountId={accountId}&budgetId={budgetId}' \
  -H 'Authorization: ApiKey 9cd30b49-812e-46ac-a222-7ce73e9c9dbc' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": number,
    "active": boolean,
    "currencyCode": "string",
    "limitTurnedOff": boolean,
    "limitWindow": "string"
  }'

Path parameters

string (uuid)

required

The ID of the card that you want to create a new spending limit for.Allowable values: An existing cardId (≤ 36 characters)

Query parameters

string

required

The ID of the account that the card is associated with.Allowable values: An existing accountId

string (uuid)

required

The ID of the budget that the card is associated with.Allowable values: An existing budgetId (≤ 36 characters)

string (uuid)

The ID of the person that the card belongs to.Allowable values: An existing personId (≤ 36 characters)

Request body schema

number

required

The amount that you want to set as the spending limit.Allowable values: A valid number

boolean

Whether or not you want the spending limit to be active on Marqeta.Allowable values: true, false

string

The currency that you want to set the spending limit on. Spending limits only apply to all currencies on the card when they are set in the base currency of the card.Allowable values: A valid currencyCode

boolean

Whether or not you want the spending limit to be turned off.Allowable values: true, false

string

required

The time period for which the spending limits should apply.Allowable values: DAY, WEEK, MONTH, LIFETIME

Response

If your request is successful, you’ll receive a 200 response. The available object will contain details about the remaining uses, amount, and number of days remaining until the limit resets.

{
  "id": "775596ae-2624-40af-a9dc-9756110a4a03",
  "amount": 100.5,
  "active": false,
  "limitTurnedOff": true,
  "limitWindow": "DAY",
  "currencyCode": "GBP",
  "available": {
    "uses": 0,
    "amount": 100.5,
    "daysRemaining": 1
  }
}

{
  "id": "string",
  "amount": number,
  "active": boolean,
  "limitTurnedOff": boolean,
  "limitWindow": "string",
  "currencyCode": "string",
  "available": {
    "uses": number,
    "amount": number,
    "daysRemaining": number
  }
}

For more detailed information about this request and its response, see the API reference.

Retrieve a spending limit

GET /v2/cards/{cardId}/spending-limits

Request

Use this request to retrieve the spending limit for a given card, based on its id.

curl -i -X GET \
  'https://api.equalsmoney.com/v2/cards/e9293471-5eb3-4dbc-916c-dbaf9e2deefd/spending-limits?accountId=F12345&budgetId=775596ae-2624-40af-a9dc-9756110a4a03' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

curl -i -X GET \
  'https://api.equalsmoney.com/v2/cards/{cardId}/spending-limits?accountId={accountId}&budgetId={budgetId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Path parameters

string (uuid)

required

The ID of the card that you want to retrieve a spending limit for.Allowable values: An existing cardId (≤ 36 characters)

Query parameters

string

required

The ID of the account that the card is associated with.Allowable values: An existing accountId

string (uuid)

required

The ID of the budget that the card is associated with.Allowable values: An existing budgetId (≤ 36 characters)

integer

The maximum number of results to return. For example, limit=25. By default, this is set to 100.Allowable values: [ 1 .. 1000 ]

integer

The number of items to skip before returning results. For example, offset=200. By default, this is set to 0.Allowable values: A valid integer

string

The term(s) to search for. You can use this to filter the results.Allowable values: A valid string

string (uuid)

The ID of the person that the card belongs to.Allowable values: A existing personId (≤ 36 characters)

Response

If your request is successful, you’ll receive a 200 response.

{
  "id": "775596ae-2624-40af-a9dc-9756110a4a03",
  "amount": 100.5,
  "active": false,
  "limitTurnedOff": true,
  "limitWindow": "DAY",
  "currencyCode": "GBP",
  "available": {
    "uses": 0,
    "amount": 100.5,
    "daysRemaining": 1
  }
}

{
  "id": "string",
  "amount": number,
  "active": boolean,
  "limitTurnedOff": boolean,
  "limitWindow": "string",
  "currencyCode": "string",
  "available": {
    "uses": number,
    "amount": number,
    "daysRemaining": number
  }
}

For more detailed information about this request and its response, see the API reference.

Update a spending limit

PUT /v2/cards/{cardId}/spending-limits/{limitId}

Request

Use this request to update an existing spending limit for a card.

curl -i -X PUT \
  'https://api.equalsmoney.com/v2/cards/e9293471-5eb3-4dbc-916c-dbaf9e2deefd/spending-limits/0684fc07-4abc-46de-b664-da45ef3c4072?accountId=F12345&budgetId=775596ae-2624-40af-a9dc-9756110a4a03' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "775596ae-2624-40af-a9dc-9756110a4a03",
    "amount": 100.5,
    "active": false,
    "limitTurnedOff": true,
    "limitWindow": "DAY"
  }'

curl -i -X PUT \
  'https://api.equalsmoney.com/v2/cards/{cardId}/spending-limits/{limitId}?accountId={accountId}&budgetId={budgetId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "amount": number,
    "active": boolean,
    "limitTurnedOff": boolean,
    "limitWindow": "string"
  }'

Path parameters

string (uuid)

required

The ID of the card associated with the spending limit.Allowable values: An existing cardId (≤ 36 characters)

string

required

The ID of the limit that you want to update.Allowable values: An existing limitId (≤ 36 characters)

Query parameters

string

required

The ID of the account that the card is associated with.Allowable values: An existing accountId

string (uuid)

required

The ID of the budget that the card is associated with.Allowable values: An existing budgetId (≤ 36 characters)

string (uuid)

The ID of the person that the card belongs to.Allowable values: An existing personId (≤ 36 characters)

Request body schema

string (uuid)

The new ID of the spending limit.Allowable values: A valid string

number

required

The amount that you want to set as the spending limit.Allowable values: A valid number

boolean

required

Whether or not the spending limit is active on Marqeta.Allowable values: true, false

boolean

required

Whether or not the spending limit is turned off.Allowable values: true, false

Response

If your request is successful, you’ll receive a 200 response.

{
  "id": "775596ae-2624-40af-a9dc-9756110a4a03",
  "amount": 100.5,
  "active": false,
  "limitTurnedOff": true,
  "limitWindow": "DAY",
  "currencyCode": "GBP",
  "available": {
    "uses": 0,
    "amount": 100.5,
    "daysRemaining": 1
  }
}

{
  "id": "string",
  "amount": number,
  "active": boolean,
  "limitTurnedOff": boolean,
  "limitWindow": "string",
  "currencyCode": "string",
  "available": {
    "uses": number,
    "amount": number,
    "daysRemaining": number
  }
}

For more detailed information about this request and its response, see the API reference.

​Create a spending limit

​Request

​Path parameters

​Query parameters

​Request body schema

​Response

​Retrieve a spending limit

​Request

​Path parameters

​Query parameters

​Response

​Update a spending limit

​Request

​Path parameters

​Query parameters

​Request body schema

​Response

Create a spending limit

Request

Path parameters

Query parameters

Request body schema

Response

Retrieve a spending limit

Request

Path parameters

Query parameters

Response

Update a spending limit

Request

Path parameters

Query parameters

Request body schema

Response