Solvimon paymentSchedules API

openapi: 3.2.0
info:
  title: Configuration alertRules Payment Schedules API
  version: 1.0.0
servers:
- url: https://test.api.solvimon.com
  description: The TEST environment for our API
- url: https://api.solvimon.com
  description: The live environment for our API
tags:
- name: paymentSchedules
paths:
  /v{version}/payment-schedules:
    get:
      operationId: getPaymentSchedules
      summary: Get a list of payment schedules
      description: Requires the PAYMENT_SCHEDULE.VIEW permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: customer_id
        in: query
        description: Filter based of customer ID
        required: false
        schema:
          type: string
      - name: expand[]
        in: query
        description: The id fields of the resources that are going to be expanded.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered.
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The order direction by which the response is ordered.
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentScheduleResponseWrapper'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    post:
      operationId: postPaymentSchedules
      summary: Create a payment schedule
      description: Requires the PAYMENT_SCHEDULE.CREATE permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSchedule'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentScheduleCreateRequest'
  /v{version}/payment-schedules/init:
    post:
      operationId: postPaymentSchedulesInit
      summary: Initialize resources for a payment schedule
      description: Requires the PAYMENT_SCHEDULE.CREATE, PAYMENT_METHOD.CREATE, PAYMENT_METHOD.UPDATE, CUSTOMER.CREATE or CUSTOMER.UPDATE permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentScheduleInit'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentScheduleInitCreateRequest'
  /v{version}/payment-schedules/{resourceIdOrReference}:
    get:
      operationId: getPaymentSchedulesByResourceIdOrReference
      summary: Get a payment schedule by ID or reference
      description: Requires the PAYMENT_SCHEDULE.VIEW permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: expand[]
        in: query
        description: The id fields of the resources that are going to be expanded.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSchedule'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    patch:
      operationId: patchPaymentSchedulesByResourceIdOrReference
      summary: Patch a payment schedule.
      description: Requires the PAYMENT_SCHEDULE.VIEW permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSchedule'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentScheduleUpdateRequest'
  /v{version}/payment-schedules/{resourceIdOrReference}/cancel:
    post:
      operationId: postPaymentSchedulesByResourceIdOrReferenceCancel
      summary: Cancel a payment schedule
      description: Requires the PAYMENT_SCHEDULE.UPDATE permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSchedule'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/payment-schedules/{resourceIdOrReference}/pause:
    post:
      operationId: postPaymentSchedulesByResourceIdOrReferencePause
      summary: Pause a payment schedule
      description: Requires the PAYMENT_SCHEDULE.UPDATE permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSchedule'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/payment-schedules/{resourceIdOrReference}/activate:
    post:
      operationId: postPaymentSchedulesByResourceIdOrReferenceActivate
      summary: Activate a payment schedule
      description: Requires the PAYMENT_SCHEDULE.UPDATE permission.
      tags:
      - paymentSchedules
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSchedule'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    PaymentScheduleOneOff:
      type: object
      properties:
        charge:
          $ref: '#/components/schemas/Charge'
      title: PaymentScheduleOneOff
    ApiError:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ApiErrorType'
        code:
          $ref: '#/components/schemas/ApiErrorCode'
        field:
          type:
          - string
          - 'null'
        message:
          type: string
        resource_id:
          type:
          - string
          - 'null'
        resource_type:
          oneOf:
          - $ref: '#/components/schemas/ApiErrorResourceType'
          - type: 'null'
      required:
      - type
      - code
      - message
      title: ApiError
    CustomerRolesItems:
      type: string
      enum:
      - DEFAULT
      - NON_PROCESSING
      - SELF_BILLING
      - SELLER
      - PROCESSING_ONLY
      title: CustomerRolesItems
    Individual:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Name'
        residential_address:
          $ref: '#/components/schemas/Address'
      title: Individual
    PaymentScheduleRecurring:
      type: object
      properties:
        charge:
          $ref: '#/components/schemas/Charge'
        start_at:
          type: string
          format: date-time
        end_at:
          type:
          - string
          - 'null'
          format: date-time
        period:
          $ref: '#/components/schemas/Period'
      title: PaymentScheduleRecurring
    PaymentScheduleUpdateRequestStatus:
      type: string
      enum:
      - ACTIVE
      - PAUSED
      - CANCELLED
      - DONE
      title: PaymentScheduleUpdateRequestStatus
    PaymentScheduleInitCreateRequest:
      type: object
      properties:
        customer:
          $ref: '#/components/schemas/CustomerCreateRequest'
          description: Details of the customer to create or update before creating the payment schedule.
        payment_method:
          $ref: '#/components/schemas/PaymentMethodCreateRequest'
          description: Details of the payment method to create or update for the customer.
        payment_schedule:
          $ref: '#/components/schemas/PaymentScheduleCreateRequest'
          description: Details of the payment schedule to create.
        payment_requests:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PaymentRequestCreateRequest'
          description: Payment requests that were generated for the payment schedule.
      title: PaymentScheduleInitCreateRequest
    PaymentScheduleInstallments:
      type: object
      properties:
        total_amount:
          $ref: '#/components/schemas/Amount'
        variant:
          $ref: '#/components/schemas/PaymentScheduleInstallmentsVariant'
        number_of_installments:
          type: integer
        interval:
          $ref: '#/components/schemas/IntervalInstallment'
        fixed:
          $ref: '#/components/schemas/FixedInstallment'
      title: PaymentScheduleInstallments
    PaymentScheduleResponseWrapper:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PaymentSchedule'
        page:
          type:
          - integer
          - 'null'
        limit:
          type:
          - integer
          - 'null'
        total_number_of_pages:
          type:
          - integer
          - 'null'
        links:
          $ref: '#/components/schemas/PaginationLinks'
      required:
      - data
      title: PaymentScheduleResponseWrapper
    NotificationPreference:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/NotificationPreferenceType'
          description: The notification type to configure.
        channels:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NotificationChannel'
          description: The channels for this notification type.
      title: NotificationPreference
    CustomerType:
      type: string
      enum:
      - ORGANIZATION
      - INDIVIDUAL
      description: The type of customer entity.
      title: CustomerType
    CustomerCreateRequestType:
      type: string
      enum:
      - ORGANIZATION
      - INDIVIDUAL
      description: The type of customer entity.
      title: CustomerCreateRequestType
    PaymentScheduleInstallmentsVariant:
      type: string
      enum:
      - INTERVAL
      - FIXED
      title: PaymentScheduleInstallmentsVariant
    Charge:
      type: object
      properties:
        charge_at:
          type:
          - string
          - 'null'
          format: date-time
        amount:
          $ref: '#/components/schemas/Amount'
      title: Charge
    PaymentMethodUpdateRequestType:
      type: string
      enum:
      - CARD
      - ONLINE_BANKING
      - BUY_NOW_PAY_LATER
      - DIRECT_DEBIT
      - DIGITAL_WALLET
      - UNKNOWN
      title: PaymentMethodUpdateRequestType
    CustomerSellerDetails:
      type: object
      properties:
        default_billing_entity_id:
          type:
          - string
          - 'null'
          description: Resource ID of type BILLING_ENTITY
      title: CustomerSellerDetails
    Customer:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        created_at:
          type:
          - string
          - 'null'
        parent_customer_id:
          type:
          - string
          - 'null'
          description: The parent of the customer. Only returned when there is a single parent.
        parent_customer_ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: A list of parents of the customer. Will also be returned if there is a single parent.
        reference:
          type: string
          description: A custom reference assigned to the customer.
        status:
          oneOf:
          - $ref: '#/components/schemas/CustomerStatus'
          - type: 'null'
        timezone:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/CustomerType'
          description: The type of customer entity.
        email:
          type: string
          description: The email of the customer.
        notification_preferences:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NotificationPreference'
          description: Notification preferences for customer-related communications.
        locale:
          type:
          - string
          - 'null'
          description: The locale of the customer. Format is language-country (like en-US).
        individual:
          $ref: '#/components/schemas/Individual'
          description: Additional description of the individual customer type.
        organization:
          $ref: '#/components/schemas/Organization'
          description: Additional description of the organization customer type.
        custom_fields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomFieldValue'
        processing_only:
          type:
          - boolean
          - 'null'
        pricing_plan_subscription_selector:
          $ref: '#/components/schemas/PricingPlanSubscriptionSelector'
          description: Settings to influence dynamically the subscription to use for the ingest data.
        linked_integrations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/LinkedIntegration'
        roles:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerRolesItems'
        seller_details:
          $ref: '#/components/schemas/CustomerSellerDetails'
      title: Customer
    CustomerUpdateRequest:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        created_at:
          type:
          - string
          - 'null'
        parent_customer_id:
          type:
          - string
          - 'null'
          description: The parent of the customer. Only returned when there is a single parent.
        parent_customer_ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: A list of parents of the customer. Will also be returned if there is a single parent.
        reference:
          type: string
          description: A custom reference assigned to the customer.
        status:
          oneOf:
          - $ref: '#/components/schemas/CustomerUpdateRequestStatus'
          - type: 'null'
        timezone:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/CustomerUpdateRequestType'
          description: The type of customer entity.
        email:
          type: string
          description: The email of the customer.
        notification_preferences:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NotificationPreference'
          description: Notification preferences for customer-related communications.
        locale:
          type:
          - string
          - 'null'
          description: The locale of the customer. Format is language-country (like en-US).
        individual:
          $ref: '#/components/schemas/Individual'
          description: Additional description of the individual customer type.
        organization:
          $ref: '#/components/schemas/Organization'
          description: Additional description of the organization customer type.
        custom_fields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomFieldValue'
        processing_only:
          type:
          - boolean
          - 'null'
        pricing_plan_subscription_selector:
          $ref: '#/components/schemas/PricingPlanSubscriptionSelector'
          description: Settings to influence dynamically the subscription to use for the ingest data.
        linked_integrations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/LinkedIntegration'
        roles:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomerUpdateRequestRolesItems'
        seller_details:
          $ref: '#/components/schemas/CustomerSellerDetails'
      title: CustomerUpdateRequest
    PaymentRequestCreateRequestStatus:
      type: string
      enum:
      - SCHEDULED
      - IN_PROGRESS
      - ON_HOLD
      - FAILED
      - DONE
      - SKIPPED
      description: The status of the payment request
      title: PaymentRequestCreateRequestStatus
    AddressCountry:
      type: string
      enum:
      - AD
      - AE
      - AF
      - AG
      - AI
      - AL
      - AM
      - AO
      - AQ
      - AR
      - AS
      - AT
      - AU
      - AW
      - AX
      - AZ
      - BA
      - BB
      - BD
      - BE
      - BF
      - BG
      - BH
      - BI
      - BJ
      - BL
      - BM
      - BN
      - BO
      - BQ
      - BR
      - BS
      - BT
      - BV
      - BW
      - BY
      - BZ
      - CA
      - CC
      - CD
      - CF
      - CG
      - CH
      - CI
      - CK
      - CL
      - CM
      - CN
      - CO
      - CR
      - CU
      - CV
      - CW
      - CX
      - CY
      - CZ
      - DE
      - DJ
      - DK
      - DM
      - DO
      - DZ
      - EC
      - EE
      - EG
      - EH
      - ER
      - ES
      - ET
      - FI
      - FJ
      - FK
      - FM
      - FO
      - FR
      - GA
      - GB
      - GD
      - GE
      - GF
      - GG
      - GH
      - GI
      - GL
      - GM
      - GN
      - GP
      - GQ
      - GR
      - GS
      - GT
      - GU
      - GW
      - GY
      - HK
      - HM
      - HN
      - HR
      - HT
      - HU
      - ID
      - IE
      - IL
      - IM
      - IN
      - IO
      - IQ
      - IR
      - IS
      - IT
      - JE
      - JM
      - JO
      - JP
      - KE
      - KG
      - KH
      - KI
      - KM
      - KN
      - KP
      - KR
      - KW
      - KY
      - KZ
      - LA
      - LB
      - LC
      - LI
      - LK
      - LR
      - LS
      - LT
      - LU
      - LV
      - LY
      - MA
      - MC
      - MD
      - ME
      - MF
      - MG
      - MH
      - MK
      - ML
      - MM
      - MN
      - MO
      - MP
      - MQ
      - MR
      - MS
      - MT
      - MU
      - MV
      - MW
      - MX
      - MY
      - MZ
      - NA
      - NC
      - NE
      - NF
      - NG
      - NI
      - NL
      - 'NO'
      - NP
      - NR
      - NU
      - NZ
      - OM
      - PA
      - PE
      - PF
      - PG
      - PH
      - PK
      - PL
      - PM
      - PN
      - PR
      - PS
      - PT
      - PW
      - PY
      - QA
      - RE
      - RO
      - RS
      - RU
      - RW
      - SA
      - SB
      - SC
      - SD
      - SE
      - SG
      - SH
      - SI
      - SJ
      - SK
      - SL
      - SM
      - SN
      - SO
      - SR
      - SS
      - ST
      - SV
      - SX
      - SY
      - SZ
      - TC
      - TD
      - TF
      - TG
      - TH
      - TJ
      - TK
      - TL
      - TM
      - TN
      - TO
      - TR
      - TT
      - TV
      - TW
      - TZ
      - UA
      - UG
      - US
      - UY
      - UZ
      - VA
      - VC
      - VE
      - VG
      - VI
      - VN
      - VU
      - WF
      - WS
      - YE
      - YT
      - ZA
      - ZM
      - ZW
      title: AddressCountry
    PaymentScheduleStatus:
      type: string
      enum:
      - ACTIVE
      - PAUSED
      - CANCELLED
      - DONE
      title: PaymentScheduleStatus
    PricingPlanSubscriptionSelectorData:
      type: object
      properties:
        field:
          $ref: '#/components/schemas/PricingPlanSubscriptionSelectorDataField'
        value:
          type: string
      title: PricingPlanSubscriptionSelectorData
    PaymentMethodFallbackCreateRequest:
      type: object
      properties:
        enabled:
          type: boolean
        payment_method_ids:
          type: array
          items:
            type: string
      title: PaymentMethodFallbackCreateRequest
    CustomerUpdateRequestType:
      type: string
      enum:
      - ORGANIZATION
      - INDIVIDUAL
      description: The type of customer entity.
      title: CustomerUpdateRequestType
    PaymentScheduleDunningCreateRequest:
      type: object
      properties:
        enabled:
          type: boolean
      title: PaymentScheduleDunningCreateRequest
    SellerDetailsCreateRequest:
      type: object
      properties:
        seller_customer_id:
          type:
          - string
          - 'null'
          description: Resource ID of type CUSTOMER
      title: SellerDetailsCreateRequest
    PaymentMethodUpdateRequest:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        created_at:
          type:
          - string
          - 'null'
        updated_at:
          type:
          - string
          - 'null'
        reference:
          type: string
        status:
          oneOf:
          - $ref: '#/components/schemas/PaymentMethodUpdateRequestStatus'
          - type: 'null'
        type:
          oneOf:
          - $ref: '#/components/schemas/PaymentMethodUpdateRequestType'
          - type: 'null'
        card:
          $ref: '#/components/schemas/PaymentMethodCard'
        online_banking:
          $ref: '#/components/schemas/PaymentMethodOnlineBanking'
        buy_now_pay_later:
          $ref: '#/components/schemas/PaymentMethodBuyNowPayLater'
        direct_debit:
          $ref: '#/components/schemas/PaymentMethodDirectDebit'
        digital_wallet:
          $ref: '#/components/schemas/PaymentMethodDigitalWallet'
        customer_id:
          type:
          - string
          - 'null'
          description: Resource ID of type CUSTOMER
        integration_id:
          type:
          - string
          - 'null'
          description: Resource ID of type INTEGRATION
        integration_reference:
          type:
          - string
          - 'null'
        integration_details:
          $ref: '#/components/schemas/IntegrationDetails'
        billing_address:
          $ref: '#/components/schemas/Address'
        is_default:
          type:
          - boolean
          - 'null'
      title: PaymentMethodUpdateRequest
    ApiErrorCode:
      type: string
      enum:
      - RESOURCE_NOT_FOUND
      - RESOURCES_NOT_FOUND
      - UNABLE_TO_PROCESS_INSTRUCTIONS
      - BAD_REQUEST
      - UNSUPPORTED_MEDIA_TYPE
      - RESOURCE_ALREADY_EXISTS
      - CUSTOM_FIELD_VALUE_ALREADY_EXISTS
      - COULD_NOT_CREATE_RESOURCE
      - COULD_NOT_UPDATE_RESOURCE
      - COULD_NOT_DELETE_RESOURCE
      - MISSING_VERSION
      - UNSUPPORTED_V

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-paymentschedules-api-openapi.yml