openapi: 3.2.0
info:
  title: Online Store Customer Payment Methods API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: Customer Payment Methods
paths:
  /customer_payment_methods:
    get:
      summary: Customer Payment Methods
      tags:
      - Customer Payment Methods
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  customer_payment_methods:
                    type: array
                    items:
                      $ref: '#/components/schemas/customer_payment_methods'
      operationId: get-customer_payment_methods
      description: Gets an array of customer payment methods.
    post:
      summary: Create a Customer Payment Method
      operationId: post-customer_payment_methods
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer_payment_methods'
      tags:
      - Customer Payment Methods
      description: Create a customer payment method.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  payment_method_id: 111
                  customer_id: 18
                  payment_type: CreditCard
                  is_default: false
                  card_id: 6
                  address_id: 4
              properties:
                payment_method_id:
                  type: integer
                customer_id:
                  type: integer
                payment_type:
                  type: string
                is_default:
                  type: boolean
                card_id:
                  type: integer
                address_id:
                  type: integer
            examples:
              Example:
                value:
                  payment_method_id: 111
                  customer_id: 18
                  payment_type: CreditCard
                  is_default: false
                  card_id: 6
                  address_id: 4
  /customer_payment_methods/{id}:
    parameters:
    - schema:
        type: integer
      name: id
      in: path
      required: true
      description: The ID of the `customer_payment_method`
    put:
      summary: Update a Customer Payment Method
      operationId: put-customer_payment_methods-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customer_payment_methods'
      description: Updates a customer payment method.
      tags:
      - Customer Payment Methods
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customer_payment_methods'
    delete:
      summary: Delete a Customer Payment Method
      operationId: delete-customer_payment_methods-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
      - Customer Payment Methods
      description: Deletes a customer payment method.
components:
  responses:
    '404':
      description: Resource Not Found
      content:
        application/json:
          schema:
            description: Not Found
            type: object
            x-examples:
              example-1:
                status_code: 404
                message: Not Found
                details: No resource found
            properties:
              status_code:
                type: number
              message:
                type: string
              details:
                type: string
          examples: {}
      headers: {}
  schemas:
    customer_payment_methods:
      type: object
      properties:
        id:
          type: integer
        payment_method_id:
          type: integer
        customer_id:
          type: integer
        payment_type:
          type: string
        is_default:
          type: boolean
        card_id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
        address_id:
          type: integer
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header