Skip to content

SavedPaymentMethod

Type: schema

TypeScript Definition

typescript
SavedPaymentMethod: {{
            upi_collect?: {
                count: number;
                last_used: string;
                vpa: string;
            }[];
            wallet?: {
                linked?: string;
                id: string;
                metadata?: {
                    mobile_number: string;
                    device_id?: string;
                };
                wallet: string;
                gateway_reference_id: string;
                last_refreshed: string;
                sub_details?: {
                    last_used: string;
                    current_balance: string;
                    last_refreshed: string;
                    payment_method: string;
                    payment_method_type: string;
                };
            }[];
            card?: {
                card_sub_type: string;
                extended_card_type: string;
                card_global_fingerprint?: string;
                nickname?: string;
                provider_category: string;
                vault_provider: string;
                card_reference?: string;
                card_type: string;
                metadata?: {
                    origin_merchant_id: string;
                };
                card_issuer?: string;
                card_token: string;
                card_exp_month: string;
                provider?: string;
                card_sub_type_category?: string;
                expired: boolean;
                card_fingerprint?: string;
                tokenize_support: boolean;
                juspay_bank_code?: string;
                card_exp_year: string;
                name_on_card: string;
                country_code: string;
                card_number: string;
                card_isin?: string;
                card_brand?: string;
                card_issuer_country?: string;
            }[];
        };
        /**
         * SearchProduct
         * @description Payload for searching products.
         */
}

OpenAPI Schema

json
{
  "title": "SavedPaymentMethod",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/SavedPaymentMethod",
    "description": "API reference for the SavedPaymentMethod schema"
  },
  "properties": {
    "upi_collect": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "count",
          "last_used",
          "vpa"
        ],
        "properties": {
          "count": {
            "type": "integer"
          },
          "last_used": {
            "type": "string"
          },
          "vpa": {
            "type": "string"
          }
        }
      }
    },
    "wallet": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "wallet",
          "gateway_reference_id",
          "last_refreshed"
        ],
        "properties": {
          "linked": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "metadata": {
            "type": "object",
            "properties": {
              "mobile_number": {
                "type": "string"
              },
              "device_id": {
                "type": "string"
              }
            },
            "required": [
              "mobile_number",
              "device_id "
            ]
          },
          "wallet": {
            "type": "string"
          },
          "gateway_reference_id": {
            "type": "string"
          },
          "last_refreshed": {
            "type": "string"
          },
          "sub_details": {
            "type": "object",
            "properties": {
              "last_used": {
                "type": "string"
              },
              "current_balance": {
                "type": "string"
              },
              "last_refreshed": {
                "type": "string"
              },
              "payment_method": {
                "type": "string"
              },
              "payment_method_type": {
                "type": "string"
              }
            },
            "required": [
              "last_used",
              "current_balance",
              "last_refreshed",
              "payment_method",
              "payment_method_type"
            ]
          }
        }
      }
    },
    "card": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "card_sub_type",
          "extended_card_type",
          "provider_category",
          "vault_provider",
          "card_type",
          "card_token",
          "card_exp_month",
          "expired",
          "tokenize_support",
          "card_exp_year",
          "name_on_card",
          "country_code",
          "card_number"
        ],
        "properties": {
          "card_sub_type": {
            "type": "string"
          },
          "extended_card_type": {
            "type": "string"
          },
          "card_global_fingerprint": {
            "type": "string"
          },
          "nickname": {
            "type": "string"
          },
          "provider_category": {
            "type": "string"
          },
          "vault_provider": {
            "type": "string"
          },
          "card_reference": {
            "type": "string"
          },
          "card_type": {
            "type": "string"
          },
          "metadata": {
            "type": "object",
            "properties": {
              "origin_merchant_id": {
                "type": "string"
              }
            },
            "required": [
              "origin_merchant_id"
            ]
          },
          "card_issuer": {
            "type": "string"
          },
          "card_token": {
            "type": "string"
          },
          "card_exp_month": {
            "type": "string"
          },
          "provider": {
            "type": "string"
          },
          "card_sub_type_category": {
            "type": "string"
          },
          "expired": {
            "type": "boolean"
          },
          "card_fingerprint": {
            "type": "string"
          },
          "tokenize_support": {
            "type": "boolean"
          },
          "juspay_bank_code": {
            "type": "string"
          },
          "card_exp_year": {
            "type": "string"
          },
          "name_on_card": {
            "type": "string"
          },
          "country_code": {
            "type": "string"
          },
          "card_number": {
            "type": "string"
          },
          "card_isin": {
            "type": "string"
          },
          "card_brand": {
            "type": "string"
          },
          "card_issuer_country": {
            "type": "string"
          }
        }
      }
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: