--- updatedAt: 2025-12-17T15:17:48.000Z agentTools: projectIndex: https://developers.privacy.com/llms.txt --- # Get card Get card configuration such as spend limit and state. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Privacy Developer API", "description": "The Privacy Developer API is designed to provide a predictable programmatic interface for accessing your Privacy account through an API and transaction webhooks.\nNote that your API key is a secret and should be treated as such. Don't share it with anyone, including us. We will never ask you for it.\n", "version": "1.0.0", "termsOfService": "https://privacy.com/legal#terms", "contact": { "email": "support@privacy.com" } }, "servers": [ { "url": "https://api.privacy.com/v1", "description": "Privacy production API server" }, { "url": "https://sandbox.privacy.com/v1", "description": "Sandbox environment that provides all the functionality of production" } ], "paths": { "/cards/{card_token}": { "get": { "tags": [ "Card" ], "summary": "Get card", "description": "Get card configuration such as spend limit and state.", "parameters": [ { "in": "path", "name": "card_token", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullCard" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } } }, "components": { "responses": { "BadRequest": { "description": "A parameter in the query given in the request does not match the valid queries for the endpoint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "NotFound": { "description": "The specified resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "TooManyRequests": { "description": "Client has exceeded the number of allowed requests in a given time period.\n\n| | |\n|---|---|\n| Rate limited, too many requests per second | User has exceeded their per second rate limit |\n| Rate limited, reached daily limit | User has exceeded their daily rate limit |\n| Rate limited, too many keys tried | One IP has queried too many different API keys |\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Unauthorized": { "description": "| | |\n|---|---|\n| User has not been authenticated | Invalid or missing API key |\n| API key is not active | The API key used is no longer active |\n| Could not find API key | The API key provided is not associated with any user |\n| Please provide API key in Authorization header | The Authorization header is not in the request |\n| Please provide API key in the form Authorization: api-key [api-key] | The Authorization header is not formatted properly |\n| Insufficient privileges. Issuing API key required | Write access requires an Issuing API key. Please contact [api@privacy.com](mailto:api@privacy.com) |\n| Insufficient privileges to create unlocked cards. | Creating unlocked cards requires an additional privilege | Please contact [api@privacy.com](mailto:api@privacy.com) |\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "UnprocessableEntity": { "description": "Unprocessable entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "schemas": { "Card": { "type": "object", "required": [ "created", "funding", "last_four", "spend_limit", "spend_limit_duration", "state", "token", "type" ], "properties": { "created": { "type": "string", "format": "date-time", "description": "An ISO 8601 timestamp for when the card was created. UTC time zone.", "example": "2021-06-28T22:53:15Z" }, "exp_month": { "type": "string", "description": "Two digit (MM) expiry month.", "minLength": 2, "maxLength": 2, "example": "06" }, "exp_year": { "type": "string", "description": "Four digit (yyyy) expiry year.", "minLength": 4, "maxLength": 4, "example": "2027" }, "funding": { "$ref": "#/components/schemas/FundingAccount" }, "hostname": { "type": "string", "description": "Hostname of card's locked merchant (will be empty if not applicable)." }, "last_four": { "type": "string", "description": "Last four digits of the card number.", "minLength": 4, "maxLength": 4 }, "memo": { "type": "string", "description": "Friendly name to identify the card.", "example": "New Card" }, "spend_limit": { "type": "integer", "description": "Amount (in cents) to limit approved authorizations. Transaction requests above the spend limit will be declined.", "example": 1000 }, "spend_limit_duration": { "type": "string", "enum": [ "ANNUALLY", "FOREVER", "MONTHLY", "TRANSACTION" ], "description": "Spend limit duration values:\n* `ANNUALLY` - Card will authorize transactions up to spend limit in a calendar year.\n* `FOREVER` - Card will authorize only up to spend limit for the entire lifetime of the card.\n* `MONTHLY` - Card will authorize transactions up to spend limit for the trailing month. Month is calculated as this calendar date one month prior.\n* `TRANSACTION` - Card will authorizate multiple transactions if each individual transaction is under the spend limit.\n" }, "state": { "type": "string", "enum": [ "CLOSED", "OPEN", "PAUSED" ], "description": "Card state values:\n* `CLOSED` - Card will no longer approve authorizations. Closing a card cannot be undone.\n* `OPEN` - Card will approve authorizations (if they match card and account parameters).\n* `PAUSED` - Card will decline authorizations, but can be resumed at a later time.\n" }, "token": { "type": "string", "format": "uuid", "description": "Globally unique identifier.", "example": "7ef7d65c-9023-4da3-b113-3b8583fd7951" }, "type": { "type": "string", "enum": [ "DIGITAL_WALLET", "MERCHANT_LOCKED", "SINGLE_USE", "UNLOCKED" ], "description": "Card types:\n* `DIGITAL_WALLET` - Cards that can be provisioned to a digital wallet like Google Pay or Apple Wallet.\n* `MERCHANT_LOCKED` - Card is locked to first merchant that successfully authorizes the card.\n* `SINGLE_USE` - Card will close shortly after the first transaction.\n* `UNLOCKED` - Card will authorize at any merchant. Creating these cards requires additional privileges.\n" } } }, "FullCard": { "allOf": [ { "$ref": "#/components/schemas/Card" }, { "type": "object", "properties": { "cvv": { "type": "string", "minLength": 3, "maxLength": 3, "description": "Three digit cvv printed on the back of the card.", "example": "776" }, "pan": { "type": "string", "description": "Primary Account Number (PAN) (i.e. the card number).", "minLength": 16, "maxLength": 16, "example": "4111111289144142" } } } ] }, "Error": { "type": "object", "properties": { "message": { "type": "string", "description": "Explanation of error response." }, "debugging_request_id": { "type": "string", "format": "uuid", "description": "Identifier to help debug an error." } }, "required": [ "message", "debugging_request_id" ] }, "FundingAccount": { "type": "object", "required": [ "created", "last_four", "state", "token", "type" ], "properties": { "account_name": { "type": "string", "description": "Account name identifying the funding source. This may be `null`." }, "created": { "type": "string", "format": "date-time", "description": "An ISO 8601 string representing when this funding source was added to the Privacy account. This may be `null`. UTC time zone." }, "last_four": { "type": "string", "description": "The last 4 digits of the account (e.g. bank account, debit card) associated with this FundingAccount. This may be null.", "minLength": 4, "maxLength": 4 }, "nickname": { "type": "string", "description": "The nickname given to the `FundingAccount` or `null` if it has no nickname.", "minLength": 1, "maxLength": 255 }, "state": { "type": "string", "enum": [ "ENABLED", "PENDING" ], "description": "State of funding source.\n\nFunding source states:\n* `ENABLED` - The funding account is available to use for card creation and transactions.\n* `PENDING` - The funding account is still being verified e.g. bank micro-deposits verification.\n" }, "token": { "type": "string", "format": "uuid", "description": "A globally unique identifier for this FundingAccount." }, "type": { "type": "string", "enum": [ "DEPOSITORY_CHECKING", "DEPOSITORY_SAVINGS" ], "description": "Types of funding source:\n* `DEPOSITORY_CHECKING` - Bank checking account.\n* `DEPOSITORY_SAVINGS` - Bank savings account.\n" } } } }, "securitySchemes": { "BearerAuth": { "type": "apiKey", "in": "header", "description": "Prefix your API key with `api-key`.", "name": "Authorization" } } }, "security": [ { "BearerAuth": [] } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```