> ## Documentation Index > Fetch the complete documentation index at: https://docs.reap.global/llms.txt > Use this file to discover all available pages before exploring further. # List effective policies > Returns the policies in force for a card, cardholder, or your program, resolved up the attachment chain (a card inherits its cardholder and program policies). Limits that track a running total over a window include their current usage and remaining headroom, so you can show how much is left. Only active policies are included. ## OpenAPI ````yaml /api-reference/openapi.json get /policies/effective openapi: 3.1.0 info: title: Reap API version: 1.0.0 description: Reap platform API servers: - url: https://sandbox.api.reap.global description: Sandbox - url: https://prod.api.reap.global description: Production security: - bearerAuth: [] tags: - name: Accounts - name: Activities - name: Card Designs - name: Card Shipments - name: Card Transactions - name: Cards - name: Companies - name: Crypto Deposits - name: Policies - name: Simulation - name: Users - name: Virtual Asset Postings - name: Virtual Assets - name: Webhooks paths: /policies/effective: get: tags: - Policies summary: List effective policies description: >- Returns the policies in force for a card, cardholder, or your program, resolved up the attachment chain (a card inherits its cardholder and program policies). Limits that track a running total over a window include their current usage and remaining headroom, so you can show how much is left. Only active policies are included. operationId: listEffective_policies parameters: - name: scopeType in: query required: true schema: type: string enum: - PROJECT - USER - CARD description: The scope level to resolve policies for. example: PROJECT - name: scopeId in: query required: false schema: description: >- The entity to resolve policies for. Required for entity-level scopes; omit for program-level scopes that carry no id. type: string format: uuid - name: Reap-Version in: header required: true schema: type: string enum: - '2025-02-14' description: API version (YYYY-MM-DD) example: '2025-02-14' responses: '200': description: >- The policies in force for the scope, with current usage for each limit that tracks a running total over a window. content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/EffectivePolicy' description: >- Policies in force for the scope, ordered most-specific first (card, then user, then project). required: - items '400': description: The entity the policy attaches to does not exist content: application/json: schema: type: object properties: error: type: object properties: code: type: string const: POLICY_SCOPE_NOT_FOUND message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: PolicyScopeNotFoundError components: schemas: EffectivePolicy: type: object properties: policy: $ref: '#/components/schemas/Policy' usage: anyOf: - $ref: '#/components/schemas/PolicyLimitUsage' title: PolicyLimitUsage - type: 'null' description: >- Current usage for limits that track a running total over a window; `null` for policies that keep no running total. required: - policy - usage description: A policy in force for the scope, with its current usage. Policy: oneOf: - $ref: '#/components/schemas/MerchantRestrictionPolicy' title: MerchantRestriction - $ref: '#/components/schemas/ChannelRestrictionPolicy' title: ChannelRestriction - $ref: '#/components/schemas/TransactionAmountLimitPolicy' title: TransactionAmountLimit - $ref: '#/components/schemas/SpendLimitPolicy' title: SpendLimit - $ref: '#/components/schemas/AuthorizationCountLimitPolicy' title: AuthorizationCountLimit description: Policy resource PolicyLimitUsage: type: object properties: limit: type: number description: >- The configured cap for the window (a USD amount or a transaction count, depending on what the limit measures). used: type: number description: Usage recorded so far in the current window. remaining: type: number description: Headroom left in the current window. resetsAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: 'null' description: >- When the current window resets and usage returns to zero, as a UTC timestamp. Null for a lifetime limit, which never resets. required: - limit - used - remaining - resetsAt description: Current usage of a limit that tracks a running total over a window. MerchantRestrictionPolicy: type: object properties: id: type: string description: >- Policy ID. A UUID for your policies; a stable identifier for platform policies. type: type: string const: MERCHANT_RESTRICTION scope: oneOf: - type: object properties: type: type: string const: PROJECT required: - type title: Project - type: object properties: type: type: string const: USER id: type: string format: uuid required: - type - id title: User - type: object properties: type: type: string const: CARD id: type: string format: uuid required: - type - id title: Card description: Where the policy attaches. status: type: string enum: - ACTIVE - DISABLED example: ACTIVE name: type: string minLength: 1 maxLength: 128 description: Human-readable label. config: type: object properties: match: oneOf: - type: object properties: dimension: type: string const: MCC codes: minItems: 1 type: array items: type: string required: - dimension - codes title: Mcc - type: object properties: dimension: type: string const: MERCHANT_COUNTRY countries: minItems: 1 type: array items: type: string minLength: 2 maxLength: 2 required: - dimension - countries title: MerchantCountry required: - match description: Block transactions whose merchant matches the criteria. createdAt: type: string description: ISO 8601 creation timestamp. updatedAt: type: string description: ISO 8601 last-update timestamp. required: - id - type - scope - status - name - config - createdAt - updatedAt ChannelRestrictionPolicy: type: object properties: id: type: string description: >- Policy ID. A UUID for your policies; a stable identifier for platform policies. type: type: string const: CHANNEL_RESTRICTION scope: oneOf: - type: object properties: type: type: string const: PROJECT required: - type title: Project - type: object properties: type: type: string const: USER id: type: string format: uuid required: - type - id title: User - type: object properties: type: type: string const: CARD id: type: string format: uuid required: - type - id title: Card description: Where the policy attaches. status: type: string enum: - ACTIVE - DISABLED example: ACTIVE name: type: string minLength: 1 maxLength: 128 description: Human-readable label. config: type: object properties: channels: minItems: 1 type: array items: type: string enum: - ATM - POS - ECOMMERCE example: ATM required: - channels description: Block transactions on the listed channels. createdAt: type: string description: ISO 8601 creation timestamp. updatedAt: type: string description: ISO 8601 last-update timestamp. required: - id - type - scope - status - name - config - createdAt - updatedAt TransactionAmountLimitPolicy: type: object properties: id: type: string description: >- Policy ID. A UUID for your policies; a stable identifier for platform policies. type: type: string const: TRANSACTION_AMOUNT_LIMIT scope: oneOf: - type: object properties: type: type: string const: PROJECT required: - type title: Project - type: object properties: type: type: string const: USER id: type: string format: uuid required: - type - id title: User - type: object properties: type: type: string const: CARD id: type: string format: uuid required: - type - id title: Card description: Where the policy attaches. status: type: string enum: - ACTIVE - DISABLED example: ACTIVE name: type: string minLength: 1 maxLength: 128 description: Human-readable label. config: type: object properties: maxAmount: type: number exclusiveMinimum: 0 examples: - 100.5 - 0 - 1234.99 description: Amount in USD. required: - maxAmount description: Cap the amount of a single transaction. createdAt: type: string description: ISO 8601 creation timestamp. updatedAt: type: string description: ISO 8601 last-update timestamp. required: - id - type - scope - status - name - config - createdAt - updatedAt SpendLimitPolicy: type: object properties: id: type: string description: >- Policy ID. A UUID for your policies; a stable identifier for platform policies. type: type: string const: SPEND_LIMIT scope: oneOf: - type: object properties: type: type: string const: PROJECT required: - type title: Project - type: object properties: type: type: string const: USER id: type: string format: uuid required: - type - id title: User - type: object properties: type: type: string const: CARD id: type: string format: uuid required: - type - id title: Card description: Where the policy attaches. status: type: string enum: - ACTIVE - DISABLED example: ACTIVE name: type: string minLength: 1 maxLength: 128 description: Human-readable label. config: type: object properties: window: type: object properties: type: type: string const: CALENDAR period: type: string enum: - DAILY - WEEKLY - MONTHLY - YEARLY - LIFETIME example: DAILY required: - type - period maxAmount: type: number exclusiveMinimum: 0 examples: - 100.5 - 0 - 1234.99 description: Amount in USD. filter: type: object properties: channels: minItems: 1 type: array items: type: string enum: - ATM - POS - ECOMMERCE example: ATM merchant: oneOf: - type: object properties: dimension: type: string const: MCC codes: minItems: 1 type: array items: type: string required: - dimension - codes title: Mcc - type: object properties: dimension: type: string const: MERCHANT_COUNTRY countries: minItems: 1 type: array items: type: string minLength: 2 maxLength: 2 required: - dimension - countries title: MerchantCountry required: - window - maxAmount description: Cap cumulative spend over a calendar window. createdAt: type: string description: ISO 8601 creation timestamp. updatedAt: type: string description: ISO 8601 last-update timestamp. required: - id - type - scope - status - name - config - createdAt - updatedAt AuthorizationCountLimitPolicy: type: object properties: id: type: string description: >- Policy ID. A UUID for your policies; a stable identifier for platform policies. type: type: string const: AUTHORIZATION_COUNT_LIMIT scope: oneOf: - type: object properties: type: type: string const: PROJECT required: - type title: Project - type: object properties: type: type: string const: USER id: type: string format: uuid required: - type - id title: User - type: object properties: type: type: string const: CARD id: type: string format: uuid required: - type - id title: Card description: Where the policy attaches. status: type: string enum: - ACTIVE - DISABLED example: ACTIVE name: type: string minLength: 1 maxLength: 128 description: Human-readable label. config: type: object properties: window: type: object properties: type: type: string const: CALENDAR period: type: string enum: - DAILY - WEEKLY - MONTHLY - YEARLY - LIFETIME example: DAILY required: - type - period maxCount: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 description: Maximum number of transactions in the window. filter: type: object properties: channels: minItems: 1 type: array items: type: string enum: - ATM - POS - ECOMMERCE example: ATM merchant: oneOf: - type: object properties: dimension: type: string const: MCC codes: minItems: 1 type: array items: type: string required: - dimension - codes title: Mcc - type: object properties: dimension: type: string const: MERCHANT_COUNTRY countries: minItems: 1 type: array items: type: string minLength: 2 maxLength: 2 required: - dimension - countries title: MerchantCountry required: - window - maxCount description: Cap the number of transactions over a calendar window. createdAt: type: string description: ISO 8601 creation timestamp. updatedAt: type: string description: ISO 8601 last-update timestamp. required: - id - type - scope - status - name - config - createdAt - updatedAt securitySchemes: bearerAuth: type: http scheme: bearer description: API key as Bearer token ````