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 \
  -u "$MOOV_API_KEY_ID:$MOOV_API_KEY_SECRET" \
  -H "X-Moov-Version: v2026.10.00"
Responses
200 400 401 403 404
The request completed successfully.
{
  "calculatedOn": "2026-10-06T16:00:00Z",
  "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"
      },
      "remaining": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2
        },
        "value": "50.00"
      },
      "source": "provider",
      "sourceGroupID": "grp_01HF5J9ZKQT4RXP8M2VYBN3D",
      "stored": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2,
          "name": "US Dollar",
          "numericCode": "840"
        },
        "value": "100.00"
      },
      "used": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2
        },
        "value": "450.00"
      },
      "window": "24h"
    },
    "dailySendCount": {
      "ceiling": 25,
      "remaining": 19,
      "source": "provider",
      "sourceGroupID": "grp_01HF5J9ZKQT4RXP8M2VYBN3D",
      "used": 6,
      "window": "24h"
    },
    "monthlyAmount": {
      "ceiling": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2
        },
        "value": "500.00"
      },
      "platformMaximum": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2,
          "name": "US Dollar",
          "numericCode": "840"
        },
        "value": "100.00"
      },
      "remaining": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2
        },
        "value": "50.00"
      },
      "source": "provider",
      "sourceGroupID": "grp_01HF5J9ZKQT4RXP8M2VYBN3D",
      "stored": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2,
          "name": "US Dollar",
          "numericCode": "840"
        },
        "value": "100.00"
      },
      "used": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2
        },
        "value": "450.00"
      },
      "window": "24h"
    },
    "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",
      "sourceGroupID": "grp_01HF5J9ZKQT4RXP8M2VYBN3D",
      "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"
      },
      "remaining": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2
        },
        "value": "50.00"
      },
      "source": "provider",
      "sourceGroupID": "grp_01HF5J9ZKQT4RXP8M2VYBN3D",
      "stored": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2,
          "name": "US Dollar",
          "numericCode": "840"
        },
        "value": "100.00"
      },
      "used": {
        "currency": {
          "code": "USD",
          "decimalPlaces": 2
        },
        "value": "450.00"
      },
      "window": "24h"
    }
  },
  "participantID": "3v2whagmwvbujhwbt7v3nl6ffq_user"
}
Malformed request: the body or headers failed validation.
Response body application/problem+json
RFC 9457 Problem Details error body, served as application/problem+json. From v2026.10.00, every error response that has a body uses this schema.

type

string required
URI that tells you which problem occurred. Branch on this value; it never changes. Moov problem types look like https://api.moov.money/errors#<code> (for example invalid-request, idempotency-key-reused, or idempotency-request-in-progress). Treat the value as an opaque constant and do not fetch it. about:blank means the HTTP status code says everything there is to know.

title

string required
Short human-readable name of the problem type. Fixed per type; defaults to the HTTP status text.

status

integer<int32> required
The HTTP status code of this response.

detail

string
Human-readable explanation of this specific occurrence.

instance

string
URI reference that identifies this specific occurrence.

errors

array<object>
The request-body fields that failed validation. Present on validation errors only.
Show child attributes

errors[]

pointer

string required
RFC 6901 JSON Pointer to the field, using the public JSON field names. If the field is missing, the pointer shows where it belongs.

detail

string required
What is wrong with the field.
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.10.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.

participantID

string required
The participant the limits resolved for.

calculatedOn

string<date-time> required
When Moov Money calculated these limits. These values are advisory: Moov Money resolves limits again when you create a payout. A payout that fits remaining can still be rejected when you create it.

effectiveLimits

object required
The resolved effective limits.
Show child attributes

effectiveLimits

perTransactionAmount

object
A resolved amount limit. ceiling is the effective value after the platform maximum clamp; source names its provenance.
Show child attributes

effectiveLimits.perTransactionAmount

ceiling

object required
Effective ceiling, after the platform maximum clamp.
Show child attributes

effectiveLimits.perTransactionAmount.ceiling

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.perTransactionAmount.ceiling.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

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

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.perTransactionAmount.stored.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

platformMaximum

object
The platform maximum that clamped this dimension, present when clamped.
Show child attributes

effectiveLimits.perTransactionAmount.platformMaximum

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.perTransactionAmount.platformMaximum.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

sourceGroupID

string
The limit group that supplied this dimension when source names a group, clamped or not; absent for platform, provider, and override sources.

expiresOn

string<date-time>
When an override-sourced value lapses.

dailyAmount

object
A resolved amount limit with usage over its trailing window: 24h for dailyAmount, 7d for weeklyAmount, and 30d for monthlyAmount.
Show child attributes

effectiveLimits.dailyAmount

ceiling

object required
Effective ceiling, after the platform maximum clamp.
Show child attributes

effectiveLimits.dailyAmount.ceiling

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.dailyAmount.ceiling.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

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

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.dailyAmount.stored.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

platformMaximum

object
The platform maximum that clamped this dimension, present when clamped.
Show child attributes

effectiveLimits.dailyAmount.platformMaximum

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.dailyAmount.platformMaximum.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

sourceGroupID

string
The limit group that supplied this dimension when source names a group, clamped or not; absent for platform, provider, and override sources.

expiresOn

string<date-time>
When an override-sourced value lapses.

used

object required
Amount already sent in the trailing window.
Show child attributes

effectiveLimits.dailyAmount.used

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.dailyAmount.used.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

remaining

object required
What can still be sent in the trailing window: ceiling minus used, never negative.
Show child attributes

effectiveLimits.dailyAmount.remaining

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.dailyAmount.remaining.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

window

string<enum> required
The trailing window used and remaining count over: 24h for dailyAmount, 7d for weeklyAmount, and 30d for monthlyAmount.
Possible values: 24h, 7d, 30d

weeklyAmount

object
A resolved amount limit with usage over its trailing window: 24h for dailyAmount, 7d for weeklyAmount, and 30d for monthlyAmount.
Show child attributes

effectiveLimits.weeklyAmount

ceiling

object required
Effective ceiling, after the platform maximum clamp.
Show child attributes

effectiveLimits.weeklyAmount.ceiling

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.weeklyAmount.ceiling.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

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

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.weeklyAmount.stored.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

platformMaximum

object
The platform maximum that clamped this dimension, present when clamped.
Show child attributes

effectiveLimits.weeklyAmount.platformMaximum

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.weeklyAmount.platformMaximum.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

sourceGroupID

string
The limit group that supplied this dimension when source names a group, clamped or not; absent for platform, provider, and override sources.

expiresOn

string<date-time>
When an override-sourced value lapses.

used

object required
Amount already sent in the trailing window.
Show child attributes

effectiveLimits.weeklyAmount.used

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.weeklyAmount.used.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

remaining

object required
What can still be sent in the trailing window: ceiling minus used, never negative.
Show child attributes

effectiveLimits.weeklyAmount.remaining

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.weeklyAmount.remaining.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

window

string<enum> required
The trailing window used and remaining count over: 24h for dailyAmount, 7d for weeklyAmount, and 30d for monthlyAmount.
Possible values: 24h, 7d, 30d

monthlyAmount

object
A resolved amount limit with usage over its trailing window: 24h for dailyAmount, 7d for weeklyAmount, and 30d for monthlyAmount.
Show child attributes

effectiveLimits.monthlyAmount

ceiling

object required
Effective ceiling, after the platform maximum clamp.
Show child attributes

effectiveLimits.monthlyAmount.ceiling

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.monthlyAmount.ceiling.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

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

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.monthlyAmount.stored.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

platformMaximum

object
The platform maximum that clamped this dimension, present when clamped.
Show child attributes

effectiveLimits.monthlyAmount.platformMaximum

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.monthlyAmount.platformMaximum.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

sourceGroupID

string
The limit group that supplied this dimension when source names a group, clamped or not; absent for platform, provider, and override sources.

expiresOn

string<date-time>
When an override-sourced value lapses.

used

object required
Amount already sent in the trailing window.
Show child attributes

effectiveLimits.monthlyAmount.used

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.monthlyAmount.used.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

remaining

object required
What can still be sent in the trailing window: ceiling minus used, never negative.
Show child attributes

effectiveLimits.monthlyAmount.remaining

value

string required
Decimal amount as a string.

currency

object required
ISO 4217 currency descriptor.
Show child attributes

effectiveLimits.monthlyAmount.remaining.currency

code

string required
Uppercase 3-letter ISO 4217 currency code.

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.

window

string<enum> required
The trailing window used and remaining count over: 24h for dailyAmount, 7d for weeklyAmount, and 30d for monthlyAmount.
Possible values: 24h, 7d, 30d

dailySendCount

object
A resolved count limit. ceiling is the effective value after the platform maximum clamp; source names its provenance.
Show child attributes

effectiveLimits.dailySendCount

ceiling

integer<int64> required
Effective ceiling, after the platform maximum clamp.

source

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

stored

integer<int64>
Pre-clamp stored value, present only when the platform maximum tightened it.

platformMaximum

integer<int64>
The platform maximum that clamped this dimension, present when clamped.

used

integer<int64> required
Sends already made in the trailing 24h window.

remaining

integer<int64> required
What can still be sent in the trailing 24h window: ceiling minus used, never negative.

window

string<enum> required
The trailing window used and remaining count over: always 24h.
Possible values: 24h, 7d, 30d

sourceGroupID

string
The limit group that supplied this dimension when source names a group, clamped or not; absent for platform, provider, and override sources.

expiresOn

string<date-time>
When an override-sourced value lapses.