add-card

Method: POST
Path: /payments/cards

Tags: Payments

Summary

Add card

Description

Add a new card

TypeScript Definition

"add-card": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    card_details: components["schemas"]["PayuCardPayload"] | components["schemas"]["JuspayCardPayload"];
                };
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message: string;
                        success: boolean;
                        content: {
                            /** @enum {string} */
                            readonly payment_gateway: "juspay" | "payu";
                            "card-details": components["schemas"]["PayuCreateCardResponse"] | components["schemas"]["JuspayCreateCardResponse"];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["PayuCardPayload"]	PayuCardPayload
components["schemas"]["JuspayCardPayload"]	JuspayCardPayload
components["schemas"]["PayuCreateCardResponse"]	PayuCreateCardResponse
components["schemas"]["JuspayCreateCardResponse"]	JuspayCreateCardResponse
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Request Body

Content Types: application/json

Responses

200

OK

400

Bad request

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Payments"
  ],
  "operationId": "add-card",
  "summary": "Add card",
  "description": "Add a new card",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/add-card",
    "description": "API reference for the add-card operation"
  },
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "card_details"
          ],
          "properties": {
            "card_details": {
              "discriminator": {
                "propertyName": "payment_gateway",
                "mapping": {
                  "juspay": "#/components/schemas/JuspayCardPayload",
                  "payu": "#/components/schemas/PayuCardPayload"
                }
              },
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PayuCardPayload"
                },
                {
                  "$ref": "#/components/schemas/JuspayCardPayload"
                }
              ]
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "discriminator": {
                  "propertyName": "payment_gateway",
                  "mapping": {
                    "juspay": "#/components/schemas/JuspayCreateCardResponse",
                    "payu": "#/components/schemas/PayuCreateCardResponse"
                  }
                },
                "properties": {
                  "payment_gateway": {
                    "type": "string",
                    "enum": [
                      "juspay",
                      "payu"
                    ],
                    "readOnly": true
                  },
                  "card-details": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/PayuCreateCardResponse"
                      },
                      {
                        "$ref": "#/components/schemas/JuspayCreateCardResponse"
                      }
                    ]
                  }
                },
                "required": [
                  "payment_gateway",
                  "card-details"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "payments",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "addCard"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions