Get effective limits

GET

/providers/{providerID}/participants/{participantID}/effective-limits

Resolve the effective send-side limits for one participant. Each dimension names its source: platform, provider, group, or override. A dimension with no ceiling at any level is omitted.

Auth: API key or bearer token. Scoped to the calling provider.

Request

cURL

curl -X GET https://api.moov.money/providers/{providerID}/participants/{participantID}/effective-limits

Responses

200 401 403 404

The request completed successfully.

{
  "effectiveLimits": {
    "dailyAmount": {
      "ceiling": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2
        },
        "value": "500.00"
      },
      "platformMaximum": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2,
          "name": "US Dollar",
          "numericCode": "840"
        },
        "value": "100.00"
      },
      "source": "provider",
      "stored": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2,
          "name": "US Dollar",
          "numericCode": "840"
        },
        "value": "100.00"
      }
    },
    "dailySendCount": {
      "ceiling": 25,
      "source": "provider"
    },
    "monthlyAmount": {
      "ceiling": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2
        },
        "value": "500.00"
      },
      "platformMaximum": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2,
          "name": "US Dollar",
          "numericCode": "840"
        },
        "value": "100.00"
      },
      "source": "provider",
      "stored": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2,
          "name": "US Dollar",
          "numericCode": "840"
        },
        "value": "100.00"
      }
    },
    "perTransactionAmount": {
      "ceiling": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2
        },
        "value": "500.00"
      },
      "platformMaximum": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2,
          "name": "US Dollar",
          "numericCode": "840"
        },
        "value": "100.00"
      },
      "source": "provider",
      "stored": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2,
          "name": "US Dollar",
          "numericCode": "840"
        },
        "value": "100.00"
      }
    },
    "weeklyAmount": {
      "ceiling": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2
        },
        "value": "500.00"
      },
      "platformMaximum": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2,
          "name": "US Dollar",
          "numericCode": "840"
        },
        "value": "100.00"
      },
      "source": "provider",
      "stored": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2,
          "name": "US Dollar",
          "numericCode": "840"
        },
        "value": "100.00"
      }
    }
  },
  "participantID": "usr_01HF5J9ZKQT4RXP8M2VYBN3D"
}

Authentication missing, invalid, or insufficient.

Authentication present but the action is forbidden for this principal/claim.

The requested resource was not found.

Headers

X-Moov-Version

string

Set this header to the API version being targeted (e.g. v2026.07.00). When omitted, the server applies its default version.

Path parameters

providerID

string

required

Your provider account ID.

participantID

string

required

The participant’s participantID, or your externalID for them. Both resolve to the same participant.

Response

Response envelope for get effective limits.

effectiveLimits

object

required

The resolved effective limits.

Show child attributes

effectiveLimits

dailyAmount

object

A resolved amount limit. ceiling is the effective value; source names its provenance.

Show child attributes

effectiveLimits.dailyAmount

source

string

required

Provenance: platform, provider, group:<name>, override, or <source>+platform-clamp when the platform maximum tightened it.

stored

object

Pre-clamp stored value, present only when the platform maximum tightened it.

Show child attributes

effectiveLimits.dailyAmount.stored

currency

object

required

ISO 4217 currency descriptor.

Show child attributes

effectiveLimits.dailyAmount.stored.currency

decimalPlaces

integer<uint8>

required

Number of minor-unit decimal places for code. Required.

numericCode

string

ISO 4217 numeric currency code, if known. Informational only.

name

string

Human-readable currency name, if known. Informational only.

code

string

required

Uppercase 3-letter ISO 4217 currency code.

value

string

required

Decimal amount as a string.

platformMaximum

object

The platform maximum that clamped this dimension, present when clamped.

Show child attributes

effectiveLimits.dailyAmount.platformMaximum

currency

object

required

ISO 4217 currency descriptor.

Show child attributes

effectiveLimits.dailyAmount.platformMaximum.currency

decimalPlaces

integer<uint8>

required

Number of minor-unit decimal places for code. Required.

numericCode

string

ISO 4217 numeric currency code, if known. Informational only.

name

string

Human-readable currency name, if known. Informational only.

code

string

required

Uppercase 3-letter ISO 4217 currency code.

value

string

required

Decimal amount as a string.

expiresOn

string<date-time>

When an override-sourced value lapses.

ceiling

object

required

Effective ceiling.

Show child attributes

effectiveLimits.dailyAmount.ceiling

currency

object

required

ISO 4217 currency descriptor.

Show child attributes

effectiveLimits.dailyAmount.ceiling.currency

decimalPlaces

integer<uint8>

required

Number of minor-unit decimal places for code. Required.

numericCode

string

ISO 4217 numeric currency code, if known. Informational only.

name

string

Human-readable currency name, if known. Informational only.

code

string

required

Uppercase 3-letter ISO 4217 currency code.

value

string

required

Decimal amount as a string.

weeklyAmount

object

A resolved amount limit. ceiling is the effective value; source names its provenance.

Show child attributes

effectiveLimits.weeklyAmount

source

string

required

Provenance: platform, provider, group:<name>, override, or <source>+platform-clamp when the platform maximum tightened it.

stored

object

Pre-clamp stored value, present only when the platform maximum tightened it.

Show child attributes

effectiveLimits.weeklyAmount.stored

currency

object

required

ISO 4217 currency descriptor.

Show child attributes

effectiveLimits.weeklyAmount.stored.currency

decimalPlaces

integer<uint8>

required

Number of minor-unit decimal places for code. Required.

numericCode

string

ISO 4217 numeric currency code, if known. Informational only.

name

string

Human-readable currency name, if known. Informational only.

code

string

required

Uppercase 3-letter ISO 4217 currency code.

value

string

required

Decimal amount as a string.

platformMaximum

object

The platform maximum that clamped this dimension, present when clamped.

Show child attributes

effectiveLimits.weeklyAmount.platformMaximum

currency

object

required

ISO 4217 currency descriptor.

Show child attributes

effectiveLimits.weeklyAmount.platformMaximum.currency

decimalPlaces

integer<uint8>

required

Number of minor-unit decimal places for code. Required.

numericCode

string

ISO 4217 numeric currency code, if known. Informational only.

name

string

Human-readable currency name, if known. Informational only.

code

string

required

Uppercase 3-letter ISO 4217 currency code.

value

string

required

Decimal amount as a string.

expiresOn

string<date-time>

When an override-sourced value lapses.

ceiling

object

required

Effective ceiling.

Show child attributes

effectiveLimits.weeklyAmount.ceiling

currency

object

required

ISO 4217 currency descriptor.

Show child attributes

effectiveLimits.weeklyAmount.ceiling.currency

decimalPlaces

integer<uint8>

required

Number of minor-unit decimal places for code. Required.

numericCode

string

ISO 4217 numeric currency code, if known. Informational only.

name

string

Human-readable currency name, if known. Informational only.

code

string

required

Uppercase 3-letter ISO 4217 currency code.

value

string

required

Decimal amount as a string.

monthlyAmount

object

A resolved amount limit. ceiling is the effective value; source names its provenance.

Show child attributes

effectiveLimits.monthlyAmount

source

string

required

Provenance: platform, provider, group:<name>, override, or <source>+platform-clamp when the platform maximum tightened it.

stored

object

Pre-clamp stored value, present only when the platform maximum tightened it.

Show child attributes

effectiveLimits.monthlyAmount.stored

currency

object

required

ISO 4217 currency descriptor.

Show child attributes

effectiveLimits.monthlyAmount.stored.currency

decimalPlaces

integer<uint8>

required

Number of minor-unit decimal places for code. Required.

numericCode

string

ISO 4217 numeric currency code, if known. Informational only.

name

string

Human-readable currency name, if known. Informational only.

code

string

required

Uppercase 3-letter ISO 4217 currency code.

value

string

required

Decimal amount as a string.

platformMaximum

object

The platform maximum that clamped this dimension, present when clamped.

Show child attributes

effectiveLimits.monthlyAmount.platformMaximum

currency

object

required

ISO 4217 currency descriptor.

Show child attributes

effectiveLimits.monthlyAmount.platformMaximum.currency

decimalPlaces

integer<uint8>

required

Number of minor-unit decimal places for code. Required.

numericCode

string

ISO 4217 numeric currency code, if known. Informational only.

name

string

Human-readable currency name, if known. Informational only.

code

string

required

Uppercase 3-letter ISO 4217 currency code.

value

string

required

Decimal amount as a string.

expiresOn

string<date-time>

When an override-sourced value lapses.

ceiling

object

required

Effective ceiling.

Show child attributes

effectiveLimits.monthlyAmount.ceiling

currency

object

required

ISO 4217 currency descriptor.

Show child attributes

effectiveLimits.monthlyAmount.ceiling.currency

decimalPlaces

integer<uint8>

required

Number of minor-unit decimal places for code. Required.

numericCode

string

ISO 4217 numeric currency code, if known. Informational only.

name

string

Human-readable currency name, if known. Informational only.

code

string

required

Uppercase 3-letter ISO 4217 currency code.

value

string

required

Decimal amount as a string.

dailySendCount

object

A resolved count limit.

Show child attributes

effectiveLimits.dailySendCount

source

string

required

Provenance: platform, provider, group:<name>, or override.

expiresOn

string<date-time>

When an override-sourced value lapses.

ceiling

integer<int64>

required

Effective ceiling.

perTransactionAmount

object

A resolved amount limit. ceiling is the effective value; source names its provenance.

Show child attributes

effectiveLimits.perTransactionAmount

source

string

required

Provenance: platform, provider, group:<name>, override, or <source>+platform-clamp when the platform maximum tightened it.

stored

object

Pre-clamp stored value, present only when the platform maximum tightened it.

Show child attributes

effectiveLimits.perTransactionAmount.stored

currency

object

required

ISO 4217 currency descriptor.

Show child attributes

effectiveLimits.perTransactionAmount.stored.currency

decimalPlaces

integer<uint8>

required

Number of minor-unit decimal places for code. Required.

numericCode

string

ISO 4217 numeric currency code, if known. Informational only.

name

string

Human-readable currency name, if known. Informational only.

code

string

required

Uppercase 3-letter ISO 4217 currency code.

value

string

required

Decimal amount as a string.

platformMaximum

object

The platform maximum that clamped this dimension, present when clamped.

Show child attributes

effectiveLimits.perTransactionAmount.platformMaximum

currency

object

required

ISO 4217 currency descriptor.

Show child attributes

effectiveLimits.perTransactionAmount.platformMaximum.currency

decimalPlaces

integer<uint8>

required

Number of minor-unit decimal places for code. Required.

numericCode

string

ISO 4217 numeric currency code, if known. Informational only.

name

string

Human-readable currency name, if known. Informational only.

code

string

required

Uppercase 3-letter ISO 4217 currency code.

value

string

required

Decimal amount as a string.

expiresOn

string<date-time>

When an override-sourced value lapses.

ceiling

object

required

Effective ceiling.

Show child attributes

effectiveLimits.perTransactionAmount.ceiling

currency

object

required

ISO 4217 currency descriptor.

Show child attributes

effectiveLimits.perTransactionAmount.ceiling.currency

decimalPlaces

integer<uint8>

required

Number of minor-unit decimal places for code. Required.

numericCode

string

ISO 4217 numeric currency code, if known. Informational only.

name

string

Human-readable currency name, if known. Informational only.

code

string

required

Uppercase 3-letter ISO 4217 currency code.

value

string

required

Decimal amount as a string.

participantID

string

required

The participant the limits resolved for.