MOmonta
Charge Key Limit Caps

Retrieve charge key limit caps

Changed on

Required scope: charge-auth-tokens:read </br>Organization authorization: supported

An operator has one set of caps per team settings profile (Hub: Operator team settings); defaultForTeamType says which teams get the set by default. A charge key's own usage limits (rollingSpendLimit, dailyChargeCountLimit, concurrentChargesLimit) may not exceed the caps its team is bound by. A null cap is not configured, so the recommended value is the cap. Caps may not exceed max, Monta's ceiling.

Only operator-scoped consumers may read caps; a team-scoped consumer gets 403.

get/api/v1/charge-key-limit-caps/{chargeKeyLimitCapId}

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/charge-key-limit-caps/{chargeKeyLimitCapId}
  • Auth
    HTTP bearer

Path parameters

chargeKeyLimitCapIdinteger required

Response

Charge key limit caps with provided id

idinteger

Id of this set of caps

operatorIdinteger

Id of the operator these caps belong to

namestring nullable

Name of the team settings profile, as shown in the Hub

defaultForTeamTypestring nullable

Teams of this type get these caps by default: professional, private, all, operator, default_private_team, none, or null when the caps apply only to teams assigned to the profile explicitly. Also sets which recommended and max values apply.

dailyChargeCountLimitinteger nullable

Cap on a charge key's daily charge count. null means no cap is configured, so recommended applies.

concurrentChargesLimitinteger nullable

Cap on a charge key's concurrent charges. null means no cap is configured, so recommended applies.

Example response

{
  "id": 42,
  "operatorId": 1,
  "name": "Fleet customers",
  "defaultForTeamType": "professional",
  "rollingSpendLimit": {
    "amount": 12312,
    "currency": {
      "id": 1,
      "master": true,
      "identifier": "DKK",
      "name": "Danish krone",
      "decimals": 2
    },
    "locale": "en"
  },
  "dailyChargeCountLimit": 20,
  "concurrentChargesLimit": 10,
  "recommended": {
    "rollingSpendLimit": {
      "amount": 12312,
      "currency": {
        "id": 1,
        "master": true,
        "identifier": "DKK",
        "name": "Danish krone",
        "decimals": 2
      },
      "locale": "en"
    },
    "dailyChargeCountLimit": 14,
    "concurrentChargesLimit": 7
  },
  "max": {
    "rollingSpendLimit": {
      "amount": 12312,
      "currency": {
        "id": 1,
        "master": true,
        "identifier": "DKK",
        "name": "Danish krone",
        "decimals": 2
      },
      "locale": "en"
    },
    "dailyChargeCountLimit": 14,
    "concurrentChargesLimit": 7
  }
}

Changes