> ## Documentation Index > Fetch the complete documentation index at: https://nayax-44d6e37b-docs-marshall-faq-redistribution.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get Cards > Retrieves card details based on various query parameters. ## OpenAPI ````yaml /openapi/lynx.yaml get /v1/cards openapi: 3.0.1 info: title: Nayax Operational Lynx API version: v1 servers: - url: https://qa-lynx.nayax.com/operational security: - Authorization: [] paths: /v1/cards: get: tags: - Cards summary: Get Cards description: Retrieves card details based on various query parameters. operationId: get-cards parameters: - name: CardID in: query description: The unique identifier of the card. schema: type: integer format: int64 - name: CardUniqueIdentifier in: query description: The unique identifier assigned to the card. schema: type: string - name: CardDisplayNumber in: query description: The display number of the card. schema: type: string - name: CardMobileNumber in: query description: The mobile number associated with the card. schema: type: string - name: ExternalApplicationUserID in: query description: The external application user ID associated with the card. schema: type: string - name: CardEmail in: query description: The email address associated with the card. schema: type: string - name: CardHolderName in: query description: The name of the cardholder. schema: type: string responses: '200': description: Card details retrieved successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/CardGetDto' components: schemas: CardGetDto: type: object description: >- Represents the comprehensive details of a card, including its attributes, limits, usage, and associated rewards and location limits. properties: CardDetails: $ref: '#/components/schemas/CardDetailsGet' description: Detailed information about the card. CardHolderDetails: $ref: '#/components/schemas/CardHolderDetailsGet' description: Information about the cardholder. CardCreditAttributes: $ref: '#/components/schemas/CardCreditAttributes' description: Credit attributes associated with the card. CardCreditLimits: $ref: '#/components/schemas/CardCreditLimits' description: Credit limits associated with the card. CardDateRules: $ref: '#/components/schemas/CardDateRules' description: Date-related rules applied to the card. CardCreditUsage: $ref: '#/components/schemas/CardCreditUsageGet' description: Information on the credit usage of the card. CardRevalueRewardRules: type: array nullable: true description: A list of revalue reward rules associated with the card. items: $ref: '#/components/schemas/CardRevalueRewardRuleGet' GroupLocationLimits: type: array nullable: true description: A list of location limits associated with the card's group. items: $ref: '#/components/schemas/CardGroupLocationLimitGet' additionalProperties: false CardDetailsGet: type: object description: Represents the detailed information of a card. properties: CardID: type: integer format: int64 description: The unique identifier of the card. ActorID: type: integer format: int64 description: The unique identifier of the actor associated with the card. CardUniqueIdentifier: type: string nullable: true description: The unique identifier assigned to the card. CardDisplayNumber: type: string nullable: true description: The display number of the card. CardTypeID: type: integer format: int32 nullable: true description: The type identifier of the card. PhysicalTypeID: type: integer format: int32 nullable: true description: The physical type identifier of the card. Notes: type: string nullable: true description: Any additional notes associated with the card. Status: type: integer format: int32 nullable: true description: The current status of the card. ExternalApplicationUserID: type: string nullable: true description: The external application user ID associated with the card. CreatedBy: type: integer format: int64 nullable: true description: The identifier of the user who created the card. CreatedDT: type: string format: date-time nullable: true description: The date and time when the card was created. UpdatedBy: type: integer format: int64 nullable: true description: The identifier of the user who last updated the card. UpdatedDT: type: string format: date-time description: The date and time when the card was last updated. additionalProperties: false CardHolderDetailsGet: type: object description: >- Represents the details of the cardholder, including personal information and contact details. properties: CardHolderName: type: string nullable: true description: The name of the cardholder. UserIdentity: type: string nullable: true description: The unique identity or user ID of the cardholder. CountryID: type: integer format: int32 nullable: true description: The identifier of the country associated with the cardholder. MobileNumber: type: string nullable: true description: The mobile number of the cardholder. Email: type: string nullable: true description: The email address of the cardholder. MemberTypeID: type: integer format: int32 nullable: true description: >- The identifier representing the type of membership the cardholder has. ImageUrl: type: string nullable: true description: The URL of the cardholder's image. additionalProperties: false CardCreditAttributes: type: object description: >- Represents the credit attributes associated with a card, including currency, credit amounts, and revalue options. properties: CurrencyID: type: integer format: int32 nullable: true description: The identifier of the currency used for the card's credit. Credit: type: number format: double nullable: true description: The amount of credit available on the card. RevalueCredit: type: number format: double nullable: true description: The amount of credit added to the card during a revalue operation. CreditTypeMoneyBit: type: boolean nullable: true description: Indicates whether the credit type is money. CreditAccumulateBit: type: boolean nullable: true description: Indicates whether the credit on the card can accumulate over time. CreditSingleUseBit: type: boolean nullable: true description: Indicates whether the credit on the card is for single-use only. RevalueCashBit: type: boolean nullable: true description: Indicates whether the card can be revalued with cash. RevalueCreditCardBit: type: boolean nullable: true description: Indicates whether the card can be revalued with a credit card. AmountMonthlyReload: type: number format: double nullable: true description: The monthly reload amount for the card. TransactionsMonthlyReload: type: integer format: int32 nullable: true description: The number of transactions allowed per month for reloading the card. DiscountTypeBit: type: integer format: int32 nullable: true description: Indicates the type of discount applied to the card. DiscountValue: type: number format: double nullable: true description: The value of the discount applied to the card. additionalProperties: false CardCreditLimits: type: object description: >- Represents the credit limits associated with a card, including daily, weekly, and monthly limits. properties: AmountDailyLimit: type: number format: double nullable: true description: The daily limit on the amount of credit that can be used. AmountWeeklyLimit: type: number format: double nullable: true description: The weekly limit on the amount of credit that can be used. TransactionsDailyLimit: type: integer format: int32 nullable: true description: The daily limit on the number of transactions that can be performed. TransactionsWeeklyLimit: type: integer format: int32 nullable: true description: >- The weekly limit on the number of transactions that can be performed. AmountMonthlyLimit: type: number format: double nullable: true description: The monthly limit on the amount of credit that can be used. TransactionsMonthlyLimit: type: integer format: int32 nullable: true description: >- The monthly limit on the number of transactions that can be performed. DiscountTransactionsTotalLimit: type: integer format: int32 nullable: true description: The total limit on discount transactions. MaxRevalueAmountLimit: type: number format: double nullable: true description: The maximum limit for revalue amounts. WeekDayLimitEnabledBit: type: boolean description: Indicates whether weekday limits are enabled. WeekDayAmountLimit: type: string nullable: true description: The amount limit applied on specific weekdays. WeekDayTransactionLimit: type: string nullable: true description: The transaction limit applied on specific weekdays. additionalProperties: false CardDateRules: type: object description: >- Represents the date rules associated with a card, including activation, expiration, and single-use dates. properties: ActivationDate: type: string format: date-time nullable: true description: The date and time when the card becomes active. ExpirationDate: type: string format: date-time nullable: true description: The date and time when the card expires. RevalueExpirationDate: type: string format: date-time nullable: true description: The date and time when the revalue credit on the card expires. SetSingleUseDate: type: string format: date-time nullable: true description: The date and time when the card is set for single-use. RemoveSingleUseDate: type: string format: date-time nullable: true description: >- The date and time when the single-use restriction is removed from the card. additionalProperties: false CardCreditUsageGet: type: object description: >- Represents the usage details of a card, including daily, weekly, monthly, and total usage amounts and transactions. properties: AmountDailyUsage: type: number format: double nullable: true description: The amount of credit used daily. AmountWeeklyUsage: type: number format: double nullable: true description: The amount of credit used weekly. TransactionsDailyUsage: type: number format: double nullable: true description: The number of transactions performed daily. TransactionsWeeklyUsage: type: number format: double nullable: true description: The number of transactions performed weekly. AmountMonthlyUsage: type: number format: double nullable: true description: The amount of credit used monthly. TransactionsMonthlyUsage: type: number format: double nullable: true description: The number of transactions performed monthly. AmountTotalUsage: type: number format: double nullable: true description: The total amount of credit used. TransactionsTotalUsage: type: number format: double nullable: true description: The total number of transactions performed. AmountCapture: type: number format: double nullable: true description: The amount of credit captured. TransactionsCapture: type: integer format: int32 nullable: true description: The number of transactions captured. CaptureDate: type: string format: date-time nullable: true description: The date and time of the last capture. additionalProperties: false CardRevalueRewardRuleGet: type: object description: >- Represents the revalue reward rule associated with a card, including reward details and status. properties: RuleID: type: integer format: int32 description: The unique identifier of the reward rule. RewardActorID: type: integer format: int64 description: The identifier of the actor receiving the reward. Status: type: boolean description: The current status of the reward rule. RevalueAmount: type: number format: double description: The amount required to trigger the reward. RewardValueTypeBit: type: boolean description: >- Indicates whether the reward value is a fixed amount or a percentage. RewardValue: type: number format: double description: The value of the reward. UpdatedDT: type: string format: date-time description: The date and time when the reward rule was last updated. UpdatedBy: type: integer format: int32 description: The identifier of the user who last updated the reward rule. additionalProperties: false CardGroupLocationLimitGet: type: object description: >- Represents the location limits associated with a card group, including daily limits and update information. properties: CardGroupEnabledBit: type: boolean description: Indicates whether the card group location limit is enabled. GroupName: type: string nullable: true description: The name of the card group. CardGroupId: type: integer format: int64 description: The unique identifier of the card group. GroupDailyLimit: type: integer format: int32 nullable: true description: The daily limit for the card group. UpdatedBy: type: integer format: int64 nullable: true description: The identifier of the user who last updated the location limit. LastUpdated: type: string format: date-time nullable: true description: The date and time when the location limit was last updated. additionalProperties: false securitySchemes: Authorization: type: http scheme: bearer description: Enter your Bearer token. It's required to authenticate API requests. ````