diff --git a/mintlify/openapi.yaml b/mintlify/openapi.yaml index 2ef39c30f..fd58a8051 100644 --- a/mintlify/openapi.yaml +++ b/mintlify/openapi.yaml @@ -27326,7 +27326,7 @@ components: 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: '#/components/schemas/CardStatus' @@ -27440,7 +27440,7 @@ components: example: Customer:019542f5-b3e7-1d02-0000-000000000001 platformCardId: type: string - description: Platform-specific card identifier. Always generated by the server; any value supplied in the request is ignored. + description: Platform-specific card identifier. If not provided, one will be generated by the system. example: card-emp-001 threeDSecurePassword: type: string diff --git a/mintlify/snippets/cards/issuing-cards.mdx b/mintlify/snippets/cards/issuing-cards.mdx index 1bda24add..ce82a6a0e 100644 --- a/mintlify/snippets/cards/issuing-cards.mdx +++ b/mintlify/snippets/cards/issuing-cards.mdx @@ -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. | diff --git a/mintlify/snippets/cards/quickstart.mdx b/mintlify/snippets/cards/quickstart.mdx index c2021c736..c8a4c1c94 100644 --- a/mintlify/snippets/cards/quickstart.mdx +++ b/mintlify/snippets/cards/quickstart.mdx @@ -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 diff --git a/openapi.yaml b/openapi.yaml index 2ef39c30f..fd58a8051 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -27326,7 +27326,7 @@ components: 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: '#/components/schemas/CardStatus' @@ -27440,7 +27440,7 @@ components: example: Customer:019542f5-b3e7-1d02-0000-000000000001 platformCardId: type: string - description: Platform-specific card identifier. Always generated by the server; any value supplied in the request is ignored. + description: Platform-specific card identifier. If not provided, one will be generated by the system. example: card-emp-001 threeDSecurePassword: type: string diff --git a/openapi/components/schemas/cards/Card.yaml b/openapi/components/schemas/cards/Card.yaml index aef7c639d..a8a4e442c 100644 --- a/openapi/components/schemas/cards/Card.yaml +++ b/openapi/components/schemas/cards/Card.yaml @@ -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 diff --git a/openapi/components/schemas/cards/CardCreateRequest.yaml b/openapi/components/schemas/cards/CardCreateRequest.yaml index 2c7e2e808..3adc33a7f 100644 --- a/openapi/components/schemas/cards/CardCreateRequest.yaml +++ b/openapi/components/schemas/cards/CardCreateRequest.yaml @@ -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