Sign in
latestOpenAPI 3.0.12026-08-104068226.2 KB

a772504dcc9e

Card spending controls

Retrieve a card spending limit control (V2)

Returns information about the card spending limit control specified in the request URL.<br> Important This endpoint replaces the old version. However, please note that you have to set the api-version header to the version you want (e.g., 2024-01-01). If you do not specify an api-version, then the API will return the older version of the response.

get/v1/card_controls/spending_limits/{id}(v2)

Path parameters

idstring required

ID of the card spending limit control.

Response

Successful result of the operation

idstring required

ID of the card spending limit control.

scope'CARD' | 'CARDHOLDER' | 'ACCOUNT' | 'BUSINESS' | 'PARTNER' | 'PARTNER_CARDS' | 'BUSINESS_CARDS' | 'ACCOUNT_CARDS' | 'CARDHOLDER_CARDS' | 'NON_BUSINESS_CARDS' | 'PARTNER_CARDHOLDERS' required

The scope of the card spending control.

scope_idstring required

ID of the resource that corresponds with the scope. For example, if the scope is PARTNER, then the scope_id would be your partner ID. For business, it would be the business ID.

origin'SOLARISBANK' | 'PARTNER' required

Indicates whether the card spending control was created by Solaris SE or by you.

idempotency_keystring uuid required

A randomly generated UUID which the server uses to recognize subsequent retries of the same request.

positive_balance_limitboolean

It is set to true if the limit field represents positive balance limit. It is an optional field. Default value is false.

Example response

{
  "id": "7a911b90-0109-11ec-9a03-0242ac130003",
  "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
  "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
  "limit": {
    "amount": 10000,
    "conditions": [
      {
        "dimension": [
          "5411"
        ],
        "excluded_dimension": [
          "5411"
        ]
      }
    ]
  },
  "utilized_limit": {
    "amount": 10000,
    "count": 5
  }
}