Skip to content

docs: document platform-level card spending cap #890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
claude wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document platform-level card spending cap #890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions mintlify/snippets/cards/freezing-and-closing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,10 @@ curl -X PATCH "$GRID_BASE_URL/cards/Card:019542f5-b3e7-1d02-0000-000000000010" \

Supply a positive integer to set the limit (in the smallest unit of the
card's currency) or `null` to clear it. Omitting the field leaves the
current limit unchanged. `maxSpendPerTransaction` cannot be supplied
alongside `state: CLOSED`.
current limit unchanged. If the platform config sets
`cardConfigs.maxSpendPerTransaction`, Grid enforces the lower of the card
and platform values without replacing the card-specific value.
`maxSpendPerTransaction` cannot be supplied alongside `state: CLOSED`.

## Sandbox behavior

Expand Down
2 changes: 1 addition & 1 deletion mintlify/snippets/cards/issuing-cards.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ curl -X POST "$GRID_BASE_URL/cards" \
| `platformCardId` | No | Your own identifier. System-generated when omitted, mirroring `platformCustomerId`. |
| `form` | Yes | `VIRTUAL` in v1. `PHYSICAL` will be added later. |
| `fundingSources` | Yes | Ordered array of `InternalAccount` ids. Each must belong to the cardholder and share one card-eligible currency. The first entry is tried first by Authorization Decisioning. |
| `maxSpendPerTransaction` | No | Largest amount a single card transaction may authorize, in the smallest unit of the card's currency. Omit for no limit. Supported only for card programs where Grid makes the authorization decision. |
| `maxSpendPerTransaction` | No | Largest amount a single card transaction may authorize, in the smallest unit of the card's currency. Omit for no card-specific cap. If the platform config sets `cardConfigs.maxSpendPerTransaction`, Grid enforces the lower of the card and platform values. Supported only for card programs where Grid makes the authorization decision. |

The card's `currency` is derived from the funding sources at issue time
and surfaces on the returned `Card` resource — all bound sources share
Expand Down
17 changes: 17 additions & 0 deletions mintlify/snippets/platform-configuration-non-uma.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,23 @@ The `webhookEndpoint` parameter specifies the URL where Grid will send webhook n
- Handle webhook verification (see Webhook Verification Guide)
- Process webhook payloads within a reasonable time (recommended: under 5 seconds)

### Card Configuration

The `cardConfigs` object contains platform-level settings for cards issued by your platform. To set a platform-wide per-transaction spending cap:

```bash cURL
curl -X PATCH 'https://api.lightspark.com/grid/2025-10-13/config' \
-u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \
-H 'Content-Type: application/json' \
-d '{
"cardConfigs": {
"maxSpendPerTransaction": 10000
}
}'
```

- `maxSpendPerTransaction`: (Integer or null) Platform-level cap on a single transaction for every card whose authorization decisions are made by Grid. The value is in the smallest unit of each card's currency (for example, cents for USD). Grid enforces the lower of this cap and each card's configured `maxSpendPerTransaction`. Set to `null` to remove the platform cap.
Comment on lines +94 to +109

@greptile-apps greptile-apps Bot Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Configuration section remains unreachable

When readers open the rendered platform configuration documentation, this section is absent because neither changed platform-configuration snippet is imported by a documentation page, leaving the newly documented card spending cap undiscoverable there. The UMA snippet has the same issue.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: mintlify/snippets/platform-configuration-non-uma.mdx
Line: 94-109

Comment:
**Configuration section remains unreachable**

When readers open the rendered platform configuration documentation, this section is absent because neither changed platform-configuration snippet is imported by a documentation page, leaving the newly documented card spending cap undiscoverable there. The UMA snippet has the same issue.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!


### Supported Currencies

The `supportedCurrencies` array allows you to define settings for each currency your platform will support for payouts payments. Each object in this array can contain:
Expand Down
17 changes: 17 additions & 0 deletions mintlify/snippets/platform-configuration-uma.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,23 @@ The `webhookEndpoint` parameter specifies the URL where Grid will send webhook n
- Handle webhook verification (see Webhook Verification Guide)
- Process webhook payloads within a reasonable time (recommended: under 5 seconds)

### Card Configuration

The `cardConfigs` object contains platform-level settings for cards issued by your platform. To set a platform-wide per-transaction spending cap:

```bash cURL
curl -X PATCH 'https://api.lightspark.com/grid/2025-10-13/config' \
-u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \
-H 'Content-Type: application/json' \
-d '{
"cardConfigs": {
"maxSpendPerTransaction": 10000
}
}'
```

- `maxSpendPerTransaction`: (Integer or null) Platform-level cap on a single transaction for every card whose authorization decisions are made by Grid. The value is in the smallest unit of each card's currency (for example, cents for USD). Grid enforces the lower of this cap and each card's configured `maxSpendPerTransaction`. Set to `null` to remove the platform cap.

### Supported Currencies for UMA

The `supportedCurrencies` array allows you to define settings for each currency your platform will support for UMA payments. Each object in this array can contain:
Expand Down
Loading