Skip to content

Describe platformCardId as caller-suppliable with a system-generated fallback #1023

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
AaryamanBhute wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Describe platformCardId as caller-suppliable with a system-generated fallback #1023

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
4 changes: 2 additions & 2 deletions mintlify/openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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 @@ -21,7 +21,7 @@ curl -X POST "$GRID_BASE_URL/cards" \
| Field | Required | Notes |
|-------|----------|-------|
| `customerId` | Yes | The `Customer` that owns the card. Must be `kycStatus: APPROVED`. |
| `platformCardId` | No | Ignored if supplied. The value on the returned `Card` is generated by the server. |
| `platformCardId` | No | Platform-specific card identifier. Grid does not yet honor a value you supply here — issuance always assigns its own. Read the identifier back from the returned `Card` and store that. |
| `form` | Yes | `VIRTUAL` in v1. `PHYSICAL` will be added later. |
| `fundingSource` | Yes | The `InternalAccount` that funds the card. Must belong to the customer and be denominated in a card-eligible currency. |
| `maxSpendPerTransaction` | No | The largest amount the card can authorize on a single transaction, in the smallest unit of the card's currency (cents for USD). An authorization for exactly the limit is allowed; a later clearing can still settle above it (e.g. a restaurant tip). Omit for no limit. Available only on card programs where Grid makes the authorization decision. |
Expand Down
5 changes: 3 additions & 2 deletions mintlify/snippets/cards/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,9 @@ curl -X POST "$GRID_BASE_URL/cards" \
```

The card comes back in `status: "PROCESSING"` while the issuer
provisions it. `platformCardId` is generated by the server, and any value
supplied in the request is ignored. When activation completes, a
provisions it. Grid assigns `platformCardId` itself today, so read the
identifier back from the returned `Card` rather than relying on a value you
supplied. When activation completes, a
`CARD.STATUS_CHANGE` webhook fires with `status: "ACTIVE"`:

```json
Expand Down
4 changes: 2 additions & 2 deletions openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions openapi/components/schemas/cards/Card.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ properties:
example: Customer:019542f5-b3e7-1d02-0000-000000000001
platformCardId:
type: string
description: >-
Platform-specific card identifier generated by the server.
description: Platform-specific card identifier
example: card-emp-001
status:
$ref: ./CardStatus.yaml
Expand Down
4 changes: 2 additions & 2 deletions openapi/components/schemas/cards/CardCreateRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ properties:
platformCardId:
type: string
description: >-
Platform-specific card identifier. Always generated by the server; any
value supplied in the request is ignored.
Platform-specific card identifier. If not provided, one will be
generated by the system.
example: card-emp-001
threeDSecurePassword:
type: string
Expand Down
Loading