CardHolderLimit

A cardholder'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:

card_holder_limits, err := client.CardHolderLimit(nil).List(map[string]any{"card_holder_profile_id": 1, "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(card_holder_limits)
updated, err := client.CardHolderLimit(nil).Update(map[string]any{"card_holder_profile_id": 1, "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(updated)
removed, err := client.CardHolderLimit(nil).Remove(map[string]any{"card_holder_profile_id": 1, "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 card_holder_limits, err = client:CardHolderLimit():list({ card_holder_profile_id = 1, profile_id = 1 })
local updated, err = client:CardHolderLimit():update({ card_holder_profile_id = 1, profile_id = 1 })
local removed, err = client:CardHolderLimit():remove({ card_holder_profile_id = 1, profile_id = 1 })

PHP

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

$card_holder_limits = $client->CardHolderLimit()->list(["card_holder_profile_id" => 1, "profile_id" => 1]);
$updated = $client->CardHolderLimit()->update(["card_holder_profile_id" => 1, "profile_id" => 1]);
$client->CardHolderLimit()->remove(["card_holder_profile_id" => 1, "profile_id" => 1]);

Python

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

card_holder_limits = client.CardHolderLimit().list({"card_holder_profile_id": 1, "profile_id": 1})
updated = client.CardHolderLimit().update({"card_holder_profile_id": 1, "profile_id": 1})
client.CardHolderLimit().remove({"card_holder_profile_id": 1, "profile_id": 1})

Ruby

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

card_holder_limits = client.CardHolderLimit.list({ "card_holder_profile_id" => 1, "profile_id" => 1 })
updated = client.CardHolderLimit.update({ "card_holder_profile_id" => 1, "profile_id" => 1 })
client.CardHolderLimit.remove({ "card_holder_profile_id" => 1, "profile_id" => 1 })

TypeScript

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

const card_holder_limits = await client.CardHolderLimit().list({ card_holder_profile_id: 1, profile_id: 1 })
const updated = await client.CardHolderLimit().update({ card_holder_profile_id: 1, profile_id: 1 })
await client.CardHolderLimit().remove({ card_holder_profile_id: 1, profile_id: 1 })

Fields

list

GET /spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits

Operation ID: spendLimitsCardHolderGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Cardholder spend limits

application/json

403: The client lacks the CARDS_API_VIEW_SPENDING_LIMITS permission on the business profile, or the cardholder profile is not accessible to it

application/json

Example response:

{
  "code": "unauthorized",
  "detail": "Operation is unauthorized",
  "status": 403,
  "type": "/errors/types/access"
}

422: A path parameter references a profile of the wrong type. businessProfileId must reference a business profile and cardHolderProfileId must reference a personal profile

application/json

Example response:

{
  "errors": [
    {
      "code": "invalid_value",
      "detail": "businessProfileId must reference a business profile",
      "ref": "businessProfileId"
    }
  ],
  "instance": "/v4/spend/profiles/12345/card-holder-profiles/67890/spend-limits",
  "status": 422,
  "title": "Validation error",
  "type": "/errors/types/validation"
}

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

application/json

The response is object.

500: An unexpected error occurred

application/json

Example response:

{
  "detail": "An unexpected error occurred",
  "status": 500,
  "type": "/errors/types/server"
}

remove

DELETE /spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits

Operation ID: spendLimitsCardHolderDelete.

Authentication: bearer token (UserToken).

Parameters

Responses

204: Spend limits removed. No response body

403: The client lacks the CARDS_API_MANAGE_SPENDING_LIMITS permission on the business profile, or the cardholder profile is not accessible to it

application/json

Example response:

{
  "code": "unauthorized",
  "detail": "Operation is unauthorized",
  "status": 403,
  "type": "/errors/types/access"
}

422: A path parameter references a profile of the wrong type. businessProfileId must reference a business profile and cardHolderProfileId must reference a personal profile

application/json

Example response:

{
  "errors": [
    {
      "code": "invalid_value",
      "detail": "businessProfileId must reference a business profile",
      "ref": "businessProfileId"
    }
  ],
  "instance": "/v4/spend/profiles/12345/card-holder-profiles/67890/spend-limits",
  "status": 422,
  "title": "Validation error",
  "type": "/errors/types/validation"
}

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

application/json

The response is object.

500: An unexpected error occurred

application/json

Example response:

{
  "detail": "An unexpected error occurred",
  "status": 500,
  "type": "/errors/types/server"
}

update

PATCH /spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits

Operation ID: spendLimitsCardHolderUpdate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Example request body:

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

Responses

200: Updated cardholder spend limits. See Retrieve cardholder limits

application/json

400: The request could not be processed. Returned when a required field is absent (type, aggregateWindow, or a window's value), when aggregateWindow contains neither daily nor monthly, when a path parameter is not a valid integer, or when the body cannot be parsed. Field-level detail is provided in errors where available; for unparseable bodies the array is empty

application/json

403: The client lacks the CARDS_API_MANAGE_SPENDING_LIMITS permission on the business profile, or the cardholder profile is not accessible to it

application/json

Example response:

{
  "code": "unauthorized",
  "detail": "Operation is unauthorized",
  "status": 403,
  "type": "/errors/types/access"
}

422: The request is valid JSON but cannot be processed. A 422 is deterministic and actionable: the same request will fail the same way until the offending value is changed. The errors array identifies the parameter or field that caused the error. There are three cases, shown below

application/json

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

application/json

The response is object.

500: An unexpected error occurred

application/json

Example response:

{
  "detail": "An unexpected error occurred",
  "status": 500,
  "type": "/errors/types/server"
}