---
updatedAt: 2025-11-19T15:03:28.000Z
agentTools:
  projectIndex: https://partner.wirexpaychain.com/llms.txt
---

# Get cards

Retrieves list of cards that belong to the user

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Wirex BaaS API",
    "description": "The **Wirex BaaS API** enables partners to deliver non-custodial financial services directly to their retail users. Through a single integration, partners can onboard users, verify identities, issue smart wallet–linked cards, and enable crypto-backed bank transfers—without ever handling fiat or taking custody of user funds.</br>All transactions are powered by **user-owned smart wallets**, ensuring security, transparency, and full user control. Wirex acts as the infrastructure provider, so you can focus on building exceptional user experiences while we handle the heavy lifting.",
    "contact": {
      "name": "API Support Team",
      "email": "company@wirexpaychain.com"
    },
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api-baas.wirexapp.tech",
      "description": "Sandbox environment"
    },
    {
      "url": "https://api-baas.wirexapp.com",
      "description": "Production environment"
    }
  ],
  "tags": [
    {
      "name": "Cards",
      "description": "The **Card API** allows partners to seamlessly issue and manage virtual or plastic cards for retail users via a non-custodial wallet infrastructure. It supports the full card lifecycle, from issuance and activation to spending controls and secure card data access—all designed for scalable partner integration.\n\n### Key Features:\n\n- **Retail Card Issuance**:\n  - Instantly issue virtual or plastic cards for retail users.\n  - Support for user-defined card names and physical delivery with address and courier preferences.\n  - Designed for smooth partner onboarding and activation flows.\n\n- **Lifecycle Management**:\n  - Activate cards securely using last four digits and expiry date confirmation.\n  - Enable, disable, or deactivate cards via API to maintain full control.\n\n- **Spending Limit Configuration**:\n  - Provide user with spending controls to limit the amount that can be withdrawn from the account in one day.\n\n- **Wallet-Based Payments**:\n  - All issued cards are linked to a user's smart wallet for non-custodial, on-chain payment support.\n\n- **Secure Card Data Access**:\n  - Retrieve sensitive card information using secure, permissioned API flows backed by user confirmation and smart contract validation.\n\n---"
    }
  ],
  "paths": {
    "/api/v1/cards": {
      "get": {
        "tags": [
          "Cards"
        ],
        "summary": "Get cards",
        "description": "Retrieves list of cards that belong to the user",
        "parameters": [
          {
            "name": "page_number",
            "in": "query",
            "description": "PageNumber number",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "description": "Size of the page. If no page size is provided, default page size is used (25).",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/response.CardsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/response.ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/response.ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "response.CardAction": {
        "required": [
          "relative_path",
          "type"
        ],
        "type": "object",
        "properties": {
          "relative_path": {
            "type": "string",
            "description": "Relative path of the API that executes this action",
            "example": "/api/v1/cards/:cardId/activate"
          },
          "type": {
            "type": "object",
            "description": "Type of the action that can be performed on this card",
            "example": "Activate",
            "allOf": [
              {
                "$ref": "#/components/schemas/response.CardActionType"
              }
            ]
          }
        }
      },
      "response.CardActionType": {
        "type": "string",
        "enum": [
          "Activate",
          "Block",
          "Unblock",
          "Close",
          "SetLimit",
          "GetDetails",
          "GetCvv",
          "GetPin",
          "SetActiveBalance"
        ],
        "x-enum-varnames": [
          "CardActionTypeActivate",
          "CardActionTypeBlock",
          "CardActionTypeUnblock",
          "CardActionTypeClose",
          "CardActionTypeSetLimit",
          "CardActionTypeGetDetails",
          "CardActionTypeGetCvv",
          "CardActionTypeGetPin",
          "CardActionTypeSetActiveBalance"
        ]
      },
      "response.CardBalance": {
        "required": [
          "balance",
          "is_active",
          "reference_balance",
          "reference_currency",
          "token_address",
          "token_symbol"
        ],
        "type": "object",
        "properties": {
          "balance": {
            "type": "number",
            "description": "Token balance in the decimal representation",
            "example": 100.6
          },
          "is_active": {
            "type": "boolean",
            "description": "Indicates whether the token is active for the card",
            "example": true
          },
          "reference_balance": {
            "type": "number",
            "description": "Reference balance converted to a common currency",
            "example": 100.6
          },
          "reference_currency": {
            "type": "string",
            "description": "Currency used as the reference for the converted balance (e.g., USD)",
            "example": "USD"
          },
          "token_address": {
            "type": "string",
            "description": "Address of the token on the blockchain",
            "example": 6.1138228683162145e+47
          },
          "token_symbol": {
            "type": "string",
            "description": "Symbol of the token (e.g., USDT)",
            "example": "USDT"
          }
        }
      },
      "response.CardData": {
        "required": [
          "card_name",
          "format",
          "name_on_card",
          "payment_system"
        ],
        "type": "object",
        "properties": {
          "card_name": {
            "type": "string",
            "description": "Display name of the card",
            "example": "MC ****1234"
          },
          "card_number_first_4": {
            "type": "string",
            "description": "First 4 digits of the card number. (<span style=\"color:red\">WOULD</span> be present if status **<span style=\"color:red\">IS</span> Requested** or NotActivated**)",
            "example": "1234"
          },
          "card_number_last_4": {
            "type": "string",
            "description": "Last 4 digits of the card number. (<span style=\"color:red\">WOULD</span> be present if status **<span style=\"color:red\">IS NOT</span> Requested or NotActivated**)",
            "example": "5678"
          },
          "expiry_date": {
            "type": "string",
            "description": "Cards expiry date in MM/YYYY format. (<span style=\"color:red\">WOULD</span> be present if status **<span style=\"color:red\">IS NOT</span> Requested or NotActivated**)",
            "example": "01/2006"
          },
          "format": {
            "type": "object",
            "description": "Format of the card which stands for the material it is made of.",
            "example": "Plastic",
            "allOf": [
              {
                "$ref": "#/components/schemas/response.CardFormat"
              }
            ]
          },
          "name_on_card": {
            "type": "string",
            "description": "Name printed on the card",
            "example": "Alex Grey"
          },
          "payment_system": {
            "type": "object",
            "description": "Payment system which issued the card",
            "example": "Visa",
            "allOf": [
              {
                "$ref": "#/components/schemas/response.CardPaymentSystem"
              }
            ]
          }
        }
      },
      "response.CardFormat": {
        "type": "string",
        "enum": [
          "Plastic",
          "Virtual",
          "Metal"
        ],
        "x-enum-varnames": [
          "CardFormatPlastic",
          "CardFormatVirtual",
          "CardFormatMetal"
        ]
      },
      "response.CardGeneration": {
        "type": "string",
        "enum": [
          "Gen1",
          "Gen2"
        ],
        "x-enum-varnames": [
          "CardGenerationGen1",
          "CardGenerationGen2"
        ]
      },
      "response.CardLimit": {
        "required": [
          "currency",
          "daily_limit",
          "daily_usage"
        ],
        "type": "object",
        "properties": {
          "currency": {
            "type": "string",
            "description": "ISO 4217 currency code (e.g., USD) in which the limit is set and usage is calculated",
            "example": "USD"
          },
          "daily_limit": {
            "type": "number",
            "description": "Daily spending limit set for this card",
            "example": 1000
          },
          "daily_usage": {
            "type": "number",
            "description": "An amount of money spent today",
            "example": 200
          }
        }
      },
      "response.CardPaymentSystem": {
        "type": "string",
        "enum": [
          "Visa",
          "MasterCard"
        ],
        "x-enum-varnames": [
          "CardPaymentSystemVisa",
          "CardPaymentSystemMasterCard"
        ]
      },
      "response.CardResponse": {
        "required": [
          "allowed_actions",
          "card_data",
          "card_wallet_address",
          "created_at",
          "generation",
          "id",
          "status"
        ],
        "type": "object",
        "properties": {
          "allowed_actions": {
            "type": "array",
            "description": "Actions that user can do with the card in the current state",
            "items": {
              "$ref": "#/components/schemas/response.CardAction"
            }
          },
          "balances": {
            "type": "array",
            "description": "List of balances of the card contract. (<span style=\"color:red\">WOULD</span> be provided for cards which have **generation** set to **Gen1**",
            "items": {
              "$ref": "#/components/schemas/response.CardBalance"
            }
          },
          "card_data": {
            "type": "object",
            "description": "General information about the card with no sensitive data",
            "allOf": [
              {
                "$ref": "#/components/schemas/response.CardData"
              }
            ]
          },
          "card_wallet_address": {
            "type": "string",
            "description": "Crypto address of the wallet that is linked to the card",
            "example": 9.584885843247168e+47
          },
          "created_at": {
            "type": "string",
            "description": "Date when the card was created"
          },
          "delivery_address": {
            "type": "object",
            "description": "An address where this card was or should be delivered",
            "allOf": [
              {
                "$ref": "#/components/schemas/response.DeliveryAddress"
              }
            ]
          },
          "generation": {
            "type": "object",
            "description": "Generation of the card. For more information please see [Card Generations](#/tag/Cards/Card-Generations-Overview)",
            "example": "Gen1",
            "allOf": [
              {
                "$ref": "#/components/schemas/response.CardGeneration"
              }
            ]
          },
          "id": {
            "type": "string",
            "description": "Unique identifier of the card",
            "example": "00000000-0000-0000-0000-000000000001"
          },
          "limit": {
            "type": "object",
            "description": "Daily limit imposed on the card",
            "allOf": [
              {
                "$ref": "#/components/schemas/response.CardLimit"
              }
            ]
          },
          "previous_status": {
            "type": "object",
            "description": "Status in which the card was before the current status",
            "example": "Blocked",
            "allOf": [
              {
                "$ref": "#/components/schemas/response.CardStatus"
              }
            ]
          },
          "status": {
            "type": "object",
            "description": "Status of the card",
            "example": "Active",
            "allOf": [
              {
                "$ref": "#/components/schemas/response.CardStatus"
              }
            ]
          },
          "status_reason": {
            "type": "string",
            "description": "Short reason why the card is in the current status",
            "example": "User"
          },
          "updated_at": {
            "type": "string",
            "description": "Date when the card was last updated"
          }
        }
      },
      "response.CardStatus": {
        "type": "string",
        "enum": [
          "Requested",
          "NotActivated",
          "Active",
          "Closed",
          "Blocked"
        ],
        "x-enum-varnames": [
          "CardStatusRequested",
          "CardStatusNotActivated",
          "CardStatusActive",
          "CardStatusClosed",
          "CardStatusBlocked"
        ]
      },
      "response.CardsResponse": {
        "required": [
          "data"
        ],
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "description": "List of cards",
            "items": {
              "$ref": "#/components/schemas/response.CardResponse"
            }
          }
        }
      },
      "response.DeliveryAddress": {
        "required": [
          "city",
          "country",
          "line1",
          "zip_code"
        ],
        "type": "object",
        "properties": {
          "city": {
            "type": "string",
            "description": "City of the address",
            "example": "San Francisco"
          },
          "country": {
            "type": "string",
            "description": "Country of the address",
            "example": "US"
          },
          "line1": {
            "type": "string",
            "description": "Line 1 of unstructured address",
            "example": "123 Main St"
          },
          "line2": {
            "type": "string",
            "description": "Line 2 of unstructured address",
            "example": "Suite 200"
          },
          "state": {
            "type": "string",
            "description": "State of the address",
            "example": "CA"
          },
          "zip_code": {
            "type": "string",
            "description": "Postal code of the address",
            "example": "94107"
          }
        }
      },
      "response.ErrorCategory": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string"
          },
          "grpc_status_code": {
            "type": "integer"
          },
          "http_status_code": {
            "type": "integer"
          }
        }
      },
      "response.ErrorDetails": {
        "type": "object",
        "properties": {
          "details": {
            "type": "string"
          },
          "key": {
            "type": "string"
          }
        }
      },
      "response.ErrorReason": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string"
          }
        }
      },
      "response.ErrorResponse": {
        "type": "object",
        "properties": {
          "error_category": {
            "$ref": "#/components/schemas/response.ErrorCategory"
          },
          "error_description": {
            "type": "string"
          },
          "error_details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/response.ErrorDetails"
            }
          },
          "error_reason": {
            "$ref": "#/components/schemas/response.ErrorReason"
          }
        }
      }
    },
    "securitySchemes": {
      "Auth0Token": {
        "type": "apiKey",
        "description": "Token obtained using Auth0 client credentials grant flow. Please see [Authorization](#tag/Authorization/Auth0) section",
        "name": "Authorization",
        "in": "header"
      },
      "WirexPayToken": {
        "type": "apiKey",
        "description": "Wirex issued JWT token that can be obtained by using [Login as user](#tag/User/paths/~1user~1authorize/post) endpoint",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "WirexPayToken": []
    },
    {
      "Auth0Token": []
    }
  ],
  "x-readme": {}
}
```