List spending limits

Use this endpoint to list spending limits with cursor-based pagination and optional filters. DELETED limits are not returned in listings.

GET /v1/limits

List spending limits

cURL

curl --request GET \
  --url https://tracer.sandbox.lerian.net/v1/limits \
  --header 'Authorization: Bearer <token>'

200

{
  "hasMore": true,
  "limits": [
    {
      "asset": "USD",
      "createdAt": "2021-01-01T00:00:00Z",
      "limitId": "00000000-0000-0000-0000-000000000000",
      "limitType": "DAILY",
      "maxAmount": "1000.00",
      "name": "Daily USD spending cap",
      "scopes": [
        {
          "accountId": "00000000-0000-0000-0000-000000000000",
          "merchantId": "00000000-0000-0000-0000-000000000000",
          "portfolioId": "00000000-0000-0000-0000-000000000000",
          "scheme": "PIX",
          "segmentId": "00000000-0000-0000-0000-000000000000",
          "subType": "purchase",
          "transactionType": "PIX"
        }
      ],
      "status": "ACTIVE",
      "updatedAt": "2021-01-01T00:00:00Z",
      "activeTimeEnd": "17:00",
      "activeTimeStart": "09:00",
      "customEndDate": "2021-12-31T23:59:59Z",
      "customStartDate": "2021-01-01T00:00:00Z",
      "deletedAt": "2021-01-01T00:00:00Z",
      "description": "Caps daily USD outflows for retail accounts",
      "resetAt": "2021-01-02T00:00:00Z",
      "resetTime": "09:00"
    }
  ],
  "nextCursor": "eyJpZCI6IjAxOTI4In0="
}

Authorizations

BearerAuthApiKeyAuth

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Query Parameters

name · string

Filter by name (case-insensitive partial match)

status · string

Filter by status (DRAFT, ACTIVE, INACTIVE)

limit_type · string

Filter by limit type (DAILY, WEEKLY, MONTHLY, CUSTOM, PER_TRANSACTION)

account_id · string

Filter by scope account_id (UUID)

segment_id · string

Filter by scope segment_id (UUID)

portfolio_id · string

Filter by scope portfolio_id (UUID)

merchant_id · string

Filter by scope merchant_id (UUID)

transaction_type · string · deprecated

Deprecated: use scheme. Same filter under its former name; when both are sent they must carry the same value

scheme · string

Filter by scope payment scheme: 1 to 50 characters of A-Z, 0-9, _ or -, trimmed and upper-cased before matching

sub_type · string

Filter by scope sub_type (case-insensitive; max 50 chars)

limit · string

Max items per page (1-100, default: 10)

cursor · string

Pagination cursor (empty for first page)

sort_by · string

Sort field (created_at, updated_at, name, max_amount)

sort_order · string

Sort direction (ASC, DESC)

Response

200

application/json

OK

hasMore · boolean · required

Example:

true

limits · object[] | null · required

Show child attributes

nextCursor · string

Example:

"eyJpZCI6IjAxOTI4In0="