Skip to content
/Card spending controls

Card creation & servicing (1.0)

Download OpenAPI description
cards.json
cards.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/digital-banking/cards/

Cards servicing

Operations

Encrypted PIN Change

Operations

Card spending controls

Operations

Create card controls list

Request

Creates a card controls list and applies it to all cards defined in the scope and scope_id of the request.

Bodyapplication/jsonrequired
scopestring(Scope)required

The scope of the card spending control.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
scope_idstringrequired

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.

Example: "54e06604b0cf825810bec508cc1f2dc7mcrd"
idempotency_keystring(uuid)required

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

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
inclusionobject(ListRule)
exclusionobject(ListRule)
application/json
{
  "scope": "CARD",
  "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
  "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
  "inclusion": {
    "type": "MERCHANT_CATEGORY",
    "dimension": [ … ]
  },
  "exclusion": {
    "type": "MERCHANT_CATEGORY",
    "dimension": [ … ]
  }
}

Responses

The card controls list was successfully created.

Bodyapplication/json
idstringrequired

ID of the created card controls list.

Example: "7a911b90-0109-11ec-9a03-0242ac130003"
scopestring(Scope)required

The scope of the card spending control.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
scope_idstringrequired

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.

Example: "54e06604b0cf825810bec508cc1f2dc7mcrd"
originstring(Origin)required

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

Enum"SOLARISBANK""PARTNER"
idempotency_keystring(uuid)required

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

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
inclusionobject(ListRule)
exclusionobject(ListRule)
Response
application/json
{
  "id": "7a911b90-0109-11ec-9a03-0242ac130003",
  "scope": "CARD",
  "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
  "origin": "SOLARISBANK",
  "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
  "inclusion": {
    "type": "MERCHANT_CATEGORY",
    "dimension": [ … ]
  },
  "exclusion": {
    "type": "MERCHANT_CATEGORY",
    "dimension": [ … ]
  }
}

Index card controls lists

Request

Returns an array containing all active card controls lists in place for your customers.

Query
filter[scope]string(Scope)required

Filter the results by the type of scope.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
filter[scope_id]string

Filter the results by a specific scope (e.g., the ID of an account or the person ID of a cardholder).

include_relatedboolean

Using this filter, the API will return all card controls lists that were defined at the ACCOUNT, BUSINESS, or PARTNER level that apply to a specific card. You can only use this filter in combination with the scope and scope_id filters. The scope must be set to CARD and the scope_id must be set to a card ID.

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstringrequired

ID of the created card controls list.

Example: "7a911b90-0109-11ec-9a03-0242ac130003"
scopestring(Scope)required

The scope of the card spending control.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
scope_idstringrequired

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.

Example: "54e06604b0cf825810bec508cc1f2dc7mcrd"
originstring(Origin)required

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

Enum"SOLARISBANK""PARTNER"
idempotency_keystring(uuid)required

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

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
inclusionobject(ListRule)
exclusionobject(ListRule)
]
Response
application/json
[
  {
    "id": "7a911b90-0109-11ec-9a03-0242ac130003",
    "scope": "CARD",
    "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
    "origin": "SOLARISBANK",
    "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
    "inclusion": { … },
    "exclusion": { … }
  }
]

Retrieve a card controls list

Request

Returns the card controls list with the ID specified in the request URL.

Path
idstringrequired

ID of the card controls list to retrieve.

No request payload

Responses

The operation was successful.

Bodyapplication/json
idstringrequired

ID of the created card controls list.

Example: "7a911b90-0109-11ec-9a03-0242ac130003"
scopestring(Scope)required

The scope of the card spending control.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
scope_idstringrequired

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.

Example: "54e06604b0cf825810bec508cc1f2dc7mcrd"
originstring(Origin)required

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

Enum"SOLARISBANK""PARTNER"
idempotency_keystring(uuid)required

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

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
inclusionobject(ListRule)
exclusionobject(ListRule)
Response
application/json
{
  "id": "7a911b90-0109-11ec-9a03-0242ac130003",
  "scope": "CARD",
  "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
  "origin": "SOLARISBANK",
  "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
  "inclusion": {
    "type": "MERCHANT_CATEGORY",
    "dimension": [ … ]
  },
  "exclusion": {
    "type": "MERCHANT_CATEGORY",
    "dimension": [ … ]
  }
}

Delete card controls list

Request

Deletes the card controls list specified in the request URL.

Path
idstringrequired

ID of the card controls list to delete.

No request payload

Responses

No Content

Response
No content

Create card spending limit control

Request

Creates a card spending limit control and applies it to all cards defined in the scope and scope_id of the request.

Bodyapplication/jsonrequired
scopestring(Scope)required

The scope of the card spending control.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
scope_idstringrequired

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.

Example: "54e06604b0cf825810bec508cc1f2dc7mcrd"
idempotency_keystring(uuid)required

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

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
limitobject(SpendingLimitRule)required

Amount or count limit - only one could be used.

limit.​dimensionArray of stringsuniquerequired

The dimension of transactions to be restricted.

Example: ["5411"]
limit.​typestring(DimensionType)required

The type of transactions to be included/excluded.

Enum"MERCHANT_CATEGORY""POS_ENTRY_MODE""TRANSACTION_TYPE""MERCHANT_COUNTRY""ACQUIRER_ID""MERCHANT_ID""ALL_TYPES"
limit.​periodstring(Period)required

The time period in which to restrict transactions.

Enum"HOURLY""DAILY""WEEKLY""MONTHLY""MINUTES_60""HOURS_24""DAYS_7""DAYS_30""TRANSACTION"
limit.​amountinteger

The maximum amount (in Euro cents) that customers may spend under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

Example: 10000
limit.​countinteger

The maximum number of transactions that customers may conduct under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

application/json
{
  "scope": "CARD",
  "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
  "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
  "limit": {
    "type": "MERCHANT_CATEGORY",
    "dimension": [ … ],
    "period": "HOURLY",
    "amount": 10000,
    "count": 0
  }
}

Responses

The card spending limit control was successfully created.

Bodyapplication/json
idstringrequired

ID of the created card spending limit control.

Example: "7a911b90-0109-11ec-9a03-0242ac130003"
scopestring(Scope)required

The scope of the card spending control.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
scope_idstringrequired

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.

Example: "54e06604b0cf825810bec508cc1f2dc7mcrd"
originstring(Origin)required

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

Enum"SOLARISBANK""PARTNER"
idempotency_keystring(uuid)required

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

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
limitobject(SpendingLimitRule)required

Amount or count limit - only one could be used.

limit.​dimensionArray of stringsuniquerequired

The dimension of transactions to be restricted.

Example: ["5411"]
limit.​typestring(DimensionType)required

The type of transactions to be included/excluded.

Enum"MERCHANT_CATEGORY""POS_ENTRY_MODE""TRANSACTION_TYPE""MERCHANT_COUNTRY""ACQUIRER_ID""MERCHANT_ID""ALL_TYPES"
limit.​periodstring(Period)required

The time period in which to restrict transactions.

Enum"HOURLY""DAILY""WEEKLY""MONTHLY""MINUTES_60""HOURS_24""DAYS_7""DAYS_30""TRANSACTION"
limit.​amountinteger

The maximum amount (in Euro cents) that customers may spend under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

Example: 10000
limit.​countinteger

The maximum number of transactions that customers may conduct under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

Response
application/json
{
  "id": "7a911b90-0109-11ec-9a03-0242ac130003",
  "scope": "CARD",
  "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
  "origin": "SOLARISBANK",
  "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
  "limit": {
    "type": "MERCHANT_CATEGORY",
    "dimension": [ … ],
    "period": "HOURLY",
    "amount": 10000,
    "count": 0
  }
}

Index card spending limit controls

Request

Returns all active card spending limit controls.

Query
filter[scope]string(Scope)required

Filter the results by the type of scope.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
filter[scope_id]string

Filter the results by a specific scope (e.g., the ID of an account or the person ID of a cardholder).

include_relatedboolean

Using this filter, the API will return all card spending limit controls that were defined at the ACCOUNT, BUSINESS, or PARTNER level that apply to a specific card. You can only use this filter in combination with the scope and scope_id filters. The scope must be set to CARD and the scope_id must be set to a card ID.

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstringrequired

ID of the created card spending limit control.

Example: "7a911b90-0109-11ec-9a03-0242ac130003"
scopestring(Scope)required

The scope of the card spending control.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
scope_idstringrequired

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.

Example: "54e06604b0cf825810bec508cc1f2dc7mcrd"
originstring(Origin)required

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

Enum"SOLARISBANK""PARTNER"
idempotency_keystring(uuid)required

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

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
limitobject(SpendingLimitRule)required

Amount or count limit - only one could be used.

limit.​dimensionArray of stringsuniquerequired

The dimension of transactions to be restricted.

Example: ["5411"]
limit.​typestring(DimensionType)required

The type of transactions to be included/excluded.

Enum"MERCHANT_CATEGORY""POS_ENTRY_MODE""TRANSACTION_TYPE""MERCHANT_COUNTRY""ACQUIRER_ID""MERCHANT_ID""ALL_TYPES"
limit.​periodstring(Period)required

The time period in which to restrict transactions.

Enum"HOURLY""DAILY""WEEKLY""MONTHLY""MINUTES_60""HOURS_24""DAYS_7""DAYS_30""TRANSACTION"
limit.​amountinteger

The maximum amount (in Euro cents) that customers may spend under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

Example: 10000
limit.​countinteger

The maximum number of transactions that customers may conduct under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

]
Response
application/json
[
  {
    "id": "7a911b90-0109-11ec-9a03-0242ac130003",
    "scope": "CARD",
    "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
    "origin": "SOLARISBANK",
    "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
    "limit": { … }
  }
]

Retrieve a card spending limit control

Request

Returns information about the card spending limit control specified in the request URL.

Path
idstringrequired

ID of the card spending limit control.

No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstringrequired

ID of the card spending limit control.

Example: "7a911b90-0109-11ec-9a03-0242ac130003"
scopestring(Scope)required

The scope of the card spending control.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
scope_idstringrequired

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.

Example: "54e06604b0cf825810bec508cc1f2dc7mcrd"
originstring(Origin)required

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

Enum"SOLARISBANK""PARTNER"
idempotency_keystring(uuid)required

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

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
limitobject(SpendingLimitRule)required

Amount or count limit - only one could be used.

limit.​dimensionArray of stringsuniquerequired

The dimension of transactions to be restricted.

Example: ["5411"]
limit.​typestring(DimensionType)required

The type of transactions to be included/excluded.

Enum"MERCHANT_CATEGORY""POS_ENTRY_MODE""TRANSACTION_TYPE""MERCHANT_COUNTRY""ACQUIRER_ID""MERCHANT_ID""ALL_TYPES"
limit.​periodstring(Period)required

The time period in which to restrict transactions.

Enum"HOURLY""DAILY""WEEKLY""MONTHLY""MINUTES_60""HOURS_24""DAYS_7""DAYS_30""TRANSACTION"
limit.​amountinteger

The maximum amount (in Euro cents) that customers may spend under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

Example: 10000
limit.​countinteger

The maximum number of transactions that customers may conduct under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

utilized_limitobject(UtilizedSpendingLimitRule)required
utilized_limit.​amountintegerrequired

The amount that has been spent under this card spending limit control to date.

Example: 10000
utilized_limit.​countintegerrequired

The number of transactions that have been conducted under this card spending limit control to date.

Example: 5
Response
application/json
{
  "id": "7a911b90-0109-11ec-9a03-0242ac130003",
  "scope": "CARD",
  "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
  "origin": "SOLARISBANK",
  "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
  "limit": {
    "type": "MERCHANT_CATEGORY",
    "dimension": [ … ],
    "period": "HOURLY",
    "amount": 10000,
    "count": 0
  },
  "utilized_limit": {
    "amount": 10000,
    "count": 5
  }
}

Delete card spending limit control

Request

Deletes the card spending limit control specified in the request URL.

Path
idstringrequired

ID of the card spending limit control to delete.

No request payload

Responses

No Content

Response
No content

Create card spending limit control (V2)

Request

Creates a card spending limit control and applies it to all cards defined in the scope and scope_id of the request.
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 a version, then the API will return the older version of the response.

Bodyapplication/jsonrequired
scopestring(Scope)required

The scope of the card spending control.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
scope_idstringrequired

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.

Example: "54e06604b0cf825810bec508cc1f2dc7mcrd"
idempotency_keystring(uuid)required

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

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
limitobject(SpendingLimitRuleV2)required

Object containing the properties of the spending limit control. Note that you must set either amount or count; you cannot set both.

limit.​periodstring(Period)required

The time period in which to restrict transactions.

Enum"HOURLY""DAILY""WEEKLY""MONTHLY""MINUTES_60""HOURS_24""DAYS_7""DAYS_30""TRANSACTION"
limit.​amountinteger

The maximum amount (in Euro cents) that customers may spend under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

Example: 10000
limit.​countinteger

The maximum number of transactions that customers may conduct under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

limit.​conditionsArray of objects(DimensionCondition)

Object containing the dimensions to either include or exclude in this control. Note that you must use either dimension or excluded_dimension; you cannot use both.

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.

application/json
{
  "scope": "CARD",
  "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
  "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
  "limit": {
    "period": "HOURLY",
    "amount": 10000,
    "count": 0,
    "conditions": [ … ]
  },
  "positive_balance_limit": true
}

Responses

The card spending limit control was successfully created.

Bodyapplication/json
idstringrequired

ID of the created card spending limit control.

Example: "7a911b90-0109-11ec-9a03-0242ac130003"
scopestring(Scope)required

The scope of the card spending control.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
scope_idstringrequired

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.

Example: "54e06604b0cf825810bec508cc1f2dc7mcrd"
originstring(Origin)required

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

Enum"SOLARISBANK""PARTNER"
idempotency_keystring(uuid)required

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

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
limitobject(SpendingLimitRuleV2)required

Object containing the properties of the spending limit control. Note that you must set either amount or count; you cannot set both.

limit.​periodstring(Period)required

The time period in which to restrict transactions.

Enum"HOURLY""DAILY""WEEKLY""MONTHLY""MINUTES_60""HOURS_24""DAYS_7""DAYS_30""TRANSACTION"
limit.​amountinteger

The maximum amount (in Euro cents) that customers may spend under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

Example: 10000
limit.​countinteger

The maximum number of transactions that customers may conduct under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

limit.​conditionsArray of objects(DimensionCondition)

Object containing the dimensions to either include or exclude in this control. Note that you must use either dimension or excluded_dimension; you cannot use both.

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.

Response
application/json
{
  "id": "7a911b90-0109-11ec-9a03-0242ac130003",
  "scope": "CARD",
  "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
  "origin": "SOLARISBANK",
  "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
  "limit": {
    "period": "HOURLY",
    "amount": 10000,
    "count": 0,
    "conditions": [ … ]
  },
  "positive_balance_limit": true
}

Index card spending limit controls (V2)

Request

Returns all active card spending limit controls.
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.

Query
filter[scope]string(Scope)required

Filter the results by the type of scope.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
filter[scope_id]string

Filter the results by a specific scope (e.g., the ID of an account or the person ID of a cardholder).

include_relatedboolean

Using this filter, the API will return all card spending limit controls that were defined at the ACCOUNT, BUSINESS, or PARTNER level that apply to a specific card. You can only use this filter in combination with the scope and scope_id filters. The scope must be set to CARD and the scope_id must be set to a card ID.

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstringrequired

ID of the created card spending limit control.

Example: "7a911b90-0109-11ec-9a03-0242ac130003"
scopestring(Scope)required

The scope of the card spending control.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
scope_idstringrequired

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.

Example: "54e06604b0cf825810bec508cc1f2dc7mcrd"
originstring(Origin)required

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

Enum"SOLARISBANK""PARTNER"
idempotency_keystring(uuid)required

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

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
limitobject(SpendingLimitRuleV2)required

Object containing the properties of the spending limit control. Note that you must set either amount or count; you cannot set both.

limit.​periodstring(Period)required

The time period in which to restrict transactions.

Enum"HOURLY""DAILY""WEEKLY""MONTHLY""MINUTES_60""HOURS_24""DAYS_7""DAYS_30""TRANSACTION"
limit.​amountinteger

The maximum amount (in Euro cents) that customers may spend under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

Example: 10000
limit.​countinteger

The maximum number of transactions that customers may conduct under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

limit.​conditionsArray of objects(DimensionCondition)

Object containing the dimensions to either include or exclude in this control. Note that you must use either dimension or excluded_dimension; you cannot use both.

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.

]
Response
application/json
[
  {
    "id": "7a911b90-0109-11ec-9a03-0242ac130003",
    "scope": "CARD",
    "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
    "origin": "SOLARISBANK",
    "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
    "limit": { … },
    "positive_balance_limit": true
  }
]

Retrieve a card spending limit control (V2)

Request

Returns information about the card spending limit control specified in the request URL.
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.

Path
idstringrequired

ID of the card spending limit control.

No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstringrequired

ID of the card spending limit control.

Example: "7a911b90-0109-11ec-9a03-0242ac130003"
scopestring(Scope)required

The scope of the card spending control.

Enum"CARD""CARDHOLDER""ACCOUNT""BUSINESS""PARTNER""PARTNER_CARDS""BUSINESS_CARDS""ACCOUNT_CARDS""CARDHOLDER_CARDS""NON_BUSINESS_CARDS"
scope_idstringrequired

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.

Example: "54e06604b0cf825810bec508cc1f2dc7mcrd"
originstring(Origin)required

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

Enum"SOLARISBANK""PARTNER"
idempotency_keystring(uuid)required

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

Example: "504f6816-f7b5-4965-bc35-69acadc9f5c7"
limitobject(SpendingLimitRuleV2)required

Object containing the properties of the spending limit control. Note that you must set either amount or count; you cannot set both.

limit.​periodstring(Period)required

The time period in which to restrict transactions.

Enum"HOURLY""DAILY""WEEKLY""MONTHLY""MINUTES_60""HOURS_24""DAYS_7""DAYS_30""TRANSACTION"
limit.​amountinteger

The maximum amount (in Euro cents) that customers may spend under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

Example: 10000
limit.​countinteger

The maximum number of transactions that customers may conduct under this card spending limit control. Note: You cannot set amount and count together under the same scope ID.

limit.​conditionsArray of objects(DimensionCondition)

Object containing the dimensions to either include or exclude in this control. Note that you must use either dimension or excluded_dimension; you cannot use both.

utilized_limitobject(UtilizedSpendingLimitRule)required
utilized_limit.​amountintegerrequired

The amount that has been spent under this card spending limit control to date.

Example: 10000
utilized_limit.​countintegerrequired

The number of transactions that have been conducted under this card spending limit control to date.

Example: 5
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.

Response
application/json
{
  "id": "7a911b90-0109-11ec-9a03-0242ac130003",
  "scope": "CARD",
  "scope_id": "54e06604b0cf825810bec508cc1f2dc7mcrd",
  "origin": "SOLARISBANK",
  "idempotency_key": "504f6816-f7b5-4965-bc35-69acadc9f5c7",
  "limit": {
    "period": "HOURLY",
    "amount": 10000,
    "count": 0,
    "conditions": [ … ]
  },
  "utilized_limit": {
    "amount": 10000,
    "count": 5
  },
  "positive_balance_limit": true
}

Delete card spending limit control (V2)

Request

Deletes the card spending limit control specified in the request URL..
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.

Path
idstringrequired

ID of the card spending limit control to delete.

No request payload

Responses

No Content

Response
No content

Card transactions

Operations

Card transactions simulation

Operations

Card Delivery Tracking API

Operations