Solvimon paymentAcceptors API

openapi: 3.2.0
info:
  title: Configuration alertRules Payment Acceptors 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: paymentAcceptors
paths:
  /v{version}/payment-acceptors:
    get:
      operationId: getPaymentAcceptors
      summary: Get a list of payment acceptors for provided filters
      description: Requires the PAYMENT_ACCEPTOR.VIEW permission.
      tags:
      - paymentAcceptors
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: billing_entity_id
        in: query
        description: The resource id of the billingEntity.
        required: false
        schema:
          type: string
      - name: customer_id
        in: query
        description: The resource id of the customer.
        required: false
        schema:
          type: string
      - name: statuses[]
        in: query
        description: Filter paymentAcceptor based on status(es)
        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/PaymentAcceptorResponseWrapper'
        '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'
    post:
      operationId: postPaymentAcceptors
      summary: Create a payment acceptor
      description: Requires the PAYMENT_ACCEPTOR.CREATE permission.
      tags:
      - paymentAcceptors
      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:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAcceptor'
        '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'
        '409':
          description: Conflict
          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/PaymentAcceptorCreateRequest'
  /v{version}/payment-acceptors/payment-method-options:
    post:
      operationId: postPaymentAcceptorsPaymentMethodOptions
      summary: Retrieve payment method options for payment acceptors
      description: Requires the PAYMENT_ACCEPTOR.VIEW permission.
      tags:
      - paymentAcceptors
      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:
                type: array
                items:
                  $ref: '#/components/schemas/PaymentAcceptorPaymentMethodOptions'
        '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'
        '404':
          description: Not Found
          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/PaymentAcceptorPaymentMethodOptionsRequestCreateRequest'
  /v{version}/payment-acceptors/{resourceId}:
    get:
      operationId: getPaymentAcceptorsByResourceId
      summary: Get a payment acceptor by resource ID
      description: Requires the PAYMENT_ACCEPTOR.VIEW permission.
      tags:
      - paymentAcceptors
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        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/PaymentAcceptor'
        '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'
    delete:
      operationId: deletePaymentAcceptorsByResourceId
      summary: Delete a payment acceptor
      description: Requires the PAYMENT_ACCEPTOR.DELETE permission.
      tags:
      - paymentAcceptors
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        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/PaymentAcceptor'
        '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: patchPaymentAcceptorsByResourceId
      summary: Update the payment acceptor
      description: Requires the PAYMENT_ACCEPTOR.UPDATE permission.
      tags:
      - paymentAcceptors
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        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/PaymentAcceptor'
        '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/PaymentAcceptorUpdateRequest'
components:
  schemas:
    PaymentGatewayPaymentAcceptorCreateRequest:
      type: object
      properties:
        integration_id:
          type: string
          description: Resource ID of type INTEGRATION
        integration:
          oneOf:
          - $ref: '#/components/schemas/Integration'
          - type: 'null'
        store_payment_method:
          type:
          - boolean
          - 'null'
        auto_charge_payment_method:
          type:
          - boolean
          - 'null'
        collection_type:
          $ref: '#/components/schemas/PaymentGatewayPaymentAcceptorCreateRequestCollectionType'
        link:
          $ref: '#/components/schemas/PaymentGatewayPaymentAcceptorLink'
        adyen:
          $ref: '#/components/schemas/PaymentGatewayPaymentAcceptorAdyen'
      title: PaymentGatewayPaymentAcceptorCreateRequest
    EInvoicingIntegrationProcessor:
      type: string
      enum:
      - AVALARA
      title: EInvoicingIntegrationProcessor
    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
    PaymentGatewayPaymentAcceptor:
      type: object
      properties:
        integration_id:
          type: string
          description: Resource ID of type INTEGRATION
        integration:
          oneOf:
          - $ref: '#/components/schemas/Integration'
          - type: 'null'
        store_payment_method:
          type:
          - boolean
          - 'null'
        auto_charge_payment_method:
          type:
          - boolean
          - 'null'
        collection_type:
          $ref: '#/components/schemas/PaymentGatewayPaymentAcceptorCollectionType'
        link:
          $ref: '#/components/schemas/PaymentGatewayPaymentAcceptorLink'
        adyen:
          $ref: '#/components/schemas/PaymentGatewayPaymentAcceptorAdyen'
      title: PaymentGatewayPaymentAcceptor
    AdyenPaymentGatewayIntegrationEnvironment:
      type: string
      enum:
      - LIVE
      - TEST
      title: AdyenPaymentGatewayIntegrationEnvironment
    IntegrationType:
      type: string
      enum:
      - PAYMENT_GATEWAY
      - E_INVOICING
      - TAX_CALCULATION
      - DATA_EXPORT
      - EMAIL_PROVIDER
      description: The type of integration.
      title: IntegrationType
    BankAccountType:
      type: string
      enum:
      - IBAN
      - BIC_AND_ACCOUNT_NUMBER
      - ACCOUNT_NUMBER_AND_BIC
      - US_BANK_ACCOUNT
      - US_LOCAL
      - UK_LOCAL
      - BR_LOCAL
      - AR_LOCAL
      - MX_LOCAL
      description: Determines what fields should be present in the bank account node.
      title: BankAccountType
    AdyenPaymentGatewayIntegrationOwnership:
      type: string
      enum:
      - PLATFORM
      - SYSTEM
      title: AdyenPaymentGatewayIntegrationOwnership
    BalancePlatformDetails:
      type: object
      properties:
        account:
          type: string
        authentication:
          $ref: '#/components/schemas/AuthenticationSettings'
      title: BalancePlatformDetails
    UsernamePassword:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
      title: UsernamePassword
    EInvoicingIntegration:
      type: object
      properties:
        mandates:
          type: array
          items:
            $ref: '#/components/schemas/EInvoicingMandate'
          description: The mandates that are used for eInvoicing
        processor:
          $ref: '#/components/schemas/EInvoicingIntegrationProcessor'
      title: EInvoicingIntegration
    PaymentGatewayPaymentAcceptorLink:
      type: object
      properties:
        expiry_period:
          $ref: '#/components/schemas/Period'
      title: PaymentGatewayPaymentAcceptorLink
    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
    TaxCalculationIntegrationVariant:
      type: string
      enum:
      - AVATAX
      description: The variant that provides the tax calculation
      title: TaxCalculationIntegrationVariant
    AuthenticationSettingsApiKey:
      type: object
      properties:
        header:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
      title: AuthenticationSettingsApiKey
    ClientCredentials:
      type: object
      properties:
        client_id:
          type: string
        client_secret:
          type: string
      title: ClientCredentials
    AvaTaxCalculationIntegration:
      type: object
      properties:
        company_code:
          type: string
          description: Links a billing entity to a company in AvaTax
      title: AvaTaxCalculationIntegration
    PaymentAcceptorStatus:
      type: string
      enum:
      - DRAFT
      - ACTIVE
      - ARCHIVED
      - DEPRECATED
      title: PaymentAcceptorStatus
    TaxCalculationIntegration:
      type: object
      properties:
        billing_entity_id:
          type: string
          description: The id of the billing entity for which this integration is used
        variant:
          $ref: '#/components/schemas/TaxCalculationIntegrationVariant'
          description: The variant that provides the tax calculation
        ava_tax:
          $ref: '#/components/schemas/AvaTaxCalculationIntegration'
          description: Details for an AvaTax integration
        custom_tax_codes:
          type: array
          items:
            $ref: '#/components/schemas/CustomTaxCode'
          description: 'Optional: custom codes that are used to link specific taxes to the tax calculation (e.g. commitments, missing product codes, etc.)'
        enable_tax_filing:
          type: boolean
          description: Determines whether invoices will be sent to the tax integration, or just calculations
      title: TaxCalculationIntegration
    PaymentAcceptorCreateRequestType:
      type: string
      enum:
      - BANK_ACCOUNT
      - PAYMENT_GATEWAY
      - CUSTOM_REDIRECT
      title: PaymentAcceptorCreateRequestType
    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_VERSION
      - UNAUTHORISED
      - CUSTOMER_NOT_FOUND
      - PLATFORM_NOT_FOUND
      - PRICING_PLAN_NOT_FOUND
      - PRODUCT_NOT_FOUND
      - PRODUCT_ITEM_NOT_FOUND
      - PRICING_NOT_FOUND
      - PRICING_ITEM_NOT_FOUND
      - USER_NOT_FOUND
      - METER_NOT_FOUND
      - METER_VALUE_NOT_FOUND
      - METER_PROPERTY_NOT_FOUND
      - PRICING_ITEM_SUMMARIES_NOT_FOUND
      - MISSING_ID
      - INVALID_ID
      - MISSING_REFERENCE
      - MISSING_FIELD
      - INVALID_FIELD
      - INVALID_OPERATION
      - INTERNAL_ERROR
      - USER_NOT_ALLOWED
      - IDEMPOTENCY_CHECK_FAILED
      - INVALID_REQUEST
      title: ApiErrorCode
    AdyenPaymentGatewayIntegration:
      type: object
      properties:
        company_account:
          type: string
        environment:
          $ref: '#/components/schemas/AdyenPaymentGatewayIntegrationEnvironment'
        live_prefix:
          type: string
        merchant_accounts:
          type: array
          items:
            type: string
        public_key:
          type: string
        signing_secret:
          type: string
        ownership:
          $ref: '#/components/schemas/AdyenPaymentGatewayIntegrationOwnership'
        system_ownership_details:
          $ref: '#/components/schemas/SystemOwnershipDetails'
        balance_platform_details:
          $ref: '#/components/schemas/BalancePlatformDetails'
        legal_entity_manager_details:
          $ref: '#/components/schemas/LegalEntityManagerDetails'
        enabled_payment_methods:
          type:
          - array
          - 'null'
          items:
            type: string
      title: AdyenPaymentGatewayIntegration
    PeriodType:
      type: string
      enum:
      - DAY
      - WEEK
      - MONTH
      - YEAR
      title: PeriodType
    UKLocal:
      type: object
      properties:
        account_number:
          type:
          - string
          - 'null'
          description: A bank account number if IBAN is not used, e.g a USA or UK bank account number
        sort_code:
          type:
          - string
          - 'null'
      title: UKLocal
    USLocal:
      type: object
      properties:
        account_number:
          type:
          - string
          - 'null'
          description: A bank account number if IBAN is not used, e.g a USA or UK bank account number
        account_type:
          oneOf:
          - $ref: '#/components/schemas/UsLocalAccountType'
          - type: 'null'
          description: The bank account type.
        bank_code:
          type:
          - string
          - 'null'
          description: A bank code that's used to identify the bank that this account belongs to
        routing_number:
          type:
          - string
          - 'null'
          description: The 9-digit code that identifies a specific financial institution for transactions in the USA.
      title: USLocal
    StripePaymentGatewayIntegration:
      type: object
      properties:
        public_key:
          type: string
        signing_secret:
          type:
          - string
          - 'null'
      title: StripePaymentGatewayIntegration
    SystemOwnershipDetails:
      type: object
      properties:
        account_holder_id:
          type: string
        balance_account_id:
          type: string
        legal_entity_id:
          type: string
        store_id:
          type: string
      title: SystemOwnershipDetails
    MailgunEmailProviderRegion:
      type: string
      enum:
      - US
      - EU
      description: Mailgun region for the configured domain.
      title: MailgunEmailProviderRegion
    EmailProviderIntegration:
      type: object
      properties:
        variant:
          $ref: '#/components/schemas/EmailProviderIntegrationVariant'
          description: The variant of email provider integration.
        mailgun:
          $ref: '#/components/schemas/MailgunEmailProvider'
          description: Mailgun-specific provider settings. Applicable when variant is MAILGUN.
        delivery_window:
          $ref: '#/components/schemas/Period'
          description: Optional delivery window configuration that limits when outbound emails may be sent.
        use_localized_templates:
          type:
          - boolean
          - 'null'
          description: Whether localized email templates should be selected based on customer or request locale when available.
      title: EmailProviderIntegration
    ApiErrorResourceType:
      type: string
      enum:
      - CUSTOMER
      - CUSTOM_FIELD
      - PLATFORM
      - PLATFORM_UPTODATE
      - METER
      - METER_VALUE
      - METER_PROPERTY
      - METER_VALUE_CALCULATION
      - INGEST_DATA
      - METER_DATA
      - CHARGE_DATA
      - PERSIST_DATA
      - ADJUSTMENT_DATA
      - PRODUCT_CATEGORY
      - PRODUCT
      - PRODUCT_ITEM
      - PRICING
      - PRICING_GROUP
      - PRICING_ITEM
      - PRICING_ITEM_CONFIG
      - PRICING_PLAN_SUBSCRIPTION
      - PRICING_PLAN_SUBSCRIPTION_GROUP
      - PRICING_PLAN_SCHEDULE
      - PRICING_PLAN
      - PRICING_PLAN_VERSION
      - QUOTE
      - QUOTE_VERSION
      - QUOTE_TEMPLATE
      - API_KEY
      - USER
      - ROLE
      - PROXY_USER
      - EXTERNAL_CREDENTIALS
      - TOKEN
      - INVOICE
      - E_INVOICE
      - PDF
      - BILLING_ENTITY
      - FEATURE
      - MEMBERSHIP
      - PAYMENT
      - PAYMENT_ACCEPTOR
      - PAYMENT_METHOD
      - PAYMENT_METHOD_OPTIONS
      - PAYMENT_SCHEDULE
      - PAYMENT_REQUEST
      - INTEGRATION
      - WEBHOOK
      - FILE
      - FILE_PROCESSING_SETTINGS
      - TEAM
      - DOWNLOAD_URL
      - CSV_REPORT
      - REPORT
      - REPORT_GENERATE_REQUEST
      - REPORT_CONFIGURATION
      - REPORT_SUBSCRIPTION
      - REPORT_DEFINITION
      - ACCOUNT_GROUP
      - ENTITY
      - EVENT_TRACE
      - EVENT_TRACE_LINK
      - PRICING_CATEGORY
      - CONTACT
      - ALERT_RULE
      - ALERT
      - AUDIT_RECORD
      - PORTAL_URL
      - AUTHENTICATION_PROVIDER
      - REPROCESS
      - APPROVAL_POLICY
      - APPROVAL_REQUEST
      - BULK_ACTION
      - COUPON
      - PROMOTION_CODE
      - WALLET
      - WALLET_TYPE
      - WALLET_GRANT
      - WORKFLOW
      - WORKFLOW_TRIGGER
      - WORKFLOW_ACTION
      - CREDIT_TYPE
      - SIGNATURE_REQUEST
      - ATTACHMENT
      - DOCUMENT
      title: ApiErrorResourceType
    EmailProviderIntegrationVariant:
      type: string
      enum:
      - SYSTEM
      - MAILGUN
      description: The variant of email provider integration.
      title: EmailProviderIntegrationVariant
    PaymentAcceptorUpdateRequestType:
      type: string
      enum:
      - BANK_ACCOUNT
      - PAYMENT_GATEWAY
      - CUSTOM_REDIRECT
      title: PaymentAcceptorUpdateRequestType
    ApiErrorType:
      type: string
      enum:
      - API_ERROR
      - INVALID_REQUEST
      title: ApiErrorType
    CustomTaxCode:
      type: object
      properties:
        field:
          $ref: '#/components/schemas/CustomTaxCodeField'
          description: The field to use a custom code for
        value:
          type: string
      title: CustomTaxCode
    PaymentAcceptorPaymentMethodOptionsRequestCreateRequestShopperInteraction:
      type: string
      enum:
      - ECOMMERCE
      - CONT_AUTH
      - MOTO
      - POS
      title: PaymentAcceptorPaymentMethodOptionsRequestCreateRequestShopperInteraction
    EInvoicingConditionGroup:
      type: object
      properties:
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/EInvoicingCondition'
          description: Conditions that determine whether this conditionGroup matches the invoice. All conditions need to match for the group to match
      title: EInvoicingConditionGroup
    CustomTaxCodeField:
      type: string
      enum:
      - INVOICE_COMMITMENT
      - PRODUCT_FALLBACK
      description: The field to use a custom code for
      title: CustomTaxCodeField
    PaymentGatewayIntegrationVariant:
      type: string
      enum:
      - ADYEN
      - STRIPE
      description: The variant of payment integration.
      title: PaymentGatewayIntegrationVariant
    AdyenAutoRescue:
      type: object
      properties:
        enabled:
          type:
          - boolean
          - 'null'
        period:
          $ref: '#/components/schemas/Period'
      title: AdyenAutoRescue
    MXLocal:
      type: object
      properties:
        clabe:
          type:
          - string
          - 'null'
          description: CLABE (Clave Bancaria Estandarizada) account identifier
        account_number:
          type:
          - string
          - 'null'
          description: A bank account number if IBAN is not used
        bic:
          type:
          - string
          - 'null'
          description: The ISO 9362 Business Identifier Code (BIC) of the bank account
      title: MXLocal
    BankAccountCreateRequestType:
      type: string
      enum:
      - IBAN
      - BIC_AND_ACCOUNT_NUMBER
      - ACCOUNT_NUMBER_AND_BIC
      - US_BANK_ACCOUNT
      - US_LOCAL
      - UK_LOCAL
      - BR_LOCAL
      - AR_LOCAL
      - MX_LOCAL
      description: Determines what fields should be present in the bank account node.
      title: BankAccountCreateRequestType
    LegalEntityManagerDetails:
      type: object
      properties:
        authentication:
          $ref: '#/components/schemas/AuthenticationSettings'
      title: LegalEntityManagerDetails
    BankAccountCreateRequest:
      type: object
      properties:
        type:
          oneOf:
          - $ref: '#/components/schemas/BankAccountCreateRequestType'
          - type: 'null'
          description: Determines what fields should be present in the bank account node.
        iban:
          type:
          - string
          - 'null'
        country:
          type:
          - string
          - 'null'
        bic:
          type:
          - string
          - 'null'
          description: The ISO 9362 Business Identifier Code (BIC) of the bank account
        bank_name:
          type:
          - string
          - 'null'
        bank_address:
          $ref: '#/components/schemas/Address'
          description: The bank address
        account_number:
          type:
          - string
          - 'null'
          description: A bank account number if IBAN is not used, e.g a USA or UK bank account number
        bank_code:
          type:
          - string
          - 'null'
          description: A bank code that's used to identify the bank that this account belongs to
        routing_number:
          type:
          - string
          - 'null'
          description: The 9-digit code that identifies a specific financial institution for transactions in the USA.
        account_type:
          oneOf:
          - $ref: '#/components/schemas/BankAccountCreateRequestAccountType'
          - type: 'null'
          description: The bank account type.
        account_number_and_bic:
          $ref: '#/components/schemas/AccountNumberAndBic'
        uk_local:
          $ref: '#/components/schemas/UKLocal'
        us_local:
          $ref: '#/components/schemas/USLocal'
        br_local:
          $ref: '#/components/schemas/BRLocal'
        ar_local:
          $ref: '#/components/schemas/ARLocal'
        mx_local:
          $ref: '#/components/schemas/MXLocal'
      title: BankAccountCreateRequest
    Period:
      type: object
      properties:
        type:
          $ref: '#/components/s

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