> ## Documentation Index > Fetch the complete documentation index at: https://waffo.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Tokenization Inquiry ## OpenAPI ````yaml /api-reference/tokenization-api.json post /api/v1/tokenization/inquiry openapi: 3.1.0 info: title: OpenAPI definition version: v0 servers: - url: http://localhost:8080/cardcenter description: Generated server url security: [] paths: /api/v1/tokenization/inquiry: post: tags: - Waffo Tokenization API summary: Tokenization Inquiry operationId: inquiryToken requestBody: content: application/json: schema: $ref: '#/components/schemas/TokenInquiryRequest' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ResponseListTokenInquiryData' components: schemas: TokenInquiryRequest: type: object properties: merchantInfo: $ref: '#/components/schemas/MerchantInfo' description: Merchant info. tokenRequestId: type: string description: >- Tokenization request ID sent from Merchant. It will also be used for idempotent check. maxLength: 64 minLength: 0 merchantUserId: type: string description: >- The merchant's userId must be unique for each user of merchants. Either merchantUserId or tokenId must be provided to look up bound cards. maxLength: 64 minLength: 0 tokenId: type: string description: >- The tokenization id of card info. The merchant needs to securely store this field, and subsequently, when initiating user payments or backend deductions, this token can be used to replace the user's card information for payment. maxLength: 64 minLength: 0 tokenType: type: string description: >- Types of requested tokenization: CARD. Required unless tokenId is provided. maxLength: 32 minLength: 0 required: - merchantInfo ResponseListTokenInquiryData: type: object description: Standard API response envelope. properties: code: type: string description: >- Result code. "0" indicates success; any other value indicates failure. msg: type: string description: Human-readable message corresponding to the result code. msgParams: type: object additionalProperties: {} description: >- Key-value parameters associated with the error message, used for templated errors. data: type: array description: Response payload. Empty when the request fails. items: $ref: '#/components/schemas/TokenInquiryData' success: type: boolean fail: type: boolean MerchantInfo: type: object properties: merchantId: type: string description: Merchant id assigned by Waffo. maxLength: 32 minLength: 0 subMerchantId: type: string description: Sub merchant id assigned by Waffo. maxLength: 64 minLength: 0 required: - merchantId TokenInquiryData: type: object properties: tokenRequestId: type: string description: >- Tokenization request ID sent from Merchant. It will also be used for idempotent check. If the token status change is invoked by Waffo, this field will not be present. tokenId: type: string description: >- The tokenization id of card info. The merchant needs to securely store this field, and subsequently, when initiating user payments or backend deductions, this token can be used to replace the user's card information for payment. tokenType: type: string description: 'Types of requested tokenization: CARD.' tokenStatus: type: string description: >- Token status: UNVERIFIED (Card information submitted from the frontend, but the card has not been verified); VERIFIED (The card has been verified); EXPIRED (Token has expired); SUSPENDED (Usage has been suspended). merchantUserId: type: string description: The merchant's userId must be unique for each user of merchants. tokenData: $ref: '#/components/schemas/CardTokenData' description: The tokenization object of card info. billingAddress: $ref: '#/components/schemas/BillingAddress' description: The cardholder's billing address. merchantInfo: $ref: '#/components/schemas/MerchantInfo' description: Merchant info. CardTokenData: type: object properties: maskedCardInfo: type: string description: >- The partially masked primary account number (PAN) of the card. This format typically shows the first 6 and the last 4 digits for security while still identifying the card. cardHolderName: type: string description: The full name of the cardholder as it appears on the card. cardExpiry: type: string description: The expiration date of the card, in MM/YYYY format. cardBin: type: string description: >- The Bank Identification Number (BIN) or Issuer Identification Number (IIN). This is the first six digits of the card number, used to identify the institution that issued the card. cardScheme: type: string description: >- The card network that processes the transaction. Such as: VISA, MASTERCARD, JCB, AMEX, DISCOVER, UNIONPAY, DINERS. cardType: type: string description: >- The type of card, specifying if it is a CREDIT_CARD, DEBIT_CARD, or PREPAID_CARD. cardIssuerName: type: string description: >- The official name of the bank or financial institution that issued the card. cardIssueCountryCode: type: string description: >- The three-letter ISO 3166-1 alpha-3 country code of the country where the card was issued (e.g., USA for the United States). BillingAddress: type: object properties: countryCode: type: string description: >- The three-letter ISO 3166-1 alpha-3 code representing the country of the billing address (e.g., USA for the United States). maxLength: 3 minLength: 0 region: type: string description: >- The state, province, or region within the country (e.g., CA for California). maxLength: 40 minLength: 0 city: type: string description: The city or town of the billing address (e.g., Cupertino). maxLength: 50 minLength: 0 postalCode: type: string description: >- The ZIP code or postal code associated with the address (e.g., 95014). maxLength: 20 minLength: 0 address: type: string description: >- The primary street address or delivery line (e.g., One Apple Park Way). maxLength: 300 minLength: 0 ````