Manage transaction limits - Equals Documentation

A card can have both a spending limit and a transaction limit. Learn more about spending limits.

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

Retrieve a transaction limit

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

Request

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

curl -i -X GET \
  'https://api.equalsmoney.com/v2/cards/e9293471-5eb3-4dbc-916c-dbaf9e2deefd/transaction-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}/transaction-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 the transaction 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)

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,
  "currencyCode": "GBP",
  "limitWindow": "TRANSACTION"
}

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

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

Create a transaction limit

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

Request

Use this request to create a transaction limit for a given card.

curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/e9293471-5eb3-4dbc-916c-dbaf9e2deefd/transaction-limits?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": "TRANSACTION"
  }'

curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/{cardId}/transaction-limits?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 that you want to create a transaction 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

string (uuid)

The ID of the transaction limit that you want to create.Allowable values: A valid string

number

required

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

boolean

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

boolean

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

string

required

The time period for which the transaction limit applies. Always set this to TRANSACTION.Allowable values: TRANSACTION

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,
  "currencyCode": "GBP",
  "limitWindow": "TRANSACTION"
}

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

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

Update a transaction limit

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

Request

Use this request to update the transaction limit for a given card.

curl -i -X PUT \
  'https://api.equalsmoney.com/v2/cards/e9293471-5eb3-4dbc-916c-dbaf9e2deefd/transaction-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": "TRANSACTION"
  }'

curl -i -X PUT \
  'https://api.equalsmoney.com/v2/cards/{cardId}/transaction-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 that the transaction limit applies to.Allowable values: An existing cardId (≤ 36 characters)

string (uuid)

required

The ID of the transaction 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 transaction limit.Allowable values: A valid string

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,
  "currencyCode": "GBP",
  "limitWindow": "TRANSACTION"
}

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

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

​Retrieve a transaction limit

​Request

​Path parameters

​Query parameters

​Response

​Create a transaction limit

​Request

​Path parameters

​Query parameters

​Request body schema

​Response

​Update a transaction limit

​Request

​Path parameters

​Query parameters

​Request body schema

​Response

Retrieve a transaction limit

Request

Path parameters

Query parameters

Response

Create a transaction limit

Request

Path parameters

Query parameters

Request body schema

Response

Update a transaction limit

Request

Path parameters

Query parameters

Request body schema

Response