SpendLimit

A profile's spending limits.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

spend_limits, err := client.SpendLimit(nil).List(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(spend_limits)
updated, err := client.SpendLimit(nil).Update(map[string]any{"id": "example_id", "profile_id": 1, "aggregateWindow": map[string]any{}}, nil)
if err != nil {
    panic(err)
}
fmt.Println(updated)
removed, err := client.SpendLimit(nil).Remove(map[string]any{"card_id": "example", "id": "example_id", "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(removed)

Lua

Construct client as shown in the Lua setup, then call the operations:

local spend_limits, err = client:SpendLimit():list({ profile_id = 1 })
local updated, err = client:SpendLimit():update({ id = "example_id", profile_id = 1, aggregateWindow = {} })
local removed, err = client:SpendLimit():remove({ card_id = "example", id = "example_id", profile_id = 1 })

PHP

Construct client as shown in the PHP setup, then call the operations:

$spend_limits = $client->SpendLimit()->list(["profile_id" => 1]);
$updated = $client->SpendLimit()->update(["id" => "example_id", "profile_id" => 1, "aggregateWindow" => []]);
$client->SpendLimit()->remove(["card_id" => "example", "id" => "example_id", "profile_id" => 1]);

Python

Construct client as shown in the Python setup, then call the operations:

spend_limits = client.SpendLimit().list({"profile_id": 1})
updated = client.SpendLimit().update({"id": "example_id", "profile_id": 1, "aggregateWindow": {}})
client.SpendLimit().remove({"card_id": "example", "id": "example_id", "profile_id": 1})

Ruby

Construct client as shown in the Ruby setup, then call the operations:

spend_limits = client.SpendLimit.list({ "profile_id" => 1 })
updated = client.SpendLimit.update({ "id" => "example_id", "profile_id" => 1, "aggregateWindow" => {} })
client.SpendLimit.remove({ "card_id" => "example", "id" => "example_id", "profile_id" => 1 })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const spend_limits = await client.SpendLimit().list({ profile_id: 1 })
const updated = await client.SpendLimit().update({ id: "example_id", profile_id: 1, aggregateWindow: {} })
await client.SpendLimit().remove({ card_id: "example", id: "example_id", profile_id: 1 })

Fields

list

GET /spend/profiles/{profileId}/spend-limits

Operation ID: spendLimitsProfileGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Profile spend limits

application/json

Example response:

{
  "spendLimits": [
    {
      "aggregateWindow": {
        "daily": {
          "max": {
            "amount": 30000,
            "currency": "GBP"
          },
          "resetAt": "2023-07-31T22:59:59.999999999Z",
          "usage": {
            "amount": 0,
            "currency": "GBP"
          },
          "value": {
            "amount": 20000,
            "currency": "GBP"
          }
        },
        "monthly": {
          "max": {
            "amount": 30000,
            "currency": "GBP"
          },
          "resetAt": "2023-07-31T22:59:59.999999999Z",
          "usage": {
            "amount": 0,
            "currency": "GBP"
          },
          "value": {
            "amount": 20000,
            "currency": "GBP"
          }
        }
      },
      "type": "PURCHASE"
    },
    {
      "aggregateWindow": {
        "daily": {
          "max": {
            "amount": 4000,
            "currency": "GBP"
          },
          "resetAt": "2023-07-31T22:59:59.999999999Z",
          "usage": {
            "amount": 0,
            "currency": "GBP"
          },
          "value": {
            "amount": 1000,
            "currency": "GBP"
          }
        },
        "monthly": {
          "max": {
            "amount": 4000,
            "currency": "GBP"
          },
          "resetAt": "2023-07-31T22:59:59.999999999Z",
          "usage": {
            "amount": 0,
            "currency": "GBP"
          },
          "value": {
            "amount": 1000,
            "currency": "GBP"
          }
        }
      },
      "type": "ATM_WITHDRAWAL"
    }
  ]
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

remove

DELETE /spend/profiles/{profileId}/cards/{cardToken}/spend-limits/{granularity}

Operation ID: spendLimitsCardDelete.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Updated card spend limits. See Retrieve card limits

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

update

PATCH /spend/profiles/{profileId}/spend-limits

Operation ID: spendLimitsProfileUpdate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Example request body:

{
  "aggregateWindow": {
    "daily": {
      "value": {
        "amount": 20000,
        "currency": "GBP"
      }
    },
    "monthly": {
      "value": {
        "amount": 20000,
        "currency": "GBP"
      }
    }
  },
  "type": "PURCHASE"
}

Responses

200: Updated profile spend limits. See Retrieve profile limits

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.