Get a spending limit by ID

Use this endpoint to retrieve a spending limit by its unique identifier.

GET /v1/limits/{id}

Get a spending limit by ID

cURL

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

200

{
  "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",
      "segmentId": "00000000-0000-0000-0000-000000000000",
      "subType": "purchase",
      "transactionType": "CARD"
    }
  ],
  "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"
}

Authorizations

BearerAuthApiKeyAuth

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string · required

Limit ID (UUID)

Response

200

application/json

OK

asset · string · required

Example:

"USD"

createdAt · string<date-time> · required

Example:

"2021-01-01T00:00:00Z"

limitId · string<uuid> · required

Example:

"00000000-0000-0000-0000-000000000000"

limitType · string · required

Example:

"DAILY"

maxAmount · string · required

Example:

"1000.00"

name · string · required

Maximum string length: 255

Example:

"Daily USD spending cap"

scopes · object[] | null · required

Show child attributes

status · string · required

Example:

"ACTIVE"

updatedAt · string<date-time> · required

Example:

"2021-01-01T00:00:00Z"

activeTimeEnd · string

Example:

"17:00"

activeTimeStart · string

Example:

"09:00"

customEndDate · string<date-time>

Example:

"2021-12-31T23:59:59Z"

customStartDate · string<date-time>

Example:

"2021-01-01T00:00:00Z"

deletedAt · string<date-time>

Example:

"2021-01-01T00:00:00Z"

description · string

Example:

"Caps daily USD outflows for retail accounts"

resetAt · string<date-time>

Example:

"2021-01-02T00:00:00Z"