openapi: 3.0.3
info:
  license:
    url: https://solidgate.com/legal/terms-of-use/
    name: Terms and policies
  version: 1.0.0
  title: Solidgate • API reference
  description: |
    The Solidgate API is a payment gateway API that enables merchants to securely process and manage transactions, including card payments and alternative payment methods.

    <style>
    .sg-overview {
      --sg-surface: #f3f3f6;
      --sg-btn-cta: 6.5rem;
      --sg-btn-cta-h: 2.375rem;
      --sg-card-cta: 14.25rem;
      --sg-btn-sdk: 7.5rem;
    }
    .sg-overview .sg-panel {
      background-color: var(--sg-surface);
      padding: 20px 28px;
      border-radius: 12px;
      margin: 12px 0 24px;
      box-sizing: border-box;
    }
    .sg-overview .sg-panel__label {
      margin: 0 0 12px;
      font-size: 13px;
      color: #4a5568;
      text-transform: uppercase;
      letter-spacing: 0.05em;
      font-weight: 500;
      line-height: 1.4;
    }
    .sg-overview .sdk-buttons {
      display: flex;
      flex-wrap: wrap;
      gap: 12px;
    }
    .sg-overview .sdk-buttons .sg-btn {
      width: var(--sg-btn-sdk) !important;
      min-width: var(--sg-btn-sdk) !important;
      max-width: 100%;
      box-sizing: border-box;
      justify-content: center;
    }
    .sg-overview .sg-intro {
      display: flex;
      flex-wrap: wrap;
      gap: 16px;
      align-items: stretch;
      margin: 12px 0 24px;
    }
    .sg-overview .sg-intro__cta.sg-action-card {
      margin: 0 !important;
      flex: 0 0 var(--sg-card-cta);
      width: var(--sg-card-cta);
      max-width: 100%;
      box-sizing: border-box;
    }
    .sg-overview .sg-intro__cta .sg-btn {
      width: var(--sg-btn-cta) !important;
      min-width: var(--sg-btn-cta) !important;
      max-width: var(--sg-btn-cta) !important;
      height: var(--sg-btn-cta-h) !important;
      padding: 10px 18px !important;
      box-sizing: border-box;
      justify-content: center;
    }
    .sg-overview .sg-intro__text.sg-action-card {
      margin: 0 !important;
      flex: 1 1 280px;
      width: auto;
      max-width: 100%;
      box-sizing: border-box;
    }
    .sg-overview .sg-intro__copy {
      margin: 0;
      font-size: 15px;
      line-height: 1.55;
      color: #1a202c;
    }
    .sg-overview .sg-btn__icon {
      width: 16px;
      height: 16px;
      flex-shrink: 0;
    }
    .sg-overview__footer {
      margin-top: 20px;
    }
    @media (max-width: 768px) {
      .sg-overview .sg-intro {
        flex-direction: column;
      }
      .sg-overview .sg-intro__cta.sg-action-card {
        flex: 1 1 auto;
        width: auto;
      }
      .sg-overview .sg-intro__cta .sg-btn {
        width: auto !important;
        min-width: 0 !important;
        max-width: 100% !important;
        height: auto !important;
      }
      .sg-overview .sdk-buttons .sg-btn {
        flex: 1 1 calc(50% - 6px);
        width: auto !important;
        min-width: 0 !important;
      }
    }
    @media (max-width: 480px) {
      .sg-overview .sdk-buttons .sg-btn {
        flex: 1 1 100%;
      }
    }
    </style>

    <div class="sg-overview">

    <div class="sg-intro">

      <div class="sg-action-card sg-intro__cta">
        <p class="sg-action-card__label">Get started quickly</p>
        <a href="https://www.postman.com/solidgate/solidgate-api/overview" target="_blank" rel="noopener noreferrer" class="sg-btn">
          <svg class="sg-btn__icon" width="16" height="16" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><path fill="#FFFFFF" d="M13.527.099C6.955-.744.942 3.9.099 10.473c-.843 6.572 3.8 12.584 10.373 13.428 6.573.843 12.587-3.801 13.428-10.374C24.744 6.955 20.101.943 13.527.099zm2.471 7.485a.855.855 0 0 0-.593.25l-4.453 4.453-.307-.307-.643-.643c4.389-4.376 5.18-4.418 5.996-3.753zm-4.863 4.861l4.44-4.44a.62.62 0 1 1 .847.903l-4.699 4.125-.588-.588zm.33.694l-1.1.238a.06.06 0 0 1-.067-.032.06.06 0 0 1 .01-.073l.645-.645.512.512zm-2.803-.459l1.172-1.172.879.878-1.979.426a.074.074 0 0 1-.085-.039.072.072 0 0 1 .013-.093zm-3.646 6.058a.076.076 0 0 1-.069-.083.077.077 0 0 1 .022-.046h.002l.946-.946 1.222 1.222-2.123-.147zm2.425-1.256a.228.228 0 0 0-.117.256l.203.865a.125.125 0 0 1-.211.117h-.003l-.934-.934-.294-.295 3.762-3.758 1.82-.393.874.874c-1.255 1.102-2.971 2.201-5.1 3.268zm5.279-3.428h-.002l-.839-.839 4.699-4.125a.952.952 0 0 0 .119-.127c-.148 1.345-2.029 3.245-3.977 5.091zm3.657-6.46l-.003-.002a1.822 1.822 0 0 1 2.459-2.684l-1.61 1.613a.119.119 0 0 0 0 .169l1.247 1.247a1.817 1.817 0 0 1-2.093-.343zm2.578 0a1.714 1.714 0 0 1-.271.218h-.001l-1.207-1.207 1.533-1.533c.661.72.637 1.832-.054 2.522zM18.855 6.05a.143.143 0 0 0-.053.157.416.416 0 0 1-.053.45.14.14 0 0 0 .023.197.141.141 0 0 0 .084.03.14.14 0 0 0 .106-.05.691.691 0 0 0 .087-.751.138.138 0 0 0-.194-.033z"/></svg>
          Postman
        </a>
      </div>

      <div class="sg-action-card sg-intro__text">
        <p class="sg-intro__copy">Solidgate offers APIs for processing and managing payments via HTTP/REST or Solidgate libraries, with JSON as the data exchange format.</p>
      </div>

    </div>

    <p><strong>Frontend SDK</strong></p>
    <p>These are the primary frontend libraries. Use them to embed payment forms directly in your client-side application.</p>

    <div class="sg-panel">
      <p class="sg-panel__label">Choose your framework</p>
      <div class="sdk-buttons">
        <a href="https://github.com/solidgate-tech/react-sdk" target="_blank" rel="noopener noreferrer" id="reactsdk" class="sg-btn">
          <svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="#FFFFFF" stroke-width="1.5" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><circle cx="12" cy="12" r="1.6" fill="#FFFFFF" stroke="none"/><ellipse cx="12" cy="12" rx="9" ry="3.5"/><ellipse cx="12" cy="12" rx="9" ry="3.5" transform="rotate(60 12 12)"/><ellipse cx="12" cy="12" rx="9" ry="3.5" transform="rotate(120 12 12)"/></svg>
          React
        </a>
        <a href="https://github.com/solidgate-tech/vue-sdk" target="_blank" rel="noopener noreferrer" id="vuesdk" class="sg-btn">
          <svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="#FFFFFF" stroke-width="1.6" stroke-linejoin="round" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><path d="M3 4 L12 20 L21 4"/><path d="M8 4 L12 11 L16 4"/></svg>
          Vue
        </a>
        <a href="https://github.com/solidgate-tech/angular-sdk" target="_blank" rel="noopener noreferrer" id="angularsdk" class="sg-btn">
          <svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="#FFFFFF" stroke-width="1.6" stroke-linejoin="round" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><path d="M12 2 L21 5.5 L19.5 17 L12 22 L4.5 17 L3 5.5 Z"/><path d="M8.5 16 L12 8 L15.5 16"/><path d="M9.8 13 L14.2 13"/></svg>
          Angular
        </a>
      </div>
    </div>

    <p><strong>Backend SDK</strong></p>
    <p>Multiple backend libraries to manage server-side processing, advanced integrations, form resign flows, and reconciling orders.</p>

    <div class="sg-panel">
      <p class="sg-panel__label">Pick the stack</p>
      <div class="sdk-buttons">
        <a href="https://github.com/solidgate-tech/nodejs-sdk" target="_blank" rel="noopener noreferrer" id="nodesdk" class="sg-btn">
          <svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="#FFFFFF" stroke-width="1.5" stroke-linejoin="round" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><path d="M12 2 L20.5 7 L20.5 17 L12 22 L3.5 17 L3.5 7 Z"/><text x="12" y="15.5" fill="#FFFFFF" stroke="none" font-family="Inter, Arial, sans-serif" font-size="7" font-weight="700" text-anchor="middle">JS</text></svg>
          Node.js
        </a>
        <a href="https://github.com/solidgate-tech/php-sdk" target="_blank" rel="noopener noreferrer" id="phpsdk" class="sg-btn">
          <svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="#FFFFFF" stroke-width="1.5" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><ellipse cx="12" cy="12" rx="10" ry="6"/><text x="12" y="14.4" fill="#FFFFFF" stroke="none" font-family="Inter, Arial, sans-serif" font-size="6" font-weight="700" text-anchor="middle" letter-spacing="0.3">PHP</text></svg>
          PHP
        </a>
        <a href="https://github.com/solidgate-tech/go-sdk" target="_blank" rel="noopener noreferrer" id="gosdk" class="sg-btn">
          <svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="#FFFFFF" stroke-width="1.5" stroke-linecap="round" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><path d="M3 9 L8 9 M3 12 L7 12 M3 15 L8 15"/><text x="15" y="15" fill="#FFFFFF" stroke="none" font-family="Inter, Arial, sans-serif" font-size="9" font-weight="700" text-anchor="middle" letter-spacing="0.5">GO</text></svg>
          Go
        </a>
        <a href="https://github.com/solidgate-tech/kotlin-sdk" target="_blank" rel="noopener noreferrer" id="kotlinsdk" class="sg-btn">
          <svg width="18" height="18" viewBox="0 0 24 24" fill="#FFFFFF" stroke="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><path d="M3 3 L13 3 L3 13 Z"/><path d="M3 13 L13 3 L21 3 L12 12 L21 21 L13 21 L3 13 Z" fill-rule="evenodd"/><path d="M3 13 L3 21 L13 21 L8 16 Z"/></svg>
          Kotlin
        </a>
        <a href="https://github.com/solidgate-tech/python-sdk" target="_blank" rel="noopener noreferrer" id="pythonsdk" class="sg-btn">
          <svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="#FFFFFF" stroke-width="1.5" stroke-linejoin="round" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"><path d="M9 3 H13 A4 4 0 0 1 17 7 V11 H9 A4 4 0 0 0 5 15 V17 H9 A4 4 0 0 1 5 13 V7 A4 4 0 0 1 9 3 Z"/><path d="M15 21 H11 A4 4 0 0 1 7 17 V13 H15 A4 4 0 0 0 19 9 V7 H15 A4 4 0 0 1 19 11 V17 A4 4 0 0 1 15 21 Z"/><circle cx="11" cy="6.5" r="0.8" fill="#FFFFFF"/><circle cx="13" cy="17.5" r="0.8" fill="#FFFFFF"/></svg>
          Python
        </a>
      </div>
    </div>

    <div class="sg-overview__footer">
      <p>Enhance understanding with our <a href="https://docs.solidgate.com/payments/" target="_blank">payment guide</a>. <br>
      For help, write to <a href="https://support.solidgate.com/support/tickets/new" target="_blank">support@solidgate.com.</a></p>
    </div>

    </div>

    # Authentication

    <p>API <a href="https://docs.solidgate.com/payments/integrate/access-to-api/" target="_blank">authentication</a> in Solidgate ensures that requests come from authorized sources using a <code>merchant</code> identifier and a <code>signature</code> in the request headers.</p>

    <p>When you sign up via the Solidgate <a href="https://hub.solidgate.com" target="_blank">Hub</a>, you receive a public and secret API key pair. You authenticate by providing the appropriate key in the Authorization header. Never share your secret key and always store it securely.</p>

    <p>To start accepting payments, including in the sandbox environment, you need two sets of credentials: a <code>publicKey</code> and a <code>secretKey</code>. They are used for direct API calls and receiving webhooks. The <code>signature</code> parameter, generated from the public and secret keys, verifies both the source and integrity of each request.</p>

    <p>By requiring <code>merchant</code> and <code>signature</code> in the header, API requests remain secure and accessible only to parties with the correct private key.</p>

    <blockquote>
      <p>For detailed information on using the Solidgate API, refer to the <a href="https://docs.solidgate.com/payments/integrate/access-to-api/" target="_blank">payment guide</a>.</p>
    </blockquote>
  x-logo:
    url: https://cdn.solidgate.com/logos/logo_api_sld.svg
    backgroundColor: '#fafafa'
    altText: Solidgate logo
servers:
  - url: https://pay.solidgate.com/api/v1
    description: Card payments API
  - url: https://gate.solidgate.com/api/v1
    description: Alternative payment methods API
  - url: https://subscriptions.solidgate.com/api/v1
    description: Subscriptions API
  - url: https://payment-page.solidgate.com/api/v1
    description: Payment Page API
  - url: https://reports.solidgate.com/api/v1
    description: Reports API
  - url: https://risks.solidgate.com/api/v1
    description: Risks API
  - url: https://api.solidgate.com/api/v1
    description: General API
security:
  - MerchantID: []
tags:
  - name: Card payments
    description: Solidgate API for <a href="https://docs.solidgate.com/payments/card-payments/" target="_blank">card payments</a> allows merchants to securely integrate with a payment gateway to process and manage card transactions.
  - name: Alternative payment methods
    description: Solidgate API for <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">alternative payment methods</a> allows merchants to securely integrate with a payment gateway to process and manage APM transactions such as PayPal, Pay by Bank, etc.
  - name: Products and prices
    description: Solidgate API for <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">billing</a> management allows merchants to create and update products and pricing effectively, ensuring businesses can adapt to diverse customer needs and preferences.
  - name: Manage subscriptions
    description: |-
      Solidgate API for <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscriptions</a> empowers merchants in efficiently and securely managing subscriptions for a positive customer experience and business growth. 

      Merchants can <a href="https://docs.solidgate.com/billing/manage-subscription/" target="_blank">easily handle</a> their subscriptions using the available methods such as switching subscription products, pausing and resuming services, cancelling subscriptions, and providing customers with the option to update payment information.
  - name: Retrieve subscription data
    description: |-
      Solidgate API for <a href="https://docs.solidgate.com/billing/manage-subscription/retrieve-subscription-data/" target="_blank">accessing subscription information</a> provides merchants with the ability to obtain precise and up-to-date details regarding customer subscriptions.

      To get in-depth insights into customer subscriptions, use <a href="https://api-docs.solidgate.com/#tag/Reports/operation/retrieve-subscriptions" target="_blank">subscription report</a> that is specifically designed to retrieve and combine all subscription-related data.
  - name: Payment page
    description: Solidgate <a href="https://docs.solidgate.com/payments/integrate/payment-page/create-your-payment-page/" target="_blank">Payment Page</a> allows merchants to securely redirect customers to a payment gateway's hosted page for completing transactions, without the need for custom integration on the merchant's website.
  - name: Payment link
    description: Solidgate <a href="https://docs.solidgate.com/payments/integrate/payment-link/" target="_blank">Payment Link</a> feature offers a hassle-free way to conduct online sales without integration, allowing merchants to share a URL that leads customers to a secure payment page for both one-time and subscription transactions.
  - name: Taxes
    description: Solidgate’s <a href="https://docs.solidgate.com/billing/taxes/" target="_blank">tax solution</a> empowers businesses to manage and automate tax calculations across multiple regions efficiently. By integrating the tax solution, merchants can support accurate tax handling and compliance with local regulations.
  - name: Files upload
    description: Solidgate API for file uploads enables to securely upload files to the system, such as evidence for chargeback disputes or documents required for verification purposes.
  - name: Reports
    description: |-
      Solidgate API for <a href="https://docs.solidgate.com/reporting/" target="_blank">reports</a> allows merchants to securely access transaction data and generate customized reports for analyzing and tracking the performance of their payment operations.

      With Solidgate’s reconciliation functionality, merchants can track cash daily, identify fund flow gaps, gain complete transaction lifecycle visibility, implement strong financial controls, and establish scalable financial processes.

      <blockquote>
        <p>Solidgate data comes with a 60-minute delay, thus it is not recommended for real-time analysis.</p>
        <p>Please note that reports may be inaccessible for about 30 minutes on Wednesdays at 5:00 PM (UTC) due to scheduled external maintenances. Once complete, all reports will be available with data preserved.</p>
      </blockquote>
  - name: Fraud prevention
    description: |-
      Solidgate API for <a href="https://docs.solidgate.com/risks/fraud/" target="_blank">fraud prevention</a> enables merchants to set up and manage fraud prevention lists, helping to block fraudulent activities while ensuring secure transactions.

      By configuring fraud prevention lists, merchants can define specific conditions to allow or reject transactions, enhancing the security and reliability of their payment operations.
  - name: Dispute representment
    description: Solidgate API for <a href="https://docs.solidgate.com/risks/chargebacks#respond-to-chargebacks" target="_blank">card dispute representment</a> and <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/manage#dispute-representment" target="_blank">PayPal dispute representment</a> representment enables merchants to defend card and PayPal disputes by uploading evidence files, helping to protect revenue and resolve disputed orders efficiently.
  - name: Manage webhooks
    description: 'Solidgate API for <a href="https://docs.solidgate.com/payments/integrate/webhooks/" target="_blank">webhook management</a> allows merchants to create, update, list, and delete webhook endpoint configurations. '
  - name: Changelog
    description: |
      The changelog documents all modifications, enhancements, and removals to the API. It helps developers and users to track changes, understand new features, and adjust their implementations.

      <!--suppress ALL -->
      <blockquote>
        <p>It is equally important to be aware of updates in the broader payment guide <a href="https://docs.solidgate.com/changelog/" target="_blank">changelog</a>, which includes comprehensive details on product-level changes that may affect overall payment processing.</p>
      </blockquote>

      <script>
          function toggleAccordion(button) {
              var panel = button.nextElementSibling;
              var isOpen = panel.style.display === 'block';
              panel.style.display = isOpen ? 'none' : 'block';
              button.children[0].style.transform = isOpen ? 'rotate(-90deg)' : 'rotate(0deg)';
          }
      </script>

      <div style="margin-top: 20px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
              <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(-90deg); transition: transform 0.4s;"></div>
              <b>API change impact</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: none; overflow: hidden;"> <!-- Initially displayed -->
          <p>Changes to the Solidgate APIs are aimed at minimizing the impact on existing integrations. However, depending on the type of change, actions may be required.</p>
              <div style="font-size: 0.9em; background-color: #f9f9f9; padding: 12px; border-left: 4px solid #ccc; margin-top: 16px;">
                  <p>Any API change that requires client-side adjustments will be communicated by the Solidgate team. These changes will include preparation time and clear guidance.</p>
                  <p>When we mark a field or feature as <strong>deprecated</strong> and add a <strong>deprecation notice</strong> to the changelog, it serves as an early notice. The deprecated fields or features will not be removed immediately.</p>
              </div>
          <p><b>Non-breaking changes</b></p>
          <p>These modifications do not affect existing integrations and ensure backward compatibility:</p>
          <ul>
              <li><strong>Request modifications:</strong>
                  <ul>
                      <li>Adding new, optional fields or parameters to the request.</li>
                      <li>Changing a field from required to optional in a request body.</li>
                  </ul>
              </li>
              <li><strong>Response modifications:</strong>
                  <ul>
                      <li>Adding new, optional fields to the response body.</li>
                      <li>Changing a field from optional to required in a response body.</li>
                  </ul>
              </li>
              <li><strong>HTTP headers:</strong> Adding new, optional request or response headers, changing the case of a header name.</li>
              <li><strong>Field length:</strong> Expanding the maximum length of an existing field.</li>
              <li><strong>Identifier format:</strong> Changing prefixes or formatting of existing identifiers.</li>
              <li><strong>Webhook events:</strong> Adding new webhook event types that require explicit opt-in.</li>
              <li><strong>Webhook schema:</strong> Adding new fields to existing webhook event payloads.</li>
              <li><strong>Rate limiting:</strong> Any modifications to rate limits will be communicated at least one month in advance.</li>
          </ul>
          <p><b>Breaking changes</b></p>
          <p>Breaking changes can impact existing integrations and require adjustments. These are marked with a <strong>breaking changes</strong> badge and include:</p>
          <ul>
              <li><strong>Operation removal:</strong> Removing an entire API operation.</li>
              <li><strong>Request modifications:</strong>
                  <ul>
                      <li>Removing or renaming a field or parameter.</li>
                      <li>Making an optional field or parameter required.</li>
                      <li>Removing <code>oneOf</code> from the request body.</li>
                  </ul>
              </li>
              <li><strong>Response modifications:</strong>
                  <ul>
                      <li>Removing or renaming a field in the response body.</li>
                      <li>Changing the HTTP status code of a response.</li>
                      <li>Removing <code>oneOf</code> from the response body.</li>
                  </ul>
              </li>
              <li><strong>Type changes:</strong> Changing the data type of a request parameter or a field of request or response.</li>
              <li><strong>HTTP headers:</strong> Adding a required header to a request or removing a header from a response.</li>
              <li><strong>Enum updates:</strong> Adding or removing an existing enum.</li>
              <li><strong>Errors:</strong> Changing error codes for an existing error.</li>
              <li><strong>Validation rules:</strong> Adding stricter or new validation rules to an existing field or parameter.</li>
              <li><strong>Authentication and authorization:</strong> Changing authentication or authorization requirements.</li>
          </ul>
          </div>
      </div>
      <br>

      ---

      <div style="margin-top: 30px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
              <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(0deg); transition: transform 0.4s;"></div>
              <b>June</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: block; overflow: hidden;">
          <br>
              <p><strong>5 June 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none; background-color: transparent;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                          <code>price_product_id</code> to the <a href="https://api-docs.solidgate.com/#tag/Retrieve-subscription-data/operation/get-subscription-status">get subscription status</a> and <a href="https://api-docs.solidgate.com/#tag/Retrieve-subscription-data/operation/list-invoices-by-subscription-id">list invoices</a> responses, as well as subscription <a href="https://api-docs.solidgate.com/#tag/Manage-subscriptions/operation/webhook-subscription-status">webhook</a> payloads.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>4 June 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none; background-color: transparent;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                          <code>metadata</code> to the <a href="https://api-docs.solidgate.com/#tag/Products-and-prices">product</a> requests and responses.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>2 June 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
                  <tr style="border: none; background-color: transparent;">
                      <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                          <code>shipping_address</code> to the <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-card-recurring">recurring</a> and <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-card-resign">resign</a> card payment requests.
                      </td>
                  </tr>
                  <tr style="border: none; background-color: transparent;">
                      <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                          <code>future_usage</code> for the <code>payment_method</code> <code>blik</code> to the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/create-apm-init-payment">init payment</a> alternative payment requests.
                      </td>
                  </tr>
                  <tr style="border: none; background-color: transparent;">
                      <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                          <code>payment_method</code> <code>blik</code> to the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/make-apm-recurring">recurring</a> alternative payment requests.
                      </td>
                  </tr>
              </table>
          </div>
      </div>

      <div style="margin-top: 30px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
              <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(-90deg); transition: transform 0.4s;"></div>
              <b>May</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: none; overflow: hidden;">
          <br>
              <p><strong>27 May 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                           <code>device_sessions</code> to <a href="https://api-docs.solidgate.com/#tag/Card-payments">card payments</a> requests.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>25 May 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>multibanco</code> <code>payment_method</code> to the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/create-apm-init-payment">init payment</a> alternative payment requests.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>22 May 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <a href="https://api-docs.solidgate.com/#tag/Reports/operation/routing-events-by-date">routing events</a> and <a href="https://api-docs.solidgate.com/#tag/Reports/operation/download-routing-events">download routing events</a> report endpoints to retrieve routing decisions and execution flow for orders processed through routing configurations.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>14 May 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>ani</code> object to the <code>verification_result</code> in the <a href="https://api-docs.solidgate.com/#tag/Card-payments">card payments</a> responses and the <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/webhook-card-order-status">updated card order</a> webhook.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>6 May 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="65" height="20" viewBox="0 0 65 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="63" height="18" rx="4" fill="none" stroke="#31308c" stroke-width="1"></rect>
                              <text x="32.5" y="14" font-size="12" fill="#5620b4" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Changed</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>authentication_response</code> field in the <code>external_mpi_data</code> object now accepts only <code>Y</code> and <code>A</code> values across the <a href="https://api-docs.solidgate.com/#tag/Card-payments">card payments</a> requests.
                      </td>
                  </tr>
              </table>
          </div>
      </div>

      <div style="margin-top: 30px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
              <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(-90deg); transition: transform 0.4s;"></div>
              <b>April</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: none; overflow: hidden;">
          <br>
              <p><strong>29 April 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>original_payment_method</code> to the <code>card_token</code> object in <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-card-recurring">recurring</a> and <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/get-status-card-order">check order status</a> responses.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>23 April 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>mbway</code> <code>payment_method</code> to the <a href="https://api-docs.solidgate.com/#tag/Payment-page/operation/create-payment-page">create page</a> and <a href="https://api-docs.solidgate.com/#tag/Payment-link/operation/create-payment-link">create link</a> requests.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>22 April 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>industry_data</code> with <code>type</code> <code>car_rental</code> to the <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-apple-pay">Apple Pay</a>, <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-google-pay">Google Pay</a>, and <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-card-resign">resign</a> payment requests.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>17 April 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="130" height="20" viewBox="0 0 130 20" style="vertical-align: -3px; margin: 0 -10px -1px -1px;">
                              <rect x="1" y="1" width="117" height="18" rx="4" fill="none" stroke="#ffa500" stroke-width="1"></rect>
                              <text x="60" y="14" font-size="12" fill="#ffa500" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">
                                  Deprecation notice
                              </text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>type</code> field in requests and responses across the all endpoints.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>16 April 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>pix-automatico</code> <code>payment_method</code> to the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/create-apm-init-payment">init payment</a> and <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/make-apm-recurring">recurring</a> alternative payment requests.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>1 April 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>order_description</code> to the <a href="https://api-docs.solidgate.com/#tag/Reports/operation/financial-entries-by-date">financial entries</a> report.
                      </td>
                  </tr>
              </table>
          </div>
      </div>

      <div style="margin-top: 30px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
              <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(-90deg); transition: transform 0.4s;"></div>
              <b>March</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: none; overflow: hidden;">
          <br>
              <p><strong>30 March 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>language</code> to the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/create-apm-init-payment">init payment</a> and <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/make-apm-recurring">recurring</a> alternative payment requests.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>10 March 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>recurring</code> price breakdown details to the <a href="https://api-docs.solidgate.com/#tag/Products-and-prices/operation/calculate-product-price">calculate product price</a> response.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>4 March 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>billing_address</code> <code>country</code>, <code>state</code>, <code>city</code>, and <code>zip</code> to the <a href="https://api-docs.solidgate.com/#tag/Payment-page/operation/create-payment-page">create page</a> request.
                      </td>
                  </tr>
              </table>
          </div>
      </div>

      <div style="margin-top: 30px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
              <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(-90deg); transition: transform 0.4s;"></div>
              <b>February</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: none; overflow: hidden;">
          <br>
              <p><strong>26 February 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                           <a href="https://api-docs.solidgate.com/#tag/Dispute-representment/operation/dispute-representments-enrich">enrich dispute representment</a> endpoint for enrich evidence in <code>card</code> and <code>paypal</code> <code>dispute_type</code>.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>25 February 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="65" height="20" viewBox="0 0 65 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="63" height="18" rx="4" fill="none" stroke="#31308c" stroke-width="1"></rect>
                              <text x="32.5" y="14" font-size="12" fill="#5620b4" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Changed</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>card_holder</code> validation to [2..52] characters.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>24 February 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>billing_address</code> <code>address</code> to the <a href="https://api-docs.solidgate.com/#tag/Payment-page/operation/create-payment-page">create page</a> request.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>20 February 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>discount</code> object to the <a href="https://api-docs.solidgate.com/#tag/Manage-subscriptions/operation/update-subscription">update subscription</a> request to manage subscription pricing with <code>coupon_id</code> or <code>coupon_code</code>.
                      </td>
                  </tr>
              </table>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="130" height="20" viewBox="0 0 130 20" style="vertical-align: -3px; margin: 0 -10px -1px -1px;">
                              <rect x="1" y="1" width="117" height="18" rx="4" fill="none" stroke="#ffa500" stroke-width="1"></rect>
                              <text x="60" y="14" font-size="12" fill="#ffa500" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">
                                  Deprecation notice
                              </text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          for <code>coupon_id</code> and <code>coupon_code</code> root-level fields in the <a href="https://api-docs.solidgate.com/#tag/Manage-subscriptions/operation/update-subscription">update subscription</a> request. Use the <code>discount</code> object instead.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>16 February 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/revoke-apm-recurring-token">revoke token</a> request and <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/webhook-apm-revoked-recurring-token">revoked recurring token</a> webhook for alternative payment methods.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>12 February 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>authorized_amount</code> to <code>order</code> in <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/webhook-card-order-status">updated card order</a> webhook to provide the total authorized amount of the order.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>3 February 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>qr_code_value</code> and <code>qr_code_expiration_date</code> to <code>payment_type_data</code> for Pix QR in the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/create-apm-init-payment">init payment</a> response of the alternative payment methods.
                      </td>
                  </tr>
              </table>
          </div>
      </div>

      <div style="margin-top: 30px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
              <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(-90deg); transition: transform 0.4s;"></div>
              <b>January</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: none; overflow: hidden;">
          <br>
              <p><strong>30 January 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>is_reloadable</code> to the <code>card</code> in <code>transaction</code> across <a href="https://api-docs.solidgate.com/#tag/Card-payments">card payments</a> responses.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>20 January 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>url</code> to the <a href="https://api-docs.solidgate.com/#tag/Manage-webhooks/operation/webhook-endpoint-update">update webhook endpoint</a> request to support the update of webhook delivery URL.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>16 January 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>authorization_type</code> to the <code>transaction</code> in the <a href="https://api-docs.solidgate.com/#tag/Reports/operation/retrieve-card-orders">card orders</a> report.
                      </td>
                  </tr>
              </table>
              <br>
              <p><strong>14 January 2026</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>authorization_type</code> to support <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/increment-card-auth">estimated and incremental auth</a> for the <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-card-charge">charge</a>, <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-card-recurring">recurring</a>, <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-card-resign">resign</a>, <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-google-pay">Google Pay</a>, <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-apple-pay">Apple Pay</a>, <a href="https://api-docs.solidgate.com/#tag/Payment-page/operation/create-payment-page">payment page</a>, and <a href="https://api-docs.solidgate.com/#tag/Payment-link/operation/create-payment-link">payment link</a> requests.
                      </td>
                  </tr>
              </table>
          </div>
      </div>

      <div style="margin-top: 30px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
          <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(-90deg); transition: transform 0.4s;"></div>
          <b>December</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: none; overflow: hidden;">
          <br>
              <p><strong>24 December 2025</strong></p>
          <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="1" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>exception</code> to the <code>three_ds</code> in the <a href="https://api-docs.solidgate.com/#tag/Card-payments">card payments</a> responses.
              </td>
            </tr>
          </table>
          <br>
              <p><strong>22 December 2025</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <a href="https://api-docs.solidgate.com/#tag/Products-and-prices/operation/find-prices">retrieve prices</a> method to get prices in bulk based on filter criteria.
                      </td>
                  </tr>
              </table><br>
              <p><strong>11 December 2025</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>mbway</code> alternative payment method to the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/make-apm-recurring">recurring</a> request.
                      </td>
                  </tr>
              </table><br>
              <p><strong>4 December 2025</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <code>403</code> status code to <a href="https://api-docs.solidgate.com/#tag/Products-and-prices">products and prices</a> and <a href="https://api-docs.solidgate.com/#tag/Manage-subscriptions">subscription</a> methods to indicate restricted <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#102-access-denied" target="_blank" rel="noopener">service access</a>.
                      </td>
                  </tr>
              </table>
          </div>
      </div>

      <div style="margin-top: 30px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
          <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(-90deg); transition: transform 0.4s;"></div>
          <b>November</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: none; overflow: hidden;">
          <br>
          <p><strong>25 November 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                 <svg xmlns="http://www.w3.org/2000/svg" width="70" height="20" viewBox="0 0 70 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;"><rect x="1" y="1" width="68" height="18" rx="4" fill="none" stroke="#1c3953" stroke-width="1"></rect><text x="35" y="14" font-size="12" fill="#1c3953" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Removed</text></svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                 <code>sepa</code> payment method <code>payment_method</code> from the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods">alternative payment methods</a>.
              </td>
            </tr>
           </table>
          <br>
          <p><strong>17 November 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>future_usage</code> to the <code>order</code> in the <a href="https://api-docs.solidgate.com/#tag/Payment-page/operation/create-payment-page">payment page</a> and <a href="https://api-docs.solidgate.com/#tag/Payment-link/operation/create-payment-link">payment link</a> create requests.
              </td>
            </tr>
           </table>
          <br>
          <p><strong>13 November 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="2" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>future_usage</code> for the <code>payment_method</code> <code>mbway</code> to the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods">alternative payment method</a> request.
              </td>
            </tr>
           </table>
          <br>
          <p><strong>11 November 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>country</code> to the <a href="https://api-docs.solidgate.com/#tag/Card-payments">card payments</a> requests.
              </td>
            </tr>
          </table>
          <br>
          <p><strong>7 November 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>alipay</code>, <code>wechatpay</code>, <code>bizum</code>, and <code>gcash</code> payment methods to the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/create-apm-init-payment">alternative payment methods</a>.
              </td>
            </tr>
          </table>
        </div>
      </div>

      <div style="margin-top: 30px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
          <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(-90deg); transition: transform 0.4s;"></div>
          <b>October</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: none; overflow: hidden;">
          <br>
          <p><strong>21 October 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="1" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>transaction_link_id</code> to the <code>transaction</code> in the <a href="https://api-docs.solidgate.com/#tag/Card-payments">card payments</a> responses.
              </td>
            </tr>
          </table>
          <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="2" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                 <svg xmlns="http://www.w3.org/2000/svg" width="70" height="20" viewBox="0 0 70 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;"><rect x="1" y="1" width="68" height="18" rx="4" fill="none" stroke="#1c3953" stroke-width="1"></rect><text x="35" y="14" font-size="12" fill="#1c3953" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Removed</text></svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                 <code>davivienda</code> payment method from the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods">alternative payments</a>.
              </td>
            </tr>
            <tr style="border: none; background-color: transparent;">
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  deprecated financial entries by settlement endpoint, which provided a <a href="https://api-docs.solidgate.com/#tag/Reports">report</a> with financial data by settlement.
              </td>
            </tr>
          </table>
          <br>
          <p><strong>15 October 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>payment_method</code> to the <code>order</code> in the <a href="https://api-docs.solidgate.com/#tag/Reports/operation/retrieve-card-orders">card orders</a> report.
              </td>
            </tr>
          </table>
          <br>
          <p><strong>14 October 2025</strong></p>
          <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="2" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                  <code>transaction_link_id</code> to the <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-card-charge">charge</a> requests.
              </td>
            </tr>
            <tr style="border: none; background-color: transparent;">
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>payment_method</code> to the <code>order</code> in the <a href="https://api-docs.solidgate.com/#tag/Card-payments">card payments</a> responses.
              </td>
            </tr>
          </table>
          <br>
          <p><strong>13 October 2025</strong></p>
          <table style="table-layout: fixed; width: 100%; border-collapse: collapse;border: none; border-spacing: 0;">
              <tr style="border: none;">
                  <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                      <svg xmlns="http://www.w3.org/2000/svg" width="70" height="20" viewBox="0 0 70 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;"><rect x="1" y="1" width="68" height="18" rx="4" fill="none" stroke="#1c3953" stroke-width="1"></rect><text x="35" y="14" font-size="12" fill="#1c3953" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Removed</text></svg>
                  </td>
                  <td style="min-width: 78%; vertical-align: top; border: none;">
                      <code>profile_id</code> and <code>is_included</code> from the <code>tax</code> in the <a href="https://api-docs.solidgate-stage.com/#tag/Products-and-prices">product-related</a> requests and responses.
                  </td>
              </tr>
          </table>
        </div>
      </div>

      <div style="margin-top: 30px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
              <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(-90deg); transition: transform 0.4s;"></div>
              <b>September</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: none; overflow: hidden;">
          <br>
          <p><strong>17 September 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>rrn_code</code> to the <code>transaction</code> in the <a href="https://api-docs.solidgate.com/#tag/Card-payments">card payments</a> responses.
              </td>
            </tr>
          </table>
          <br>
          <p><strong>12 September 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>industry_data</code> with <code>type</code> <code>airline</code> to the <a href="https://api-docs.solidgate-stage.com/#tag/Card-payments/operation/make-card-charge">charge</a> one-time payment requests.
              </td>
            </tr>
          </table>
          <table style="table-layout: fixed; width: 100%; border-collapse: collapse;border: none; border-spacing: 0;">
              <tr style="border: none;">
                  <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                      <svg xmlns="http://www.w3.org/2000/svg" width="130" height="20" viewBox="0 0 130 20" style="vertical-align: -3px; margin: 0 -10px -1px -1px;">
                          <rect x="1" y="1" width="117" height="18" rx="4" fill="none" stroke="#ffa500" stroke-width="1"></rect>
                          <text x="60" y="14" font-size="12" fill="#ffa500" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">
                              Deprecation notice
                          </text>
                      </svg>
                  </td>
                  <td style="min-width: 78%; vertical-align: top; border: none;">
                      for <code>3.09</code> in <code>error</code> <code>code</code> for all responses.
                  </td>
              </tr>
          </table> <br>
          <p><strong>10 September 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>behavior</code> to the <code>tax</code> of the <a href="https://api-docs.solidgate-stage.com/#tag/Products-and-prices">product-related</a> requests and responses.
              </td>
            </tr>
          </table>
          <table style="table-layout: fixed; width: 100%; border-collapse: collapse;border: none; border-spacing: 0;">
              <tr style="border: none;">
                  <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                      <svg xmlns="http://www.w3.org/2000/svg" width="130" height="20" viewBox="0 0 130 20" style="vertical-align: -3px; margin: 0 -10px -1px -1px;">
                          <rect x="1" y="1" width="117" height="18" rx="4" fill="none" stroke="#ffa500" stroke-width="1"></rect>
                          <text x="60" y="14" font-size="12" fill="#ffa500" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">
                              Deprecation notice
                          </text>
                      </svg>
                  </td>
                  <td style="min-width: 78%; vertical-align: top; border: none;">
                      for <code>profile_id</code> and <code>is_included</code> of the <code>tax</code> present in the <a href="https://api-docs.solidgate-stage.com/#tag/Products-and-prices">product-related</a> requests and responses.
                  </td>
              </tr>
          </table>
          <br>
          <p><strong>5 September 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>discount</code> to the <a href="https://api-docs.solidgate.com/#tag/Retrieve-subscription-data/operation/get-subscription-status">get subscription status</a> and <a href="https://api-docs.solidgate.com/#tag/Manage-subscriptions/operation/update-subscription">update subscription</a> responses, as well as the subscription <a href="https://api-docs.solidgate.com/#tag/Manage-subscriptions/operation/webhook-subscription-status">extended events</a>.
              </td>
            </tr>
          </table>
        </div>
      </div>

      <div style="margin-top: 30px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
              <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(-90deg); transition: transform 0.4s;"></div>
              <b>August</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: none; overflow: hidden;">
          <br>
          <p><strong>29 August 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <a href="https://api-docs.solidgate.com/#tag/Payment-page/operation/deactivate-payment-page">deactivate payment page</a> request to prevent its further use.
              </td>
            </tr>
          </table>
          <table style="table-layout: fixed; width: 100%; border-collapse: collapse;border: none; border-spacing: 0;">
              <tr style="border: none;">
                  <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                      <svg xmlns="http://www.w3.org/2000/svg" width="130" height="20" viewBox="0 0 130 20" style="vertical-align: -3px; margin: 0 -10px -1px -1px;">
                          <rect x="1" y="1" width="117" height="18" rx="4" fill="none" stroke="#ffa500" stroke-width="1"></rect>
                          <text x="60" y="14" font-size="12" fill="#ffa500" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">
                              Deprecation notice
                          </text>
                      </svg>
                  </td>
                  <td style="min-width: 78%; vertical-align: top; border: none;">
                      for <code>guid</code> in the <a href="https://api-docs.solidgate.com/#tag/Payment-page/operation/create-payment-page">create page</a> response.
                  </td>
              </tr>
          </table>
          <br>
          <p><strong>19 August 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                  <svg xmlns="http://www.w3.org/2000/svg" width="70" height="20" viewBox="0 0 70 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;"><rect x="1" y="1" width="68" height="18" rx="4" fill="none" stroke="#1c3953" stroke-width="1"></rect><text x="35" y="14" font-size="12" fill="#1c3953" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Removed</text></svg>
              </td>
              <td style="min-width: 78%; vertical-align: top; border: none;">
                  <code>profile_id</code> and <code>rate_id</code> of the <code>tax</code> in the <a href="https://api-docs.solidgate.com/#tag/Products-and-prices/operation/calculate-product-price">calculate product price</a> response.
              </td>
            </tr>
          </table><br>
          <p><strong>14 August 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>represented_by</code> to the <code>dispute</code> in the <a href="https://api-docs.solidgate.com/#tag/Reports/operation/retrieve-apm-paypal-disputes">PayPal disputes</a> report and to the <code>order: chargebacks: flow</code> in the <a href="https://api-docs.solidgate.com/#tag/Reports/operation/retrieve-card-chargebacks">chargebacks</a> report.
              </td>
            </tr>
          </table><br>
        </div>
      </div>

      <div style="margin-top: 30px;">
          <button onclick="toggleAccordion(this)" style="background-color: rgb(238,238,238); color: rgb(68,68,68); cursor: pointer; padding: 18px; width: 100%; border: none; text-align: left; outline: none; font-size: 15px; position: relative;">
              <div style="width: 0; height: 0; border-left: 5px solid transparent; border-right: 5px solid transparent; border-bottom: 5px solid rgb(68,68,68); position: absolute; right: 10px; top: 50%; transform: translateY(-50%) rotate(-90deg); transition: transform 0.4s;"></div>
              <b>July</b>
          </button>
          <div style="padding: 0 18px; background-color: #ffffff; display: none; overflow: hidden;">
          <br>
          <p><strong>22 July 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>created_at</code> and <code>updated_at</code> to the cards <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/webhook-alert-prevent">received prevention alert</a> and apms <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/webhook-apm-alert-prevent">received prevention alert</a> webhooks.
              </td>
            </tr>
          </table><br>
          <br>
          <p><strong>18 July 2025</strong></p>
          <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                  <code>created_by</code> to the <a href="https://api-docs.solidgate.com/#tag/Fraud-prevention/operation/fraud-prevention-list-items-create">create fraud prevention list items</a> request.
              </td>
            </tr>
            <tr style="border: none; background-color: transparent;">
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                <code>include_deleted</code>, <code>created_at_from</code> and <code>created_at_to</code> to the <a href="https://api-docs.solidgate.com/#tag/Card-payments">list fraud prevention list items</a> request.
              </td>
            </tr>
            <tr style="border: none; background-color: transparent;">
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                <code>created_at</code>, <code>deleted_at</code> and <code>created_by</code> to the <a href="https://api-docs.solidgate.com/#tag/Card-payments">list fraud prevention list items</a> response.
              </td>
            </tr>
          </table>
          <br>
          <p><strong>17 July 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>card_data_type</code> and <code>dpan_source</code> to the <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/make-card-charge">charge</a> one-time payment with PAN and DPAN request.
              </td>
            </tr>
          </table><br>
          <p><strong>16 July 2025</strong></p>
          <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
              <tr style="border: none;">
                  <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                      <svg xmlns="http://www.w3.org/2000/svg" width="70" height="20" viewBox="0 0 70 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;"><rect x="1" y="1" width="68" height="18" rx="4" fill="none" stroke="#1c3953" stroke-width="1"></rect><text x="35" y="14" font-size="12" fill="#1c3953" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Removed</text></svg>
                  </td>
                  <td style="min-width: 78%; vertical-align: top; border: none;">
                      <code>created</code> transaction status from the <a href="https://api-docs.solidgate.com/#tag/Card-payments">card payments</a> endpoints.
                  </td>
              </tr>
          </table>
          <table style="table-layout: fixed; width: 100%; border-collapse: collapse;border: none; border-spacing: 0;">
              <tr style="border: none;">
                  <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                      <svg xmlns="http://www.w3.org/2000/svg" width="130" height="20" viewBox="0 0 130 20" style="vertical-align: -3px; margin: 0 -10px -1px -1px;">
                          <rect x="1" y="1" width="117" height="18" rx="4" fill="none" stroke="#ffa500" stroke-width="1"></rect>
                          <text x="60" y="14" font-size="12" fill="#ffa500" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">
                              Deprecation notice
                          </text>
                      </svg>
                  </td>
                  <td style="min-width: 78%; vertical-align: top; border: none;">
                      for <code>profile_id</code> and <code>rate_id</code> of the <code>tax</code> in the <a href="https://api-docs.solidgate.com/#tag/Products-and-prices/operation/calculate-product-price">calculate product price</a> response.
                  </td>
              </tr>
          </table><br>
          <p><strong>15 July 2025</strong></p>
          <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                  <code>antifraud_result</code> to the <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/webhook-card-order-status">updated card order</a> webhook and to the <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/get-status-card-order">check order status</a> response.<br><br>
              </td>
            </tr>
            <tr style="border: none; background-color: transparent;">
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                <code>scheme_transaction_id</code> to the <code>transaction</code> in the <a href="https://api-docs.solidgate.com/#tag/Card-payments">card payments</a> responses.
              </td>
            </tr>
          </table><br>
          <p><strong>11 July 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>represented_by</code> to the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/webhook-paypal-dispute">received PayPal dispute</a> webhook and to the <code>chargeback_flow</code> in the <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/webhook-chargeback">received dispute</a> webhook.
              </td>
            </tr>
          </table><br>
          <p><strong>8 July 2025</strong></p>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                              <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <a href="https://api-docs.solidgate.com/#tag/Manage-subscriptions/operation/update-subscription">update subscription</a> operation to make available trial updates, discount application, and product changes in one request.
                      </td>
                  </tr>
              </table>
              <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
                  <tr style="border: none;">
                      <td style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                          <svg xmlns="http://www.w3.org/2000/svg" width="65" height="20" viewBox="0 0 65 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                              <rect x="1" y="1" width="63" height="18" rx="4" fill="none" stroke="#31308c" stroke-width="1"></rect>
                              <text x="32.5" y="14" font-size="12" fill="#5620b4" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Changed</text>
                          </svg>
                      </td>
                      <td style="min-width: 78%; vertical-align: top; border: none;">
                          <a href="https://api-docs.solidgate.com/#tag/Manage-subscriptions/operation/restore-subscription">restore subscription</a> operation to add support for restoring subscriptions with either <code>coupon_id</code> or <code>coupon_code</code>.
                      </td>
                  </tr>
              </table><br>
          <p><strong>4 July 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                  <code>retry_mode</code> to <a href="https://api-docs.solidgate.com/#tag/Products-and-prices/operation/create-product">create</a> and <a href="https://api-docs.solidgate.com/#tag/Products-and-prices/operation/update-product">update</a> requests in the subscription flow to define the revenue recovery approach.<br><br>
              </td>
            </tr>
            <tr style="border: none; background-color: transparent;">
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                <a href="https://api-docs.solidgate.com/#tag/Taxes/operation/tax-transactional">create</a> and <a href="https://api-docs.solidgate.com/#tag/Taxes/operation/download-tax-transactional">download</a> transactional tax endpoints.
              </td>
            </tr>
          </table><br>
              <p><strong>3 July 2025</strong></p>
           <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none;">
            <tr style="border: none; background-color: transparent;">
              <td rowspan="3" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;" aria-label="Added badge" role="img">
                  <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                  <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                </svg>
              </td>
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                <code>solidgate-event-created-at</code>
                <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">header parameter</a>
                to support chronological processing of events.<br><br>
              </td>
            </tr>
            <tr style="border: none; background-color: transparent;">
              <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none;">
                <a href="https://api-docs.solidgate.com/#tag/Taxes/operation/tax-summary">create</a>
                and
                <a href="https://api-docs.solidgate.com/#tag/Taxes/operation/download-tax-summary">download</a> summary tax endpoints.
              </td>
            </tr>
          </table><br>
              <p><strong>1 July 2025</strong></p>
          <table style="table-layout: fixed; border-collapse: collapse; width: 100%; border: none; border-spacing: 0;">
              <tr style="border: none; background-color: transparent; margin-bottom: 20px;">
                  <td rowspan="4" style="min-width: 130px; max-width: 30%; vertical-align: top; padding-right: 10px; padding-left: 1px; border: none;">
                      <svg xmlns="http://www.w3.org/2000/svg" width="55" height="20" viewBox="0 0 55 20" style="vertical-align: -3px; margin: 0 4px -1px -1px;">
                          <rect x="1" y="1" width="53" height="18" rx="4" fill="none" stroke="#308132" stroke-width="1"></rect>
                          <text x="27.5" y="14" font-size="12" fill="#308132" font-family="Arial, sans-serif" font-weight="lighter" text-anchor="middle" letter-spacing="0.2">Added</text>
                      </svg>
                  </td>
              <tr style="border: none; background-color: transparent;">
                  <td style="min-width: 70%; max-width: 70%; vertical-align: top; border: none; background-color: transparent;">
                      <code>ip_address</code> to the <code>order</code> in the <a href="https://api-docs.solidgate.com/#tag/Card-payments">card payments</a> responses.
                  </td>
              </tr>
          </table>
          </div>
      </div>

      <script>
          function toggleAccordion(button) {
              var panel = button.nextElementSibling;
              var isOpen = panel.style.display === 'block';
              panel.style.display = isOpen ? 'none' : 'block';
              button.children[0].style.transform = isOpen ? 'rotate(-90deg)' : 'rotate(0deg)';
          }
      </script>

      <script>
          function toggleAccordion(button) {
              var panel = button.nextElementSibling;
              var isOpen = panel.style.display === 'block';
              panel.style.display = isOpen ? 'none' : 'block';
              button.children[0].style.transform = isOpen ? 'rotate(-90deg)' : 'rotate(0deg)';
          }
      </script>

      <script>
          function toggleAccordion(button) {
              var panel = button.nextElementSibling;
              var isOpen = panel.style.display === 'block';
              panel.style.display = isOpen ? 'none' : 'block';
              button.children[0].style.transform = isOpen ? 'rotate(-90deg)' : 'rotate(-180deg)';
          }
      </script>
paths:
  /init:
    servers:
      - url: https://payment-page.solidgate.com/api/v1
        description: Payment Page Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: create-payment-page
      summary: Create page
      description: |-
        <blockquote>
          <p>Please note that the payment page link <b>expires in 24 hours</b>.</p>
        </blockquote>
      tags:
        - Payment page
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/RequestCheckoutSolutionsCreatePage'
                - $ref: '#/components/schemas/RequestCheckoutSolutionsCreateSubscriptionPaymentPage'
            examples:
              Payment:
                $ref: '#/components/examples/ExampleCheckoutSolutionsCreatePage'
              Subscription payment:
                $ref: '#/components/examples/ExampleCheckoutSolutionsCreateSubscriptionPaymentPage'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCheckoutSolutionsPage'
                  - $ref: '#/components/schemas/ResponseCheckoutSolutionsAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseCheckoutSolutionsError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCheckoutSolutionsResponseCreatePage'
                Authentication failed:
                  $ref: '#/components/examples/ExampleCheckoutSolutionsResponseAuthenticationFailed'
                Error:
                  $ref: '#/components/examples/ExampleCheckoutSolutionsResponseValidationError'
  /deactivate:
    servers:
      - url: https://payment-page.solidgate.com/api/v1
        description: Payment Page Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: deactivate-payment-page
      summary: Deactivate page
      description: Deactivate an active payment page to prevent further use.
      tags:
        - Payment page
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCheckoutSolutionsDeactivatePage'
      responses:
        '200':
          description: |-
            Request received

            <blockquote style="border-left: 4px solid #1d8126; margin-left: 20px;">
              <p style="color: #1d8126; margin-left: 6px;">Response either confirms success or returns error object.</p>
            </blockquote>
          content:
            application/json:
              schema:
                anyOf:
                  - title: Success
                    type: object
                    properties:
                      status:
                        type: string
                        description: Payment page has been deactivated.
                        example: ok
                  - $ref: '#/components/schemas/ResponseCheckoutSolutionsAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCheckoutSolutionsResponseSuccessDeactivate'
                Authentication failed:
                  $ref: '#/components/examples/ExampleCheckoutSolutionsResponseAuthenticationFailed'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCheckoutSolutionsError'
              examples:
                Validation error:
                  $ref: '#/components/examples/ExampleCheckoutDeactivateLinkError'
  /link/init:
    servers:
      - url: https://payment-page.solidgate.com/api/v1
        description: Payment Link Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: create-payment-link
      summary: Create link
      description: Payment links are code-free and reusable, allowing you to share them as many times as needed.
      tags:
        - Payment link
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/RequestCheckoutSolutionsCreateLink'
                - $ref: '#/components/schemas/RequestCheckoutSolutionsCreateSubscriptionPaymentLink'
            examples:
              Payment:
                $ref: '#/components/examples/ExampleCheckoutSolutionsCreateLink'
              Subscription payment:
                $ref: '#/components/examples/ExampleCheckoutSolutionsCreateSubscriptionPaymentLink'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCheckoutSolutionsLink'
                  - $ref: '#/components/schemas/ResponseCheckoutSolutionsAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseCheckoutSolutionsError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCheckoutSolutionsResponseCreateLink'
                Authentication failed:
                  $ref: '#/components/examples/ExampleCheckoutSolutionsResponseAuthenticationFailed'
                Error:
                  $ref: '#/components/examples/ExampleCheckoutSolutionsResponseValidationError'
  /link/deactivate:
    servers:
      - url: https://payment-page.solidgate.com/api/v1
        description: Payment Link Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: deactivate-payment-link
      summary: Deactivate link
      description: Deactivate an active payment link to prevent further use.
      tags:
        - Payment link
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCheckoutSolutionsDeactivateLink'
      responses:
        '200':
          description: |-
            Request received

            <blockquote style="border-left: 4px solid #1d8126; margin-left: 20px;">
              <p style="color: #1d8126; margin-left: 6px;">Response either confirms success or returns error object.</p>
            </blockquote>
          content:
            application/json:
              schema:
                anyOf:
                  - title: Success
                    type: object
                    properties:
                      status:
                        type: string
                        description: Payment link has been deactivated.
                        example: ok
                  - $ref: '#/components/schemas/ResponseCheckoutSolutionsAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseCheckoutSolutionsError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCheckoutSolutionsResponseSuccessDeactivate'
                Authentication failed:
                  $ref: '#/components/examples/ExampleCheckoutSolutionsResponseAuthenticationFailed'
                Validation error:
                  $ref: '#/components/examples/ExampleCheckoutDeactivateLinkError'
  /charge:
    servers:
      - url: https://pay.solidgate.com/api/v1
        description: Card payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: make-card-charge
      summary: Charge
      description: Basic operation withdraws funds from the cardholder’s account, with optional 3D Secure verification, and tokenizes the cardholder's data for future payments.
      tags:
        - Card payments
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/RequestCardsCharge'
                - $ref: '#/components/schemas/RequestCardsPaymentChargeDataType'
                - $ref: '#/components/schemas/RequestCardsProductBasedPaymentCharge'
                - $ref: '#/components/schemas/RequestCardsSubscriptionPaymentCharge'
            examples:
              PAN Payment:
                $ref: '#/components/examples/ExampleCardsRequestChargePaymentPan'
              DPAN Payment:
                $ref: '#/components/examples/ExampleCardsRequestChargePaymentDpan'
              Product-based payment:
                $ref: '#/components/examples/ExampleCardsRequestProductBasedPaymentCharge'
              Subscription payment:
                $ref: '#/components/examples/ExampleCardsRequestSubscriptionPaymentCharge'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCardsCharge'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCardsResponseCharge'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error X.XX:
                  $ref: '#/components/examples/ExampleMainResponseError'
  /google-pay:
    servers:
      - url: https://pay.solidgate.com/api/v1
        description: Card payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: make-google-pay
      summary: Google Pay
      description: An API request for Google Pay allows a merchant to initiate a Google Pay transaction, by sending a request to the Google Pay API with the required parameters such as amount, currency, and order identifier, which will be processed, and the response will be sent back with the transaction details.
      tags:
        - Card payments
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/RequestCardsGooglePay'
                - $ref: '#/components/schemas/RequestCardsProductBasedPaymentGooglePay'
                - $ref: '#/components/schemas/RequestCardsSubscriptionPaymentGooglePay'
            examples:
              Payment:
                $ref: '#/components/examples/ExampleCardsRequestGooglePay'
              Product-based payment:
                $ref: '#/components/examples/ExampleCardsRequestProductBasedPaymentGooglePay'
              Subscription payment:
                $ref: '#/components/examples/ExampleCardsRequestSubscriptionPaymentGooglePay'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCardsGooglePay'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCardsResponseGooglePay'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error X.XX:
                  $ref: '#/components/examples/ExampleMainResponseError'
  /apple-pay:
    servers:
      - url: https://pay.solidgate.com/api/v1
        description: Card payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: make-apple-pay
      summary: Apple Pay
      description: An API request for Apple Pay allows a merchant to initiate an Apple Pay transaction, by sending a request to the Apple Pay API with the required parameters such as amount, currency, and order identifier, which will be processed, and the response will be sent back with the transaction details.
      tags:
        - Card payments
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/RequestCardsApplePay'
                - $ref: '#/components/schemas/RequestCardsProductBasedPaymentApplePay'
                - $ref: '#/components/schemas/RequestCardsSubscriptionPaymentApplePay'
            examples:
              Payment:
                $ref: '#/components/examples/ExampleCardsRequestApplePay'
              Product-based payment:
                $ref: '#/components/examples/ExampleCardsRequestProductBasedPaymentApplePay'
              Subscription payment:
                $ref: '#/components/examples/ExampleCardsRequestSubscriptionPaymentApplePay'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCardsApplePay'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCardsResponseApplePay'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error X.XX:
                  $ref: '#/components/examples/ExampleMainResponseError'
  /increment:
    servers:
      - url: https://pay.solidgate.com/api/v1
        description: Card payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: increment-card-auth
      summary: Incremental auth
      description: |-
        <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/" target="_blank">Incremental authorization</a> operation creates additional authorization transactions on top of an estimated authorization to increase the total authorized amount for the order.

        <blockquote style="border-left: 4px solid #D1E6DF; ">
          <p>The <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#payment-configuration" target="_blank">payment configuration</a> conditions must be met.</p>
        </blockquote>

        <blockquote style="border-left: 4px solid #F2C4C4; ">                
            <p>Maximum 50 increments allowed per order.</p>
        </blockquote>

        This operation creates a <code>auth</code> transaction with <code>authorization_type</code> <code>incremental</code> within the same order.
      tags:
        - Card payments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCardsIncrement'
            examples:
              Payment incremental auth:
                $ref: '#/components/examples/ExampleCardsRequestIncrement'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCardsIncrement'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCardsResponseIncrement'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error 2.04 Card brand is not supported:
                  $ref: '#/components/examples/ExampleMainResponseErrorCardBrandNotSupported'
                Error X.XX:
                  $ref: '#/components/examples/ExampleMainResponseError'
  /recurring:
    servers:
      - url: https://pay.solidgate.com/api/v1
        description: Card payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: make-card-recurring
      summary: Recurring
      description: Method that allows you to initiate tokenized payments. In contrast to charge request, token previously received has to be sent in the request instead of cardholder data.
      tags:
        - Card payments
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/RequestCardsRecurring'
                - $ref: '#/components/schemas/RequestCardsProductBasedPaymentRecurring'
                - $ref: '#/components/schemas/RequestCardsSubscriptionPaymentRecurring'
            examples:
              Payment:
                $ref: '#/components/examples/ExampleCardsRequestRecurring'
              Product-based payment:
                $ref: '#/components/examples/ExampleCardsRequestProductBasedPaymentRecurring'
              Subscription payment:
                $ref: '#/components/examples/ExampleCardsRequestSubscriptionPaymentRecurring'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCardsRecurring'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCardsResponseRecurring'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error X.XX:
                  $ref: '#/components/examples/ExampleMainResponseError'
  /resign:
    servers:
      - url: https://pay.solidgate.com/api/v1
        description: Card payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: make-card-resign
      summary: Resign
      description: |-
        Resign one-click enables token-based transactions (1-click payments) with additional CVV verification, exclusive to PCI-DSS certified merchants.
        <blockquote> <p>Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under <b>120 attempts</b>.</p> </blockquote>
      tags:
        - Card payments
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/RequestCardsResign'
                - $ref: '#/components/schemas/RequestCardsProductBasedPaymentResign'
                - $ref: '#/components/schemas/RequestCardsSubscriptionPaymentResign'
            examples:
              Payment:
                $ref: '#/components/examples/ExampleCardsRequestResign'
              Product-based payment:
                $ref: '#/components/examples/ExampleCardsRequestProductBasedPaymentResign'
              Subscription payment:
                $ref: '#/components/examples/ExampleCardsRequestSubscriptionPaymentResign'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCardsResign'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCardsResponseResign'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error X.XX:
                  $ref: '#/components/examples/ExampleMainResponseError'
  /refund:
    servers:
      - url: https://pay.solidgate.com/api/v1
        description: Card payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: refund-card-order
      summary: Refund
      description: |-
        Request for transferring funds back to the cardholder.

        <blockquote>
          <p>Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under <b>120 attempts</b>.</p>
        </blockquote>
      tags:
        - Card payments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCardsRefund'
            examples:
              Refund:
                $ref: '#/components/examples/ExampleCardsRequestRefund'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCardsRefund'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCardsResponseRefund'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error X.XX:
                  $ref: '#/components/examples/ExampleMainResponseError'
  /void:
    servers:
      - url: https://pay.solidgate.com/api/v1
        description: Card payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: void-card-order
      summary: Void
      description: |-
        The void request serves to nullify pre-existing `auth` transactions by revoking the initial authorization. Be advised that the void method can only be executed for `auth` transactions. 

        <blockquote>
          <p>Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under <b>120 attempts</b>.</p>
        </blockquote>
      tags:
        - Card payments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCardsVoid'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCardsVoid'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCardsResponseVoid'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error X.XX:
                  $ref: '#/components/examples/ExampleMainResponseError'
  /settle:
    servers:
      - url: https://pay.solidgate.com/api/v1
        description: Card payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: settle-card-order
      summary: Settle
      description: |-
        The settle method facilitates the settlement of previously `auth` transactions. Be advised that if the subsequent settle `amount` is less than the initial `auth` transaction `amount`, the difference will be refunded to the cardholder's account.

        <blockquote>
          <p>Implementing automated retry logic for declined operations is advisable, along with an additional strategy of triggering subsequent attempts at hourly intervals. It is important to ensure that the cumulative retry count remains under <b>120 attempts</b>.</p>
        </blockquote>
      tags:
        - Card payments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCardsSettle'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCardsSettle'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCardsResponseSettle'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error X.XX:
                  $ref: '#/components/examples/ExampleMainResponseError'
  /status:
    servers:
      - url: https://pay.solidgate.com/api/v1
        description: Card payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: get-status-card-order
      summary: Check order status
      description: |-
        The check order status request helps to retrieve the present status of a given order. 

        <blockquote>
          <p>If a transaction is undergoing 3D Secure verification, the response indicates an order status of <code>3ds_verify</code>.</p>
        </blockquote>
      tags:
        - Card payments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCardsStatus'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCardsStatus'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseCardsError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCardsResponseStatus'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error X.XX:
                  $ref: '#/components/examples/ExampleCardsResponseError'
  /arn-code:
    servers:
      - url: https://pay.solidgate.com/api/v1
        description: Card payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: get-arn-codes
      summary: Get ARN codes
      description: Get ARN codes request obtains ARN codes for specific orders, providing essential information about refunds, currencies, and transaction statuses.
      tags:
        - Card payments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCardsArn'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseCardsArn'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleCardsResponseArn'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
  /init-payment:
    servers:
      - url: https://gate.solidgate.com/api/v1
        description: APM payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: create-apm-init-payment
      summary: Init payment
      description: Operation for the initiation of a payment using an <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>, performs order creation and prepares the transaction for payment, allowing the customer to proceed with the payment process.
      tags:
        - Alternative payment methods
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/RequestApmInitPaymentDiscriminator'
                - $ref: '#/components/schemas/RequestApmInitOneTimeProductDiscriminator'
                - $ref: '#/components/schemas/RequestApmInitSubscriptionDiscriminator'
            examples:
              PayPal:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentPaypal'
              Alipay:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentAlipay'
              Blik:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentBlik'
              Bizum:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentBizum'
              Boleto:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentBoleto'
              Efecty:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentEfecty'
              GCash:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentGcash'
              Ideal:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentIdeal'
              MB WAY:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentMbway'
              Mercado Pago:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentMercadopago'
              Multibanco:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentMultibanco'
              OXXO:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentOxxo'
              Pay by Bank:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentOpenbanking'
              Pix QR:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentPixQr'
              Pix Automático:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentPixAutomatico'
              Przelewy24:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentPrzelewy24'
              PSE:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentPse'
              Sencillito:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentSencillito'
              Servipag:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentServipag'
              SmartPix:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentPix'
              UPI:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentUpi'
              Webpay:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentWebpay'
              WeChat Pay:
                $ref: '#/components/examples/ExampleApmRequestInitPaymentWechatpay'
              Product-based payment PayPal:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductPaypal'
              Product-based payment Alipay:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductAlipay'
              Product-based payment Blik:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductBlik'
              Product-based payment Boleto:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductBoleto'
              Product-based payment Efecty:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductEfecty'
              Product-based payment GCash:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductGcash'
              Product-based payment Ideal:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductIdeal'
              Product-based payment MB WAY:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductMbway'
              Product-based payment Mercado Pago:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductMercadopago'
              Product-based payment Multibanco:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductMultibanco'
              Product-based payment OXXO:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductOxxo'
              Product-based payment Pay by Bank:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductOpenbanking'
              Product-based payment Pix QR:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductPixQr'
              Product-based payment Pix Automático:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductPixAutomatico'
              Product-based payment Przelewy24:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductPrzelewy24'
              Product-based payment PSE:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductPse'
              Product-based payment Sencillito:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductSencillito'
              Product-based payment Servipag:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductServipag'
              Product-based payment SmartPix:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductPix'
              Product-based payment UPI:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductUpi'
              Product-based payment Webpay:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductWebpay'
              Product-based payment WeChat Pay:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductWechatpay'
              Subscription payment PayPal:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentPaypal'
              Subscription payment Alipay:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentAlipay'
              Subscription payment Blik:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentBlik'
              Subscription payment GCash:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentGcash'
              Subscription payment MB WAY:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentMbway'
              Subscription payment Mercado Pago:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentMercadopago'
              Subscription payment Multibanco:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentMultibanco'
              Subscription payment Pix QR:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentPixQr'
              Subscription payment Pix Automático:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentPixAutomatico'
              Subscription payment SmartPix:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentPix'
              Subscription payment UPI:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentUpi'
              Subscription payment WeChat Pay:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentWechatpay'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ResponseApmSuccess'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                PayPal:
                  $ref: '#/components/examples/ExampleApmResponsePaypal'
                Alipay:
                  $ref: '#/components/examples/ExampleApmResponseAlipay'
                Blik:
                  $ref: '#/components/examples/ExampleApmResponseBlik'
                Bizum:
                  $ref: '#/components/examples/ExampleApmResponseBizum'
                Boleto:
                  $ref: '#/components/examples/ExampleApmResponseBoleto'
                Efecty:
                  $ref: '#/components/examples/ExampleApmResponseEfecty'
                GCash:
                  $ref: '#/components/examples/ExampleApmResponseGcash'
                Ideal:
                  $ref: '#/components/examples/ExampleApmResponseIdeal'
                MB WAY:
                  $ref: '#/components/examples/ExampleApmResponseMbway'
                Mercado Pago:
                  $ref: '#/components/examples/ExampleApmResponseMercadopago'
                Multibanco:
                  $ref: '#/components/examples/ExampleApmResponseMultibanco'
                OXXO:
                  $ref: '#/components/examples/ExampleApmResponseOxxo'
                Pay by Bank:
                  $ref: '#/components/examples/ExampleApmResponseOpenbanking'
                Pix QR:
                  $ref: '#/components/examples/ExampleApmResponsePixQr'
                Pix Automático:
                  $ref: '#/components/examples/ExampleApmResponsePixAutomatico'
                Przelewy24:
                  $ref: '#/components/examples/ExampleApmResponsePrzelewy24'
                PSE:
                  $ref: '#/components/examples/ExampleApmResponsePse'
                Sencillito:
                  $ref: '#/components/examples/ExampleApmResponseSencillito'
                Servipag:
                  $ref: '#/components/examples/ExampleApmResponseServipag'
                SmartPix:
                  $ref: '#/components/examples/ExampleApmResponsePix'
                UPI:
                  $ref: '#/components/examples/ExampleApmResponseUpi'
                Webpay:
                  $ref: '#/components/examples/ExampleApmResponseWebpay'
                WeChat Pay:
                  $ref: '#/components/examples/ExampleApmResponseWechatpay'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error X.XX:
                  $ref: '#/components/examples/ExampleMainResponseError'
  /v1/recurring:
    servers:
      - url: https://gate.solidgate.com/api
        description: APM payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: make-apm-recurring
      summary: Recurring
      description: |-
        Initiate a token-based <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/#recurring" target="_blank">recurring</a> payment refers to an automatic billing applied to a customer's payment method at predetermined intervals. 

        <blockquote>
          <p>This process involves securely storing a token representing the customer's payment details and using it for subsequent transactions without requiring input each time.</p>
        </blockquote>
      tags:
        - Alternative payment methods
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/RequestApmRecurringDiscriminator'
                - $ref: '#/components/schemas/RequestApmRecurringOneTimeProductDiscriminator'
                - $ref: '#/components/schemas/RequestApmRecurringSubscriptionDiscriminator'
            examples:
              PayPal:
                $ref: '#/components/examples/ExampleApmRequestRecurringPaypal'
              Alipay:
                $ref: '#/components/examples/ExampleApmRequestRecurringAlipay'
              Blik:
                $ref: '#/components/examples/ExampleApmRequestRecurringBlik'
              GCash:
                $ref: '#/components/examples/ExampleApmRequestRecurringGcash'
              MB WAY:
                $ref: '#/components/examples/ExampleApmRequestRecurringMbway'
              Mercado Pago:
                $ref: '#/components/examples/ExampleApmRequestRecurringMercadopago'
              Pix Automático:
                $ref: '#/components/examples/ExampleApmRequestRecurringPixAutomatico'
              SmartPix:
                $ref: '#/components/examples/ExampleApmRequestRecurringPix'
              UPI:
                $ref: '#/components/examples/ExampleApmRequestRecurringUpi'
              WeChat Pay:
                $ref: '#/components/examples/ExampleApmRequestRecurringWechatpay'
              Product-based payment PayPal:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductRecurringPaypal'
              Product-based payment Alipay:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductRecurringAlipay'
              Product-based payment Blik:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductRecurringBlik'
              Product-based payment GCash:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductRecurringGcash'
              Product-based payment MB WAY:
                $ref: '#/components/examples/ExampleApmRequestRecurringOneTimeProductMbway'
              Product-based payment Mercado Pago:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductRecurringMercadopago'
              Product-based payment UPI:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductRecurringUpi'
              Product-based payment Pix Automático:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductRecurringPixAutomatico'
              Product-based payment SmartPix:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductRecurringPix'
              Product-based payment WeChat Pay:
                $ref: '#/components/examples/ExampleApmRequestOneTimeProductRecurringWechatpay'
              Subscription payment PayPal:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentRecurringPaypal'
              Subscription payment Alipay:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentRecurringAlipay'
              Subscription payment Blik:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentRecurringBlik'
              Subscription payment GCash:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentRecurringGcash'
              Subscription payment MB WAY:
                $ref: '#/components/examples/ExampleApmRequestRecurringSubscriptionPaymentMbway'
              Subscription payment Mercado Pago:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentRecurringMercadopago'
              Subscription payment Pix Automático:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentRecurringPixAutomatico'
              Subscription payment SmartPix:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentRecurringPix'
              Subscription payment UPI:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentRecurringUpi'
              Subscription payment WeChat Pay:
                $ref: '#/components/examples/ExampleApmRequestSubscriptionPaymentRecurringWechatpay'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseApmRecurring'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleApmResponseRecurring'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error X.XX:
                  $ref: '#/components/examples/ExampleMainResponseError'
  /v1/recurring-token/cancel:
    servers:
      - url: https://gate.solidgate.com/api
        description: APM payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: revoke-apm-recurring-token
      summary: Revoke token
      description: |-
        Request to <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/#revoke-token" target="_blank">revoke</a> a recurring token for alternative payment methods.

        <blockquote>
          <p>Available for tokens initiated with <code>payment_method</code> <code>alipay</code> or <code>wechatpay</code>.</p>
        </blockquote>
      tags:
        - Alternative payment methods
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestApmRecurringTokenCancellation'
            examples:
              Request:
                $ref: '#/components/examples/ExampleApmRequestRecurringTokenCancellation'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseApmRecurringTokenCancellation'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseApmRecurringTokenCancellationError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleApmResponseRecurringTokenCancellationSuccess'
                Error 1.01 Authentication failed:
                  $ref: '#/components/examples/ExampleApmResponseRecurringTokenCancellationErrorAuthFailed'
                Error 2.01 Token not found:
                  $ref: '#/components/examples/ExampleApmResponseRecurringTokenCancellationErrorTokenNotFound'
                Error 2.01 Unsupported method:
                  $ref: '#/components/examples/ExampleApmResponseRecurringTokenCancellationErrorUnsupportedMethod'
                Error 2.01 Token already cancelled:
                  $ref: '#/components/examples/ExampleApmResponseRecurringTokenCancellationErrorAlreadyCancelled'
                Error 2.01 Cancellation already processing:
                  $ref: '#/components/examples/ExampleApmResponseRecurringTokenCancellationErrorAlreadyProcessing'
                Error 2.01 Cancellation is already concurrently processing:
                  $ref: '#/components/examples/ExampleApmResponseRecurringTokenCancellationErrorAlreadyConcurrentlyProcessing'
                Error 2.01 Cancellation failed:
                  $ref: '#/components/examples/ExampleApmResponseRecurringTokenCancellationErrorFailed'
  /v1/refund:
    servers:
      - url: https://gate.solidgate.com/api
        description: APM payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: refund-apm-order
      summary: Refund
      description: |-
        Initiate a <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/#refund" target="_blank">refund</a> request to return funds for successfully processed orders.

        <blockquote>
        <p>It is important to note that, for instance, refunds might not be accessible or could be restricted when using alternative cash-based payment methods.</p>
        </blockquote>
      tags:
        - Alternative payment methods
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestApmRefund'
            examples:
              Refund:
                $ref: '#/components/examples/ExampleApmRequestRefund'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseApmRefund'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleApmResponseRecurring'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
  /v1/status:
    servers:
      - url: https://gate.solidgate.com/api
        description: APM payments Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: get-status-apm-order
      summary: Check order status
      description: Request for receiving current order status. The key benefit is that it allows merchants to efficiently monitor and manage their payments by providing comprehensive information about the order's status, payment method, transaction details, and customer information.
      tags:
        - Alternative payment methods
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestApmCheckOrderStatus'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseApmCheckOrderStatus'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseApmError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleApmResponseCheckOrderStatus'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Order not found:
                  $ref: '#/components/examples/ExampleMainResponseErrorOrderNotFound'
                Error X.XX:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
  /products:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    post:
      operationId: create-product
      description: |-
        This method allows merchants to <a href="https://docs.solidgate.com/billing/product-and-price-management/#create-product" target="_blank">create new products</a> by providing the required details.

        <blockquote>
          <p>Products created via API cannot be edited in the Solidgate Hub unless a default price is set. To add a default price and enable editing, use the <a href="https://api-docs.solidgate.com/#tag/Products-and-prices/operation/create-product-price" target="_blank">create product price</a> operation.</p>
        </blockquote>
      summary: Create product
      tags:
        - Products and prices
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchant'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/RequestBillingProductCreateOneTime'
                - $ref: '#/components/schemas/RequestBillingProductCreateSubscription'
            examples:
              Product-based payment:
                $ref: '#/components/examples/ExampleBillingRequestProductCreateOneTime'
              Subscription payment:
                $ref: '#/components/examples/ExampleBillingRequestProductCreateSubscription'
      responses:
        '200':
          description: Product has been created
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ResponseBillingProductCreateOneTime'
                  - $ref: '#/components/schemas/ResponseBillingProductCreateSubscription'
              examples:
                Product-based payment:
                  $ref: '#/components/examples/ExampleBillingResponseProductCreateOneTime'
                Subscription payment:
                  $ref: '#/components/examples/ExampleBillingResponseProductCreateSubscription'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnprocessableEntityError'
    get:
      operationId: get-products
      summary: Get product list
      description: By using this method, merchants can find products and <a href="https://docs.solidgate.com/billing/product-and-price-management/#retrieve-product-details" target="_blank">retrieve their details</a> by applying filters such as product identifier, status, trial availability, and sorting criteria with pagination support.
      tags:
        - Products and prices
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchant'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - in: query
          name: filter[id]
          schema:
            type: string
            example: ac43b415-5522-4373-b026-a365462f9657,xx33b415-5522-4373-b026-a365462f9657
            maxLength: 100
          description: Specify the comma-separated ids of products.
          allowReserved: true
        - in: query
          name: filter[status]
          schema:
            type: string
            description: Specify the status of products to retrieve. Use `active`, `disabled`, or `archived` to return products that match the needed status.
            enum:
              - active
              - disabled
              - archived
          allowReserved: true
        - in: query
          name: filter[has_trial]
          schema:
            type: boolean
            description: Specify whether the products should have a trial available. Use `true` to retrieve products with a trial option.
          allowReserved: true
        - in: query
          name: pagination[limit]
          schema:
            description: Specify the number of items to return.
            type: integer
            example: 10
            default: 10
            minimum: 1
            maximum: 100
          allowReserved: true
        - in: query
          name: pagination[offset]
          schema:
            description: Specify the number of items to skip before starting to collect the result set.
            type: integer
            example: 10
            default: 0
            minimum: 0
          allowReserved: true
      responses:
        '200':
          description: Product data
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ResponseBillingProductCreateListOneTime'
                  - $ref: '#/components/schemas/ResponseBillingProductCreateListSubscription'
              examples:
                Product-based payment:
                  $ref: '#/components/examples/ExampleBillingResponseProductListOneTime'
                Subscription payment:
                  $ref: '#/components/examples/ExampleBillingResponseProductListSubscription'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
  /products/{product_id}:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    patch:
      operationId: update-product
      summary: Update product
      description: |-
        This method <a href="https://docs.solidgate.com/billing/product-and-price-management/#edit-product" target="_blank">updates the existing product</a> with specified details and returns the updated product information.

        <blockquote>
          <p>Recurring products can only be updated when all associated subscriptions are in <code>expired</code> status. Products without subscriptions can be updated without restrictions.</p>
        </blockquote>
      tags:
        - Products and prices
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchant'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - in: path
          name: product_id
          required: true
          schema:
            type: string
            description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
            example: ac43b415-5522-4373-b026-a365462f9657
            format: uuid
            maxLength: 36
            minLength: 36
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/RequestBillingProductUpdateOneTime'
                - $ref: '#/components/schemas/RequestBillingProductUpdateSubscription'
            examples:
              Product-based payment:
                $ref: '#/components/examples/ExampleBillingRequestProductUpdateOneTime'
              Subscription payment:
                $ref: '#/components/examples/ExampleBillingRequestProductUpdateSubscription'
      responses:
        '200':
          description: Product has been updated
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ResponseBillingProductUpdateOneTime'
                  - $ref: '#/components/schemas/ResponseBillingProductUpdateSubscription'
              examples:
                Product-based payment:
                  $ref: '#/components/examples/ExampleBillingResponseProductUpdateOneTime'
                Subscription payment:
                  $ref: '#/components/examples/ExampleBillingResponseProductUpdateSubscription'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnprocessableEntityError'
    get:
      operationId: get-product-by-id
      summary: Get product by ID
      description: This method allows merchants to <a href="https://docs.solidgate.com/billing/product-and-price-management/#retrieve-product-details" target="_blank">obtain the existing product</a> by its identifier.
      tags:
        - Products and prices
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchant'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - in: path
          name: product_id
          required: true
          schema:
            description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
            example: ac43b415-5522-4373-b026-a365462f9657
            format: uuid
            maxLength: 36
            minLength: 36
      responses:
        '200':
          description: Product information
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ResponseBillingProductGetByIdOneTime'
                  - $ref: '#/components/schemas/ResponseBillingProductGetByIdSubscription'
              examples:
                Product-based payment:
                  $ref: '#/components/examples/ExampleBillingResponseProductGetByIdOneTime'
                Subscription payment:
                  $ref: '#/components/examples/ExampleBillingResponseProductGetByIdSubscription'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
  /products/{product_id}/archive:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    post:
      operationId: archive-product
      summary: Archive product
      description: |-
        By using this method, merchants can <a href="https://docs.solidgate.com/billing/product-and-price-management/#archive-product" target="_blank">archive products</a>.

        <blockquote>
          <p>Note that the archived product cannot be restored or added to new subscriptions. Existing subscriptions with the archived product remain active until cancelled.</p>
        </blockquote>
      tags:
        - Products and prices
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchant'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - in: path
          name: product_id
          required: true
          schema:
            type: string
            description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
            example: ac43b415-5522-4373-b026-a365462f9657
            format: uuid
            maxLength: 36
            minLength: 36
      responses:
        '200':
          description: Product has been archived
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ResponseBillingProductArchiveOneTime'
                  - $ref: '#/components/schemas/ResponseBillingProductArchiveSubscription'
              examples:
                Product-based payment:
                  $ref: '#/components/examples/ExampleBillingResponseProductArchiveOneTime'
                Subscription payment:
                  $ref: '#/components/examples/ExampleBillingResponseProductArchiveSubscription'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnprocessableEntityError'
  /products/{product_id}/prices:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    post:
      operationId: create-product-price
      summary: Create product price
      description: By using this method, merchants can <a href="https://docs.solidgate.com/billing/product-and-price-management/#create-price" target="_blank">create a new product price</a> with specified details and retrieve the created product price information.
      tags:
        - Products and prices
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchant'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - name: product_id
          in: path
          schema:
            type: string
            description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
            example: ac43b415-5522-4373-b026-a365462f9657
            format: uuid
            maxLength: 36
            minLength: 36
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingProductPriceCreate'
      responses:
        '200':
          description: Product price has been created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingProductPriceCreate'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnprocessableEntityError'
    get:
      operationId: get-product-prices
      summary: Get product prices
      description: This method allows merchants to <a href="https://docs.solidgate.com/billing/product-and-price-management/#retrieve-price-details" target="_blank">retrieve product prices</a> based on the specified filter criteria and pagination settings, returning the results along with pagination information.
      tags:
        - Products and prices
      parameters:
        - schema:
            type: string
          in: header
          name: merchant
          required: true
          description: Unique <a href="https://docs.solidgate.com/payments/integrate/access-to-api/#retrieve-your-credentials" target="_blank">public key</a> provided upon registration and must be shared for identification purposes.
          example: api_pk_7b197...ba108f842
        - schema:
            type: string
          in: header
          name: signature
          required: true
          description: <a href="https://docs.solidgate.com/payments/integrate/access-to-api/#generate-signature" target="_blank">Signature</a> of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server.
          example: M2E3OTkyNzcz...xMmExODI4
        - in: path
          name: product_id
          required: true
          schema:
            type: string
            description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
            example: ac43b415-5522-4373-b026-a365462f9657
            format: uuid
            maxLength: 36
            minLength: 36
        - in: query
          name: filter[currency]
          schema:
            type: string
            example: EUR, USD
          description: Specify the comma-separated currencies.
          allowReserved: true
        - in: query
          name: filter[country]
          schema:
            type: string
            description: Specify the country <a href="https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes" target="_blank">code</a>.
            format: iso_code_a3
            example: USA
            maxLength: 3
            minLength: 3
          allowReserved: true
        - in: query
          name: pagination[limit]
          schema:
            type: integer
            example: 10
            default: 10
            minimum: 1
            maximum: 100
            description: Specify the number of items to return.
          allowReserved: true
        - in: query
          name: pagination[offset]
          schema:
            type: integer
            example: 10
            default: 0
            minimum: 0
            description: Specify the number of items to skip before starting to collect the result set.
          allowReserved: true
      responses:
        '200':
          description: Product price data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingProductPriceCreateList'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
  /products/prices/list:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    post:
      operationId: find-prices
      summary: Retrieve prices
      description: |-
        This method allows merchants to <a href="https://docs.solidgate.com/billing/product-and-price-management/#retrieve-price-details" target="_blank">retrieve prices</a> in bulk based on specified filter criteria with pagination settings.

        <blockquote>
          <ul>
            <li>Without filters, the request returns all prices in the merchant account.</li>
            <li>With filters, each filter field requires a value to avoid validation errors.</li>
          </ul>
        </blockquote>
      tags:
        - Products and prices
      parameters:
        - schema:
            type: string
          in: header
          name: merchant
          description: Unique <a href="https://docs.solidgate.com/payments/integrate/access-to-api/#retrieve-your-credentials" target="_blank">public key</a> provided upon registration and must be shared for identification purposes.
          example: api_pk_7b197...ba108f842
          required: true
        - schema:
            type: string
          in: header
          name: signature
          description: <a href="https://docs.solidgate.com/payments/integrate/access-to-api/#generate-signature" target="_blank">Signature</a> of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server.
          example: M2E3OTkyNzcz...xMmExODI4
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingRetrievePrices'
      responses:
        '200':
          description: Prices data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingRetrievePrices'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
  /products/{product_id}/prices/{product_price_id}:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    patch:
      operationId: update-product-price
      summary: Update product price
      description: |-
        By using this method, merchants can <a href="https://docs.solidgate.com/billing/product-and-price-management/#edit-price" target="_blank">update the existing product price</a>, providing the updated product price details.

        <blockquote>
          <p>Recurring products can only be updated when all associated subscriptions are in <code>expired</code> status. Products without subscriptions can be updated without restrictions.</p>
        </blockquote>
      tags:
        - Products and prices
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchant'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - in: path
          name: product_id
          required: true
          schema:
            type: string
            description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
            example: ac43b415-5522-4373-b026-a365462f9657
            format: uuid
            maxLength: 36
            minLength: 36
        - in: path
          name: product_price_id
          required: true
          schema:
            description: Unique product price identifier.
            type: string
            format: uuid
            example: fa43b415-5522-4373-b026-a365562f9649
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingProductPriceUpdate'
      responses:
        '200':
          description: Product price has been updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingProductPriceUpdate'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
  /transactional:
    servers:
      - url: https://reports.solidgate.com/api/v1/tax
        description: Reports Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: tax-transactional
      summary: Transactional tax
      description: |-
        The <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#tax-reports" target="_blank">transactional tax report</a> aggregates every tax-relevant transaction into one file, combining order and product identifiers, channel and legal entity, processing amounts and currency, full tax breakdown, include type, rate, taxable and tax amounts, location, and BIN/IP geography for delivering a concise, high-level view of liabilities across entities and jurisdictions.

        In a successful response, you receive a link to the file `report_url`.

        <blockquote>
          <p>The tax data are in a CSV file, which can be found at the link.</p>
        </blockquote>
      tags:
        - Taxes
      requestBody:
        content:
          application/json:
            schema:
              properties:
                date_from:
                  type: string
                  description: Start datetime for the report stated in UTC+0.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-01-15 11:00:00'
                date_to:
                  type: string
                  description: End datetime for the report stated in UTC+0.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-06-20 13:00:00'
                environment:
                  type: string
                  enum:
                    - live
                    - sandbox
                    - all
                  default: all
                  description: |-
                    Environment for the transactional tax report.
                    - `live` – live environment, containing live data
                    - `sandbox` – testing environment with non-live data
                    - `all` – includes data from both live and sandbox environments
                  example: all
              required:
                - date_from
                - date_to
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseBillingReportTaxTransactional'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  value:
                    report_url: https://reports.solidgate.com/api/v1/tax/transactional/report/tax_transactional_250702_140728/download
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
  /transactional/report/{report_id}/download:
    servers:
      - url: https://reports.solidgate.com/api/v1/tax
        description: Reports Live API
    parameters:
      - name: report_id
        in: path
        description: |-
          Unique report identifier for download.

          <blockquote>
            <p>It follows the pattern [report_prefix] [date (yyMMdd)] [time (HHmmss)] [channel name].</p>
          </blockquote>
        required: true
        schema:
          type: string
          example: TAX_250702_140728_CHECKOUT
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    get:
      operationId: download-tax-transactional
      summary: Download transactional tax
      description: |-
        Retrieves a ready-generated <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#tax-reports" target="_blank">transactional tax</a> report CSV. 

        <blockquote>
          <p>Send the request and, if the file exists, you get a short-lived pre-signed S3 URL that immediately starts the download.</p>
        </blockquote>
      tags:
        - Taxes
      responses:
        '200':
          description: |-
            Request received

            <blockquote style="border-left: 4px solid #1d8126; margin-left: 20px;">
              <p style="color: #1d8126; margin-left: 6px;">Response either redirects to S3 for download or returns error object.</p>
            </blockquote>
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseBillingReportTaxTransactional'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleBillingResponseTaxTransactionalDownload'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
        '204':
          description: Report is not ready
        '302':
          description: Redirect to one-time S3 download report link
        '404':
          description: Report not found
        '410':
          description: Report unavailable (expired)
  /summary:
    servers:
      - url: https://reports.solidgate.com/api/v1/tax
        description: Reports Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: tax-summary
      summary: Summary tax
      description: |-
        The <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#tax-reports" target="_blank">summary tax report</a> aggregates your tax data into a single file, grouping figures by every unique combination of legal entity, tax location, and processing currency configured in your Solidgate account. It includes key metrics such as taxable turnover, calculated tax amount, and net revenue for each group, giving you a clear, high-level view of your liabilities across jurisdictions.

        In a successful response, you receive a link to the file `report_url`.

        <blockquote>
          <p>The tax data are in a CSV file, which can be found at the link.</p>
        </blockquote>
      tags:
        - Taxes
      requestBody:
        content:
          application/json:
            schema:
              properties:
                date_from:
                  type: string
                  description: Start datetime for the report stated in UTC+0.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-01-15 11:00:00'
                date_to:
                  type: string
                  description: End datetime for the report stated in UTC+0.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-06-20 13:00:00'
                environment:
                  type: string
                  enum:
                    - live
                    - sandbox
                    - all
                  default: all
                  description: |-
                    Environment for the summary tax report.
                    - `live` – live environment, containing live data
                    - `sandbox` – testing environment with non-live data
                    - `all` – includes data from both live and sandbox environments
                  example: all
              required:
                - date_from
                - date_to
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseBillingReportTaxSummary'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  value:
                    report_url: https://reports.solidgate.com/api/v1/tax/summary/report/tax_summary_250702_140728/download
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
  /summary/report/{report_id}/download:
    servers:
      - url: https://reports.solidgate.com/api/v1/tax
        description: Reports Live API
    parameters:
      - name: report_id
        in: path
        description: |-
          Unique report identifier for download.

          <blockquote>
            <p>It follows the pattern [report_prefix] [date (yyMMdd)] [time (HHmmss)] [channel name].</p>
          </blockquote>
        required: true
        schema:
          type: string
          example: TAX_250702_140728_CHECKOUT
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    get:
      operationId: download-tax-summary
      summary: Download summary tax
      description: |-
        Retrieves a ready-generated <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#tax-reports" target="_blank">summary tax</a> report CSV. 

        <blockquote>
          <p>Send the request and, if the file exists, you get a short-lived pre-signed S3 URL that immediately starts the download.</p>
        </blockquote>
      tags:
        - Taxes
      responses:
        '200':
          description: |-
            Request received

            <blockquote style="border-left: 4px solid #1d8126; margin-left: 20px;">
              <p style="color: #1d8126; margin-left: 6px;">Response either redirects to S3 for download or returns error object.</p>
            </blockquote>
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseBillingReportTaxSummary'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleBillingResponseTaxSummaryDownload'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
        '204':
          description: Report is not ready
        '302':
          description: Redirect to one-time S3 download report link
        '404':
          description: Report not found
        '410':
          description: Report unavailable (expired)
  /products/calculatePrice:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    post:
      operationId: calculate-product-price
      summary: Calculate product price
      description: |-
        This method allows merchants to calculate an estimated product price for a specific location.

        <blockquote>
          <p>Calculated prices returned by this endpoint are estimates. The final charged amount may differ at the time of billing due to product updates, tax changes, or other configuration changes.</p>
        </blockquote>
      tags:
        - Products and prices
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchant'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingProductPriceCalculate'
      responses:
        '200':
          description: Result of price calculation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingProductPriceCalculate'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleBillingResponseProductPriceCalculate'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnprocessableEntityError'
  /subscription/update:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: update-subscription
      summary: Update subscription
      description: By using this method, merchants can <a href="https://docs.solidgate.com/billing/manage-subscription/update-subscription/" target="_blank">update</a> an active subscription by modifying the trial period, applying a discount, or changing the product. It allows multiple changes in a single request for efficient subscription management and customer retention.
      tags:
        - Manage subscriptions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingSubscriptionUpdate'
      responses:
        '200':
          description: Subscription has been updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingSubscriptionUpdate'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnprocessableEntityError'
  /subscription/switch-subscription-product:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: switch-subscription-product
      summary: Switch product
      description: |-
        By using this method, merchants can <a href="https://docs.solidgate.com/billing/manage-subscription/switch-subscription-product/" target="_blank">update the product</a> in the active subscription with a new one. After the switch request is made, a callback confirms the update and includes the new subscription product. The updated settings take effect on the next billing date.

        <blockquote>
          <p>The switch is subject to <a href="https://docs.solidgate.com/billing/manage-subscription/switch-subscription-product/#product-price" target="_blank">conditions</a> related to currency and location compatibility between the current and new products.</p>
        </blockquote>
      tags:
        - Manage subscriptions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingSubscriptionProductSwitch'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - title: Success
                    type: object
                    properties:
                      status:
                        type: string
                        description: Product has been switched.
                        example: ok
                  - $ref: '#/components/schemas/ResponseBillingValidationError'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
  /subscription/status:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: get-subscription-status
      summary: Get subscription status
      description: By using this method, merchants can <a href="https://docs.solidgate.com/billing/manage-subscription/retrieve-subscription-data/" target="_blank">retrieve subscription data</a> by subscription identifier and obtain its details, such as the start date, status, and the information about the most recent invoice related to the subscription.
      tags:
        - Retrieve subscription data
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingSubscriptionStatus'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseBillingSubscriptionStatus'
                  - $ref: '#/components/schemas/ResponseBillingValidationError'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
  /subscription/list:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: retrieve-subscriptions-by-customer
      summary: Retrieve subscriptions by customer
      description: This method allows the merchant to <a href="https://docs.solidgate.com/billing/manage-subscription/retrieve-subscription-data/#by-customer-id" target="_blank">retrieve all subscriptions</a> and their statuses for the specific customer by the customer identifier.
      tags:
        - Retrieve subscription data
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingSubscriptionRetrieveCustomer'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseBillingSubscriptionRetrieveCustomer'
                  - $ref: '#/components/schemas/ResponseBillingValidationError'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
  /subscription/invoice/list:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: list-invoices-by-subscription-id
      summary: List invoices by subscription
      description: By using this method, merchants can <a href="https://docs.solidgate.com/billing/manage-subscription/retrieve-subscription-data/#list-invoices-by-subscription-id" target="_blank">get a list of invoices</a> related to a specific subscription.
      tags:
        - Retrieve subscription data
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingSubscriptionInvoiceListBySubscriptionID'
      responses:
        '200':
          description: List of invoices
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingSubscriptionInvoiceListBySubscriptionID'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
  /subscription/order/list:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: list-orders-by-invoice-id
      summary: List orders by invoice
      description: By using this method, merchants can <a href="https://docs.solidgate.com/billing/manage-subscription/retrieve-subscription-data/#list-orders-by-invoice-id" target="_blank">retrieve a list of orders</a> associated with a particular invoice.
      tags:
        - Retrieve subscription data
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingSubscriptionOrderListByInvoiceID'
      responses:
        '200':
          description: List of subscription orders
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingSubscriptionOrderListByInvoiceID'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
  /subscription/update-token:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    post:
      operationId: update-subscription-token
      summary: Update subscription token
      description: This method provides a mechanism for merchants to <a href="https://docs.solidgate.com/billing/manage-subscription/update-subscription-token/" target="_blank">update the payment token</a> when the customer's preferred payment method changes.
      tags:
        - Manage subscriptions
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchant'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingSubscriptionUpdateToken'
      responses:
        '200':
          description: Subscription token has been updated
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
              examples:
                Entity not found:
                  $ref: '#/components/examples/ExampleBillingResponseEntityNotFound'
  /subscriptions/{subscription_id}/pause-schedule:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
      - in: path
        schema:
          type: string
          format: uuid
          maxLength: 36
          minLength: 36
        name: subscription_id
        description: Unique subscription identifier.
        example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        required: true
    post:
      operationId: create-subscription-pause
      summary: Create subscription pause
      description: By using this method, merchants can <a href="https://docs.solidgate.com/billing/manage-subscription/pause-subscription/" target="_blank">schedule a subscription pause</a>, setting the specific start and end dates for the pause period.
      tags:
        - Manage subscriptions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingSubscriptionPauseCreate'
      responses:
        '200':
          description: Pause schedule has been created for subscription
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingSubscriptionPauseCreateUpdate'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnprocessableEntityError'
    patch:
      operationId: update-subscription-pause
      summary: Update subscription pause
      description: |-
        By using this method, merchants can <a href="https://docs.solidgate.com/billing/manage-subscription/pause-subscription/#manage-subscription-pause" target="_blank">modify</a> the existing pause schedule, including the possibility of adjusting the start and end dates of the pause period.

        <blockquote>
          <p>Note that if the subscription pause is active, only its end date can be updated, while an inactive pause allows for updates to both start and end dates.</p>
        </blockquote>
      tags:
        - Manage subscriptions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingSubscriptionPauseUpdate'
      responses:
        '200':
          description: Pause schedule has been changed for subscription
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingSubscriptionPauseCreateUpdate'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnprocessableEntityError'
    delete:
      operationId: delete-subscription-pause
      summary: Remove subscription pause
      description: This method provides a way to <a href="https://docs.solidgate.com/billing/manage-subscription/pause-subscription/#resume-a-subscription" target="_blank">delete the scheduled pause</a>, reverting the subscription to its previous active state or as specified.
      tags:
        - Manage subscriptions
      responses:
        '200':
          description: Pause schedule has been removed for subscription
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingSubscriptionPauseRemove'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnprocessableEntityError'
  /subscription/cancel:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: cancel-subscription
      summary: Cancel subscription
      description: By using this method, merchants can <a href="https://docs.solidgate.com/billing/manage-subscription/cancel-subscription/#by-subscription-id" target="_blank">cancel</a> the specific subscription by its subscription identifier.
      tags:
        - Manage subscriptions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingSubscriptionCancel'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - title: Success
                    type: object
                    properties:
                      status:
                        type: string
                        description: Subscription has been cancelled.
                        example: ok
                  - $ref: '#/components/schemas/ResponseBillingValidationError'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
  /subscription/cancel-by-customer:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: cancel-subscriptions-by-customer
      summary: Cancel subscriptions by customer
      description: By using this method, the merchant can <a href="https://docs.solidgate.com/billing/manage-subscription/cancel-subscription/#by-customer-id" target="_blank">cancel</a> all subscriptions for the specific customer.
      tags:
        - Manage subscriptions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingSubscriptionCancelCustomer'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - title: Success
                    type: object
                    properties:
                      status:
                        type: string
                        description: Subscription has been cancelled for the customer.
                        example: ok
                  - $ref: '#/components/schemas/ResponseBillingValidationError'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
  /subscription/restore:
    servers:
      - url: https://subscriptions.solidgate.com/api/v1
        description: Subscriptions Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: restore-subscription
      summary: Restore subscription
      description: By using this method, merchants can <a href="https://docs.solidgate.com/billing/manage-subscription/restore-subscription/" target="_blank">restore</a> the specific subscription of their customer in case it was cancelled.
      tags:
        - Manage subscriptions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingSubscriptionRestore'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - title: Success
                    type: object
                    properties:
                      status:
                        type: string
                        description: Subscription has been restored.
                        example: ok
                  - $ref: '#/components/schemas/ResponseBillingValidationError'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingUnauthorized'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAccessDenied'
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBillingEntityNotFound'
  /card-orders:
    servers:
      - url: https://reports.solidgate.com/api/v1
        description: Reports Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: retrieve-card-orders
      summary: Card orders
      description: |-
        The <a href="https://docs.solidgate.com/reporting/card-orders/" target="_blank">report</a> provides essential data for merchants, including transaction details, customer information, and technical insights, facilitating comprehensive order tracking, financial reconciliation, and enhanced operational and marketing strategies.

        <blockquote>
          <p>This report uses the <code>updated_at</code> as the default parameter for unloading data, which reflects the latest update to card orders.</p>
        </blockquote>
      tags:
        - Reports
      requestBody:
        content:
          application/json:
            schema:
              type: object
              allOf:
                - type: object
                  properties:
                    filter:
                      default: updated_at
                - $ref: '#/components/schemas/RequestReportsGeneral'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseReportsCardOrders'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleReportsResponseCardOrders'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
  /apm-orders:
    servers:
      - url: https://reports.solidgate.com/api/v1
        description: Reports Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: retrieve-apm-orders
      summary: APM orders
      description: |-
        The <a href="https://docs.solidgate.com/reporting/apm-orders/" target="_blank">report</a> is essential for merchants using alternative payment methods, offering comprehensive transaction details, including order IDs, statuses, amounts, customer information, crucial for a complete understanding of <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APM</a> transaction dynamics.

        <blockquote>
          <p>This report uses the <code>updated_at</code> as the default parameter for unloading data, indicating the latest update to the APM orders.</p>
        </blockquote>
      tags:
        - Reports
      requestBody:
        content:
          application/json:
            schema:
              type: object
              allOf:
                - type: object
                  properties:
                    filter:
                      default: updated_at
                - $ref: '#/components/schemas/RequestReportsGeneral'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseReportsApmOrders'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleReportsResponseApmOrders'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
  /subscriptions:
    servers:
      - url: https://reports.solidgate.com/api/v1
        description: Reports Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: retrieve-subscriptions
      summary: Subscriptions
      description: |-
        The <a href="https://docs.solidgate.com/reporting/subscriptions/" target="_blank">report</a> offers a comprehensive overview for merchants, detailing customer subscriptions, payment methods, key customer data, and associated invoices, which are important for managing recurring revenues, customer retention, and informed decision-making in subscription-based businesses.

        <blockquote>
          <p>The <code>updated_at</code> parameter is used when unloading subscription data, indicating the most recent update to a subscription.</p>
        </blockquote>
      tags:
        - Reports
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    filter:
                      default: updated_at
                - $ref: '#/components/schemas/RequestReportsGeneral'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseReportsSubscriptions'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleReportsResponseSubscriptions'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
  /card-orders/chargebacks:
    servers:
      - url: https://reports.solidgate.com/api/v1
        description: Reports Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: retrieve-card-chargebacks
      summary: Chargebacks
      description: |-
        The <a href="https://docs.solidgate.com/reporting/chargebacks/" target="_blank">report</a> is essential for merchants, providing exhaustive insights into each chargeback, including identifiers, dates, types, amounts, reasons, and related original order details, which is crucial for understanding <a href="https://docs.solidgate.com/risks/chargebacks/" target="_blank">chargeback</a> patterns, enhancing dispute resolution, and fraud prevention.

        <blockquote>
          <p>Chargeback information is unloaded using the <code>updated_at</code> as the default parameter, which reflects the date when the latest chargeback flow was created.</p>
        </blockquote>
      tags:
        - Reports
      requestBody:
        content:
          application/json:
            schema:
              type: object
              allOf:
                - type: object
                  properties:
                    filter:
                      default: updated_at
                - $ref: '#/components/schemas/RequestReportsGeneral'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseReportsChargebacks'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleReportsResponseChargebacks'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
  /apm-orders/paypal-disputes:
    servers:
      - url: https://reports.solidgate.com/api/v1
        description: Reports Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: retrieve-apm-paypal-disputes
      summary: PayPal disputes
      description: |-
        The <a href="https://docs.solidgate.com/reporting/paypal-disputes/" target="_blank">report</a> is crucial, offering detailed insights on each PayPal dispute and lifecycle stage. These details are essential for effective <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/" target="_blank">dispute management</a> and enhancing customer satisfaction.

        <blockquote>
          <p>This report uses the <code>created_at</code> as the default parameter for unloading data.</p>
        </blockquote>
      tags:
        - Reports
      requestBody:
        content:
          application/json:
            schema:
              type: object
              allOf:
                - type: object
                  properties:
                    filter:
                      default: created_at
                - $ref: '#/components/schemas/RequestReportsGeneral'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseReportsPaypalDisputes'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleReportsResponsePaypalDisputes'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
  /prevention_alerts:
    servers:
      - url: https://reports.solidgate.com/api/v1
        description: Reports Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: prevention-alerts-by-date
      summary: Prevention alerts
      description: |-
        The <a href="https://docs.solidgate.com/reporting/prevention-alerts/" target="_blank">report</a> retrieves data to identify and resolve potential issues, thereby preventing the generation of alerts.

        <blockquote>
          <p>This report uses the <code>created_at</code> as the default parameter for unloading data.</p>
          <p>In a successful response, the <code>report_url</code> field will contain a link to the file.</p>
        </blockquote>
      tags:
        - Reports
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - date_from
                - date_to
              properties:
                filter:
                  type: string
                  description: Filtering criteria for the report data.
                  default: created_at
                  enum:
                    - updated_at
                    - created_at
                  example: created_at
                date_from:
                  type: string
                  description: Start datetime for the report stated in UTC+0.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-08-15 11:00:00'
                date_to:
                  type: string
                  description: End datetime for the report stated in UTC+0.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-09-20 13:00:00'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseReportsPreventionAlerts'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  value:
                    report_url: https://reports.solidgate.com/api/v1/prevention_alerts/report/prevent_report_240808_143924_test/download
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
  /prevention_alerts/report/{report_id}/download:
    servers:
      - url: https://reports.solidgate.com/api/v1
        description: Reports Live API
    parameters:
      - name: report_id
        in: path
        description: |-
          Unique report identifier for download.

          <blockquote>
            <p>It follows the pattern [report_prefix] [date (yyMMdd)] [time (HHmmss)] [channel name].</p>
          </blockquote>
        required: true
        schema:
          type: string
          example: PREVENT_250702_140728_CHECKOUT
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    get:
      operationId: download-prevention-alerts
      summary: Download prevention alerts
      description: |-
        The <a href="https://docs.solidgate.com/reporting/prevention-alerts/" target="_blank">report</a> offering detailed information on prevention alerts. It provides insights into each alert, including unique identifiers, alert types, amounts, outcomes, and the alert generation timeline.

        <blockquote>
          <p>The report unloads data based on the date range parameters that corresponds to the date the operation was executed.</p>
          <p>In a successful response, you will be redirected to S3 to download the file.</p>
        </blockquote>
      tags:
        - Reports
      responses:
        '200':
          description: |-
            Request received

            <blockquote style="border-left: 4px solid #1d8126; margin-left: 20px;">
              <p style="color: #1d8126; margin-left: 6px;">Response either redirects to S3 for download or returns error object.</p>
            </blockquote>
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseReportsPreventionAlerts'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleReportsResponsePreventionAlertsDownload'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
        '204':
          description: Report is not ready
        '302':
          description: Redirect to one-time S3 download report link
        '404':
          description: Report not found
        '410':
          description: Report unavailable (expired)
  /card-orders/fraud-alerts:
    servers:
      - url: https://reports.solidgate.com/api/v1
        description: Reports Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: retrieve-card-fraud-alerts
      summary: Card fraud alerts
      description: |-
        The <a href="https://docs.solidgate.com/reporting/card-fraud-alerts/" target="_blank">report</a> is vital for merchants, providing detailed <a href="https://docs.solidgate.com/risks/fraud/" target="_blank">fraud</a>-related information such as order IDs, amounts, and timings, along with specific fraud types and reason codes, crucial for swiftly identifying, analyzing, and formulating effective strategies to enhance transaction security.

        <blockquote>
          <p>The <code>created_at</code> as the default parameter is used to unload fraud alert data. It specifies the exact time when a fraud alert was created.</p>
        </blockquote>
      tags:
        - Reports
      requestBody:
        content:
          application/json:
            schema:
              type: object
              allOf:
                - type: object
                  properties:
                    filter:
                      default: created_at
                - $ref: '#/components/schemas/RequestReportsGeneral'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseReportsFraudAlerts'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleReportsResponseFraudAlerts'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
  /financial_entries:
    servers:
      - url: https://reports.solidgate.com/api/v1/finance
        description: Reports Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: financial-entries-by-date
      summary: Financial entries by date range
      description: |-
        In a successful response, you will receive a link to the file `report_url`.

        <blockquote>
            <p>The <a href="https://docs.solidgate.com/finance/financial-reports/financial-entries/" target="_blank">financial data</a> are in a CSV file, which can be found at the link. Data is available for export from the <strong>July 2022</strong>.</p>
        </blockquote>
      tags:
        - Reports
      requestBody:
        content:
          application/json:
            schema:
              properties:
                date_from:
                  type: string
                  description: Start datetime for the report stated in UTC+0.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-08-15 11:00:00'
                date_to:
                  type: string
                  description: End datetime for the report stated in UTC+0.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-09-20 13:00:00'
                filter:
                  type: string
                  enum:
                    - created_at
                    - accounting_date
                    - transaction_datetime_utc
                    - transaction_datetime_provider
                  default: created_at
                  description: |-
                    Date field to filter the report by.
                    - `created_at` - date and time when the record was created
                    - `accounting_date` – determines the settlement or invoice inclusion date
                    - `transaction_datetime_utc` – transaction or fee date in UTC
                    - `transaction_datetime_provider` – transaction or fee date in provider's local timezone
                  example: created_at
              required:
                - date_from
                - date_to
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseReportsFinancialEntries'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  value:
                    report_url: https://reports.solidgate.com/api/v1/finance/financial_entries/report/fin_220808_143924_test/download
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
  /financial_entries/report/{report_id}/download:
    servers:
      - url: https://reports.solidgate.com/api/v1/finance
        description: Reports Live API
    parameters:
      - name: report_id
        in: path
        description: |-
          Unique report identifier for download.

          <blockquote>
            <p>It follows the pattern [report_prefix] [date (yyMMdd)] [time (HHmmss)] [channel name].</p>
          </blockquote>
        required: true
        schema:
          type: string
          example: FIN_250702_140728_CHECKOUT
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    get:
      operationId: download-financial-entries
      summary: Download financial entries
      description: |-
        The <a href="https://docs.solidgate.com/finance/financial-reports/financial-entries/" target="_blank">report</a> offers an extensive overview of <a href="https://docs.solidgate.com/finance/financial-reports/financial-entries/" target="_blank">financial transactions</a>, detailing financial record IDs, order and transaction IDs, dates, amounts, currencies, payment methods, and geographical data essential for comprehensive financial analysis and management.

        <blockquote>
          <p>The report unloads data based on the <code>created_at + 4 hours</code> parameter, which corresponds to the date the operation was executed.</p>
          <p>In a successful response, you will be redirected to S3 to download the file.</p>
        </blockquote>
      tags:
        - Reports
      responses:
        '200':
          description: |-
            Request received

            <blockquote style="border-left: 4px solid #1d8126; margin-left: 20px;">
              <p style="color: #1d8126; margin-left: 6px;">Response either redirects to S3 for download or returns error object.</p>
            </blockquote>
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseReportsFinancialEntries'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleReportsResponseFinancialEntriesDownload'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
        '204':
          description: Report is not ready
        '302':
          description: Redirect to one-time S3 download report link
        '404':
          description: Report not found
        '410':
          description: Report unavailable (expired)
  /routing/events:
    servers:
      - url: https://reports.solidgate.com/api/v1
        description: Reports Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: routing-events-by-date
      summary: Routing events
      description: |-
        The <a href="https://docs.solidgate.com/orchestration/routing/manage-routing/#track-routing" target="_blank">report</a> provides a comprehensive view of routing decisions and execution flow for orders processed through routing configurations.

        It captures the complete sequence of routing events for each transaction, including selected steps, skipped steps with reasons, 3DS decisions, and connector account details.

        <blockquote>
          <p>This report uses the <code>created_at</code> as the default parameter for unloading data. The date range between <code>date_from</code> and <code>date_to</code> must not exceed <strong>36 days</strong>.</p>
          <p>In a successful response, the <code>report_url</code> field will contain a link to the file.</p>
        </blockquote>
      tags:
        - Reports
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - date_from
                - date_to
                - channel_id
              properties:
                filter:
                  type: string
                  description: Filtering criteria for the report data.
                  default: created_at
                  enum:
                    - updated_at
                    - created_at
                  example: created_at
                date_from:
                  type: string
                  format: date-time
                  description: Start datetime for the report in UTC+0 (`YYYY-MM-DD HH:MM:SSZ`).
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}Z$
                  example: '2025-08-15 11:00:00Z'
                date_to:
                  type: string
                  format: date-time
                  description: End datetime for the report in UTC+0 (`YYYY-MM-DD HH:MM:SSZ`).
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}Z$
                  example: '2025-09-20 13:00:00Z'
                channel_id:
                  type: string
                  description: Identifier of the channel the routing configuration is bound to.
                  example: ch_01HV9Z2K3M4N5P6Q7R8S9T0U1V
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseReportsRoutingV2Report'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  value:
                    report_url: https://reports.solidgate.com/api/v1/routing/events/report/routing_240808_143924_test/download
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
  /routing/events/report/{report_id}/download:
    servers:
      - url: https://reports.solidgate.com/api/v1
        description: Reports Live API
    parameters:
      - name: report_id
        in: path
        description: |-
          Unique report identifier for download.

          <blockquote>
            <p>It follows the pattern [report_prefix] [date (yyMMdd)] [time (HHmmss)] [channel name].</p>
          </blockquote>
        required: true
        schema:
          type: string
          example: ROUTING_250702_140728_CHECKOUT
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    get:
      operationId: download-routing-events
      summary: Download routing events
      description: |-
        The <a href="https://docs.solidgate.com/orchestration/routing/manage-routing/#track-routing" target="_blank">report</a> offers detailed information on routing events. It provides insights into each event, including unique identifiers, configuration and version, route and step details, 3DS decisions, and connector account selected for processing.

        <blockquote>
          <p>The report unloads data based on the date range parameters that corresponds to the date the operation was executed.</p>
          <p>In a successful response, you will be redirected to S3 to download the file.</p>
        </blockquote>
      tags:
        - Reports
      responses:
        '200':
          description: |-
            Request received

            <blockquote style="border-left: 4px solid #1d8126; margin-left: 20px;">
              <p style="color: #1d8126; margin-left: 6px;">Response either redirects to S3 for download or returns error object.</p>
            </blockquote>
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseReportsRoutingV2Report'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleReportsResponseRoutingV2ReportDownload'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
        '204':
          description: Report is not ready
        '302':
          description: Redirect to one-time S3 download report link
        '404':
          description: Report not found
        '410':
          description: Report unavailable (expired)
  /fraud-prevention-list-items/create:
    servers:
      - url: https://risks.solidgate.com/api/v1
        description: Risks management API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: fraud-prevention-list-items-create
      summary: Create fraud prevention list items
      description: This method allows you to add new items to fraud prevention list linked to the merchant's account.
      tags:
        - Fraud prevention
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestRisksFraudPreventionListItemsCreate'
            examples:
              Batch:
                $ref: '#/components/examples/ExampleRequestRisksFraudPreventionListItemsCreate'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseRisksFraudPreventionListItemsCreate'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleResponseRisksFraudPreventionListItemsCreate'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Fraud prevention is not enabled:
                  $ref: '#/components/examples/ExampleResponseErrorFraudPreventionNotEnabled'
                Error 2.01 Some fraud prevention list items are duplicated:
                  $ref: '#/components/examples/ExampleResponseErrorFraudPreventionListItemsDuplicated'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
  /fraud-prevention-list-items/list:
    servers:
      - url: https://risks.solidgate.com/api/v1
        description: Risks management API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: fraud-prevention-list-items-list
      summary: List fraud prevention list items
      description: This method retrieves existing fraud prevention list items linked to the merchant's account.
      tags:
        - Fraud prevention
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestRisksFraudPreventionListItemList'
            examples:
              Batch:
                $ref: '#/components/examples/ExampleRequestRisksFraudPreventionListItemList'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseRisksFraudPreventionListItemList'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleResponseRisksFraudPreventionListItemList'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Fraud prevention is not enabled:
                  $ref: '#/components/examples/ExampleResponseErrorFraudPreventionNotEnabled'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
  /fraud-prevention-list-items/{id}:
    servers:
      - url: https://risks.solidgate.com/api/v1
        description: Risks management API
    parameters:
      - name: id
        in: path
        description: Unique identifier of the fraud prevention list item to be deleted.
        required: true
        schema:
          type: string
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    delete:
      operationId: fraud-prevention-list-items-delete
      summary: Delete fraud prevention list item
      description: This method allows you to delete an existing fraud prevention list item linked to the merchant's account.
      tags:
        - Fraud prevention
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseRisksFraudPreventionListItem'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseMainError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleResponseRisksFraudPreventionListItemDelete'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Fraud prevention is not enabled:
                  $ref: '#/components/examples/ExampleResponseErrorFraudPreventionNotEnabled'
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleMainResponseErrorInvalidData'
                Error 2.01 Item not found:
                  $ref: '#/components/examples/ExampleResponseErrorFraudPreventionListItemNotFound'
  /dispute-representments/create:
    servers:
      - url: https://risks.solidgate.com/api/v1
        description: Risks management API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: dispute-representments-create
      summary: Create dispute representment
      description: This method allows you to initiate a dispute representment case with associated evidence <a href="https://api-docs.solidgate.com/#tag/Files-upload/operation/create-upload-url" target="_blank">files</a>.
      tags:
        - Dispute representment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestRisksDisputeRepresentmentsCreateDiscriminator'
            examples:
              Card dispute representment:
                $ref: '#/components/examples/ExampleRequestRisksDisputeRepresentmentsCreateCard'
              PayPal dispute representment:
                $ref: '#/components/examples/ExampleRequestRisksDisputeRepresentmentsCreatePayPal'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseRisksDisputeRepresentmentsCreate'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleResponseRisksDisputeRepresentmentsCreate'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseRisksBadRequest'
              examples:
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsInvalidData'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseRisksNotFoundError'
              examples:
                Error 2.01 Dispute not found:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsDisputeNotFound'
                Error 2.01 File not found:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileNotFound'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseRisksError'
              examples:
                Error 2.01 File not ready:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileNotReady'
                Error 2.01 File size exceeded:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileSizeExceeded'
                Error 2.01 File type not supported:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileTypeNotSupported'
                Error 2.01 Representment already exists:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsAlreadyExists'
                Error 2.01 Representment not possible:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsNotPossible'
  /dispute-representments/enrich:
    servers:
      - url: https://risks.solidgate.com/api/v1
        description: Risks management API
    parameters:
      - in: header
        name: merchant
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: dispute-representments-enrich
      summary: Enrich dispute representment
      description: This method allows you to enrich dispute representment with additional content.
      tags:
        - Dispute representment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestRisksDisputeRepresentmentsEnrichDiscriminator'
            examples:
              Card dispute representment enrichment:
                $ref: '#/components/examples/ExampleRequestRisksDisputeRepresentmentsEnrichCard'
              PayPal dispute representment enrichment:
                $ref: '#/components/examples/ExampleRequestRisksDisputeRepresentmentsEnrichPayPal'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseRisksDisputeRepresentmentsEnrich'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleResponseRisksDisputeRepresentmentsEnrich'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseRisksBadRequest'
              examples:
                Error 2.01 Invalid data:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsInvalidData'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseRisksNotFoundError'
              examples:
                Error 2.01 Dispute not found:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsDisputeNotFound'
                Error 2.01 File not found:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileNotFound'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseRisksEnrichError'
              examples:
                Error 2.01 File not ready:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileNotReady'
                Error 2.01 File size exceeded:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileSizeExceeded'
                Error 2.01 Total files size exceeded:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsTotalFileSizeExceeded'
                Error 2.01 File type not supported:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsFileTypeNotSupported'
                Error 2.01 Enrichment not possible:
                  $ref: '#/components/examples/ExampleResponseErrorRisksDisputeRepresentmentsEnrichmentNotPossible'
  /file/get-upload-url:
    servers:
      - url: https://api.solidgate.com/api/v1
        description: File upload Live API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: create-upload-url
      summary: Create file
      description: |-
        This method allows to create a file upload request by generating a unique `file_id` to reference the file. 

        This file can be used for various purposes such as evidence for dispute representment, compliance checks, or other necessary documentation uploads.
      tags:
        - Files upload
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestFilesCreateFileUpload'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseFilesCreateFileUpload'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
                  - $ref: '#/components/schemas/ResponseFilesError'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleResponseSuccessFile'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
                Error 2.01 Validation error:
                  $ref: '#/components/examples/ExampleResponseErrorFileValidationError'
  /webhooks/endpoints:
    servers:
      - url: https://api.solidgate.com/api/v1
        description: Webhooks management API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    post:
      operationId: webhook-endpoint-create
      summary: Create webhook endpoint
      description: |-
        This method allows you to configure a webhook endpoint to receive specified events.

        <blockquote>
          <p>Two identical URLs cannot be configured for one channel.</p>
        </blockquote>
      tags:
        - Manage webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestWebhooksEndpointCreate'
            examples:
              Without status:
                $ref: '#/components/examples/ExampleWebhooksRequestCreate'
              With status:
                $ref: '#/components/examples/ExampleWebhooksRequestCreateWithStatus'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseWebhooks'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleWebhooksResponse'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseWebhooksInvalidRequest'
              examples:
                Error 2.01 Invalid json:
                  $ref: '#/components/examples/ExampleWebhooksResponseInvalidJSON'
                Error 2.01 Invalid url:
                  $ref: '#/components/examples/ExampleWebhooksResponseInvalidURL'
                Error 2.01 Invalid event_type:
                  $ref: '#/components/examples/ExampleWebhooksResponseInvalidEventType'
                Error 2.01 Invalid status:
                  $ref: '#/components/examples/ExampleWebhooksResponseInvalidStatus'
                Error 2.01 Name max length:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointNameLen'
                Error 2.01 URL max length:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointURLLen'
        '422':
          description: Endpoint with the same URL already exists for this channel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseWebhooksEndpointAlreadyExists'
              examples:
                Error 2.01 Endpoint already exists:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointAlreadyExist'
                Error 2.01 Endpoint limit reached:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointLimitReached'
    get:
      operationId: webhook-endpoint-list
      summary: List webhook endpoints
      description: This method retrieves a list of your previously created webhook endpoints.
      tags:
        - Manage webhooks
      parameters:
        - in: query
          name: filter[id]
          schema:
            type: string
            maxLength: 50
            example: ac43b415-5522-4373-b026-a365462f9657
          description: Comma-separated webhook identifiers.
          allowReserved: true
        - in: query
          name: pagination[limit]
          schema:
            type: integer
            description: Number of items to return.
            default: 10
            minimum: 1
            maximum: 100
            example: 10
          allowReserved: true
        - in: query
          name: pagination[offset]
          schema:
            type: integer
            description: Number of items to skip before collecting the result set.
            default: 0
            minimum: 0
            example: 10
          allowReserved: true
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseWebhookEndpointList'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointList'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseWebhooksInvalidRequest'
              examples:
                Error 2.01 Invalid limit:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointInvalidLimit'
                Error 2.01 Limit out of range:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointLimitOutOfRange'
                Error 2.01 Invalid offset:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointInvalidOffset'
                Error 2.01 Negative offset:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointNegativeOffset'
                Error 2.01 ID list exceeds maximum length:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointIDsMaxLen'
                Error 2.01 Empty id in list:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointEmptyIDInList'
  /webhooks/endpoints/{id}:
    servers:
      - url: https://api.solidgate.com/api/v1
        description: Webhooks management API
    parameters:
      - in: header
        name: merchant
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainMerchant'
      - in: header
        name: signature
        required: true
        schema:
          $ref: '#/components/schemas/HeaderMainSignature'
    patch:
      operationId: webhook-endpoint-update
      summary: Update webhook endpoint
      description: |-
        This method allows you to update an existing webhook endpoint.
        For that, you need to provide the endpoint identifier and the new configuration.
      tags:
        - Manage webhooks
      parameters:
        - in: path
          name: id
          description: Webhook endpoint identifier.
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestWebhooksEndpointUpdate'
            examples:
              Update all:
                $ref: '#/components/examples/ExampleWebhooksRequestUpdateAll'
              Update event_types:
                $ref: '#/components/examples/ExampleWebhooksRequestUpdateEventTypes'
              Update status:
                $ref: '#/components/examples/ExampleWebhooksRequestUpdateStatus'
              Update name:
                $ref: '#/components/examples/ExampleWebhooksRequestUpdateName'
              Update url:
                $ref: '#/components/examples/ExampleWebhooksRequestUpdateURL'
      responses:
        '200':
          description: Request received
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseWebhooks'
                  - $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Success:
                  $ref: '#/components/examples/ExampleWebhooksResponse'
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseWebhooksInvalidRequest'
              examples:
                Error 2.01 Invalid json:
                  $ref: '#/components/examples/ExampleWebhooksResponseInvalidJSON'
                Error 2.01 Invalid event_type:
                  $ref: '#/components/examples/ExampleWebhooksResponseInvalidEventType'
                Error 2.01 Invalid status:
                  $ref: '#/components/examples/ExampleWebhooksResponseInvalidStatus'
                Error 2.01 Name max length:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointNameLen'
                Error 2.01 Invalid url:
                  $ref: '#/components/examples/ExampleWebhooksResponseInvalidURL'
        '404':
          description: Endpoint not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseWebhooksEndpointNotFound'
              examples:
                Error 2.01 Endpoint not found:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointNotFound'
        '422':
          description: Endpoint with the same URL already exists for this channel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseWebhooksEndpointAlreadyExists'
              examples:
                Error 2.01 Endpoint already exists:
                  $ref: '#/components/examples/ExampleWebhooksResponseEndpointAlreadyExist'
    delete:
      operationId: webhook-endpoint-delete
      summary: Delete webhook endpoint
      description: |-
        This method allows you to delete an existing webhook endpoint.
        For that, you need to provide the endpoint identifier you want to delete.
      tags:
        - Manage webhooks
      parameters:
        - in: path
          name: id
          description: Webhook endpoint identifier.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: |-
            Request received

            <blockquote style="border-left: 4px solid #1d8126; margin-left: 20px;">
              <p style="color: #1d8126; margin-left: 6px;">Response either confirms success or returns error object.</p>
            </blockquote>
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseMainAuthenticationFailed'
              examples:
                Authentication failed:
                  $ref: '#/components/examples/ExampleMainResponseErrorAuthFailed'
        '204':
          description: Webhook endpoint has been deleted
x-webhooks:
  CardsOrderStatus:
    post:
      summary: Updated card order
      operationId: webhook-card-order-status
      x-badges:
        - name: Event
          color: purple
      description: |-
        <a href="https://docs.solidgate.com/payments/integrate/webhooks/" target="_blank">Webhooks</a> allow merchants to securely receive real-time notifications in card order status changes, for example, from `processing` to `auth_failed`, and automatically trigger actions or updates in their own systems based on those events.

        <blockquote>
          <p>Duplicate webhook events can occur. Implement <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">idempotency</a> on your end to avoid processing the same event twice.</p>
        </blockquote>
      tags:
        - Card payments
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchantWebhook'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - schema:
            type: string
          in: header
          name: solidgate-event-id
          required: true
          description: Unique event identifier.
          example: e1765cf7-70f7-4e56-8fb2-bd88744a94d1
        - schema:
            type: string
            format: date-time
          in: header
          name: solidgate-event-created-at
          required: true
          description: Event creation time in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format with milliseconds.
          example: '2025-06-05T12:34:56.789Z'
        - schema:
            type: string
          in: header
          name: solidgate-event-type
          required: true
          description: Event type, indicating the specific event that occurred.
          example: card_gate.order.updated
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCardsWebhookOrderStatus'
            examples:
              Updated card order:
                $ref: '#/components/examples/ExampleCardsRequestWebhookOrderStatus'
      responses:
        2XX:
          description: Return any 2XX status to confirm successful data receipt
  NetworkTokenCreated:
    post:
      summary: Created network token
      operationId: webhook-network-token-created
      x-badges:
        - name: Event
          color: purple
      description: |-
        <a href="https://docs.solidgate.com/payments/integrate/webhooks/" target="_blank">Webhooks</a> provide merchants with real-time notifications, indicating that the network token associated with a payment card has been issued by Visa or Mastercard. Merchants can then automatically update their systems based on these notifications.

        <blockquote>
          <p>Duplicate webhook events can occur. Implement <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">idempotency</a> on your end to avoid processing the same event twice.</p>
        </blockquote>
      tags:
        - Card payments
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchantWebhook'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - schema:
            type: string
          in: header
          name: solidgate-event-id
          required: true
          description: Unique event identifier.
          example: e1765cf7-70f7-4e56-8fb2-bd88744a94d1
        - schema:
            type: string
            format: date-time
          in: header
          name: solidgate-event-created-at
          required: true
          description: Event creation time in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format with milliseconds.
          example: '2025-06-05T12:34:56.789Z'
        - schema:
            type: string
          in: header
          name: solidgate-event-type
          required: true
          description: Event type, indicating the specific event that occurred.
          example: card.network_token.created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCardsWebhookNetworkTokenCreated'
            examples:
              Created network token:
                $ref: '#/components/examples/ExampleCardsRequestWebhookNetworkTokenCreated'
      responses:
        2XX:
          description: Return any 2XX status to confirm successful data receipt
  NetworkTokenUpdated:
    post:
      summary: Updated network token
      operationId: webhook-network-token-updated
      x-badges:
        - name: Event
          color: purple
      description: |-
        <a href="https://docs.solidgate.com/payments/integrate/webhooks/" target="_blank">Webhooks</a> provide merchants with real-time notifications when the network token associated with a payment card is updated by Visa or Mastercard. These notifications allow merchants to automatically update their systems based on the events.

        <blockquote>
          <p>Duplicate webhook events can occur. Implement <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">idempotency</a> on your end to avoid processing the same event twice.</p>
        </blockquote>
      tags:
        - Card payments
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchantWebhook'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - schema:
            type: string
          in: header
          name: solidgate-event-id
          required: true
          description: Unique event identifier.
          example: e1765cf7-70f7-4e56-8fb2-bd88744a94d1
        - schema:
            type: string
            format: date-time
          in: header
          name: solidgate-event-created-at
          required: true
          description: Event creation time in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format with milliseconds.
          example: '2025-06-05T12:34:56.789Z'
        - schema:
            type: string
          in: header
          name: solidgate-event-type
          required: true
          description: Event type, indicating the specific event that occurred.
          example: card.network_token.updated
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCardsWebhookNetworkTokenUpdated'
            examples:
              Updated network token:
                $ref: '#/components/examples/ExampleCardsRequestWebhookNetworkTokenUpdated'
      responses:
        2XX:
          description: Return any 2XX status to confirm successful data receipt
  Chargeback:
    post:
      summary: Received dispute
      operationId: webhook-chargeback
      x-badges:
        - name: Event
          color: purple
      description: |-
        <a href="https://docs.solidgate.com/payments/integrate/webhooks/" target="_blank">Webhooks</a> for chargebacks allow merchants to securely receive real-time notifications of chargeback events and automatically trigger actions or updates in their own systems based on those events.

        <blockquote>
          <p>Duplicate webhook events can occur. Implement <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">idempotency</a> on your end to avoid processing the same event twice.</p>
        </blockquote>
      tags:
        - Card payments
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchantWebhook'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - schema:
            type: string
          in: header
          name: solidgate-event-id
          required: true
          description: Unique event identifier.
          example: e1765cf7-70f7-4e56-8fb2-bd88744a94d1
        - schema:
            type: string
            format: date-time
          in: header
          name: solidgate-event-created-at
          required: true
          description: Event creation time in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format with milliseconds.
          example: '2025-06-05T12:34:56.789Z'
        - schema:
            type: string
          in: header
          name: solidgate-event-type
          required: true
          description: Event type, indicating the specific event that occurred.
          example: card_gate.chargeback.received
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCardsWebhookChargeback'
            examples:
              Received dispute:
                $ref: '#/components/examples/ExampleCardsRequestWebhookChargeback'
      responses:
        2XX:
          description: Return any 2XX status to confirm successful data receipt
  CardPreventAlert:
    post:
      summary: Received prevention alert
      operationId: webhook-alert-prevent
      x-badges:
        - name: Event
          color: purple
      description: |-
        <a href="https://docs.solidgate.com/payments/integrate/webhooks/" target="_blank">Webhooks</a> enable to preemptively identify and resolve potential issues, thereby preventing the generation of alert.

        <blockquote>
          <p>Duplicate webhook events can occur. Implement <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">idempotency</a> on your end to avoid processing the same event twice.</p>
        </blockquote>
      tags:
        - Card payments
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchantWebhook'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - schema:
            type: string
          in: header
          name: solidgate-event-id
          required: true
          description: Unique event identifier.
          example: e1765cf7-70f7-4e56-8fb2-bd88744a94d1
        - schema:
            type: string
            format: date-time
          in: header
          name: solidgate-event-created-at
          required: true
          description: Event creation time in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format with milliseconds.
          example: '2025-06-05T12:34:56.789Z'
        - schema:
            type: string
          in: header
          name: solidgate-event-type
          required: true
          description: Event type, indicating the specific event that occurred.
          example: card_gate.prevention_alert.received
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCardsWebhookPreventAlert'
            examples:
              Received prevention alert:
                $ref: '#/components/examples/ExampleCardsRequestWebhookPreventAlert'
      responses:
        2XX:
          description: Return any 2XX status to confirm successful data receipt
  FraudAlert:
    post:
      summary: Received fraud alert
      operationId: webhook-fraud-alert
      x-badges:
        - name: Event
          color: purple
      description: |-
        <a href="https://docs.solidgate.com/payments/integrate/webhooks/" target="_blank">Webhooks</a> for fraud alerts allow merchants to securely receive real-time notifications of fraud reported by card schemes.

        <blockquote>
          <p>Duplicate webhook events can occur. Implement <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">idempotency</a> on your end to avoid processing the same event twice.</p>
        </blockquote>
      tags:
        - Card payments
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchantWebhook'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - schema:
            type: string
          in: header
          name: solidgate-event-id
          required: true
          description: Unique event identifier.
          example: e1765cf7-70f7-4e56-8fb2-bd88744a94d1
        - schema:
            type: string
            format: date-time
          in: header
          name: solidgate-event-created-at
          required: true
          description: Event creation time in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format with milliseconds.
          example: '2025-06-05T12:34:56.789Z'
        - schema:
            type: string
          in: header
          name: solidgate-event-type
          required: true
          description: Event type, indicating the specific event that occurred.
          example: card_gate.fraud_alert.received
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCardsWebhookFraudAlert'
            examples:
              Received fraud alert:
                $ref: '#/components/examples/ExampleCardsRequestWebhookFraudAlert'
      responses:
        2XX:
          description: Return any 2XX status to confirm successful data receipt
  CalculatedTax:
    post:
      summary: Calculated tax
      operationId: webhook-calculated-tax
      x-badges:
        - name: Event
          color: purple
      description: |-
        <a href="https://docs.solidgate.com/payments/integrate/webhooks/" target="_blank">Webhooks</a> provide merchants with instant notifications when the Solidgate tax solution calculates the tax amount of the transaction. These notifications allow merchants to notify users about paid taxes or to save tax information in real-time on the merchant’s side.

        It delivers key tax details, such as calculated amounts and tax type breakdowns, ensuring accurate and automated tax application for transactions.

        <blockquote>
          <p>Duplicate webhook events can occur. Implement <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">idempotency</a> on your end to avoid processing the same event twice.</p>
        </blockquote>
      tags:
        - Taxes
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchantWebhook'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - schema:
            type: string
          in: header
          name: solidgate-event-id
          required: true
          description: Unique event identifier.
          example: e1765cf7-70f7-4e56-8fb2-bd88744a94d1
        - schema:
            type: string
            format: date-time
          in: header
          name: solidgate-event-created-at
          required: true
          description: Event creation time in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format with milliseconds.
          example: '2025-06-05T12:34:56.789Z'
        - schema:
            type: string
          in: header
          name: solidgate-event-type
          required: true
          description: Event type, indicating the specific event that occurred.
          example: taxer.tax.calculated
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestBillingWebhookTaxCalculated'
            examples:
              Calculated tax:
                $ref: '#/components/examples/ExampleBillingWebhookTaxCalculated'
      responses:
        2XX:
          description: Return any 2XX status to confirm successful data receipt
  APMOrderStatus:
    post:
      summary: Updated alternative order
      operationId: webhook-apm-order-status
      x-badges:
        - name: Event
          color: purple
      description: |-
        <a href="https://docs.solidgate.com/payments/integrate/webhooks/" target="_blank">Webhooks</a> for alternative payment method status enable merchants to securely receive real-time notifications of changes in the status of alternative payment methods, such as `processing` or `declined`, and automatically initiate actions or updates in their own systems based on those events.

        <blockquote>
          <p>Duplicate webhook events can occur. Implement <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">idempotency</a> on your end to avoid processing the same event twice.</p>
        </blockquote>
      tags:
        - Alternative payment methods
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchantWebhook'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - schema:
            type: string
          in: header
          name: solidgate-event-id
          required: true
          description: Unique event identifier.
          example: e1765cf7-70f7-4e56-8fb2-bd88744a94d1
        - schema:
            type: string
            format: date-time
          in: header
          name: solidgate-event-created-at
          required: true
          description: Event creation time in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format with milliseconds.
          example: '2025-06-05T12:34:56.789Z'
        - schema:
            type: string
          in: header
          name: solidgate-event-type
          required: true
          description: Event type, indicating the specific event that occurred.
          example: alt_gate.order.updated
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestApmWebhookOrderStatus'
            examples:
              Updated alternative order:
                $ref: '#/components/examples/ExampleApmRequestWebhookOrderStatus'
      responses:
        2XX:
          description: Return any 2XX status to confirm successful data receipt
  PayPalDispute:
    post:
      summary: Received PayPal dispute
      operationId: webhook-paypal-dispute
      x-badges:
        - name: Event
          color: purple
      description: |-
        <a href="https://docs.solidgate.com/payments/integrate/webhooks/" target="_blank">Webhooks</a> delivers critical insights into each <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/" target="_blank">PayPal</a> dispute and its lifecycle, enabling businesses to manage disputes effectively and enhance customer satisfaction.

        <blockquote>
          <p>Duplicate webhook events can occur. Implement <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">idempotency</a> on your end to avoid processing the same event twice.</p>
        </blockquote>
      tags:
        - Alternative payment methods
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchantWebhook'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - schema:
            type: string
          in: header
          name: solidgate-event-id
          required: true
          description: Unique event identifier.
          example: e1765cf7-70f7-4e56-8fb2-bd88744a94d1
        - schema:
            type: string
            format: date-time
          in: header
          name: solidgate-event-created-at
          required: true
          description: Event creation time in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format with milliseconds.
          example: '2025-06-05T12:34:56.789Z'
        - schema:
            type: string
          in: header
          name: solidgate-event-type
          required: true
          description: Event type, indicating the specific event that occurred.
          example: alt_gate.paypal_dispute.received
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestApmWebhookPaypalDispute'
            examples:
              Received PayPal dispute:
                $ref: '#/components/examples/ExampleApmRequestWebhookPaypalDispute'
      responses:
        2XX:
          description: Return any 2XX status to confirm successful data receipt
  APMPreventAlert:
    post:
      summary: Received prevention alert
      operationId: webhook-apm-alert-prevent
      x-badges:
        - name: Event
          color: purple
      description: |-
        <a href="https://docs.solidgate.com/payments/integrate/webhooks/" target="_blank">Webhooks</a> enable to preemptively identify and resolve potential issues, thereby preventing the generation of alert, specifically for the <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/" target="_blank">PayPal</a> method.

        <blockquote>
          <p>Duplicate webhook events can occur. Implement <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">idempotency</a> on your end to avoid processing the same event twice.</p>
        </blockquote>
      tags:
        - Alternative payment methods
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchantWebhook'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - schema:
            type: string
          in: header
          name: solidgate-event-id
          required: true
          description: Unique event identifier.
          example: e1765cf7-70f7-4e56-8fb2-bd88744a94d1
        - schema:
            type: string
            format: date-time
          in: header
          name: solidgate-event-created-at
          required: true
          description: Event creation time in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format with milliseconds.
          example: '2025-06-05T12:34:56.789Z'
        - schema:
            type: string
          in: header
          name: solidgate-event-type
          required: true
          description: Event type, indicating the specific event that occurred.
          example: card_gate.prevention_alert.received
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestApmWebhookPreventAlert'
            examples:
              Received prevention alert:
                $ref: '#/components/examples/ExampleApmRequestWebhookPreventAlert'
      responses:
        2XX:
          description: Return any 2XX status to confirm successful data receipt
  APMRevokedRecurringToken:
    post:
      summary: Revoked recurring token
      operationId: webhook-apm-revoked-recurring-token
      x-badges:
        - name: Event
          color: purple
      description: |-
        <a href="https://docs.solidgate.com/payments/integrate/webhooks/" target="_blank">Webhooks</a> notify about a revoked recurring token for alternative payment methods.

        <blockquote>
          <p>Duplicate webhook events can occur. Implement <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">idempotency</a> on your end to avoid processing the same event twice.</p>
        </blockquote>
      tags:
        - Alternative payment methods
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchantWebhook'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - schema:
            type: string
          in: header
          name: solidgate-event-id
          required: true
          description: Unique event identifier.
          example: e1765cf7-70f7-4e56-8fb2-bd88744a94d1
        - schema:
            type: string
            format: date-time
          in: header
          name: solidgate-event-created-at
          required: true
          description: Event creation time in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format with milliseconds.
          example: '2025-06-05T12:34:56.789Z'
        - schema:
            type: string
          in: header
          name: solidgate-event-type
          required: true
          description: Event type, indicating the specific event that occurred.
          example: alt_gate.recurring_token.cancelled
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestApmWebhookRevokedRecurringToken'
            examples:
              Revoked recurring token:
                $ref: '#/components/examples/ExampleApmRequestWebhookRevokedRecurringToken'
      responses:
        2XX:
          description: Return any 2XX status to confirm successful data receipt
  Billing:
    post:
      summary: Subscription payment updates
      operationId: webhook-subscription-status
      x-badges:
        - name: Event
          color: purple
      description: |-
        <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-events/" target="_blank">Webhooks</a> for subscription status provide real-time notifications about changes in subscription status. 

        The webhook structure is similar to the subscription status method but additionally includes the `callback_type` parameter in the response object.

        There are two versions of <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-events/" target="_blank">subscription events</a>: legacy and extended.
        The extended version offers an enhanced webhook event set with more detail and context, giving merchants deeper insights into subscription stages for better management and analysis.
        The legacy version remains supported until the end of May 2026.

        <blockquote>
          <p>Duplicate webhook events can occur. Implement <a href="https://docs.solidgate.com/payments/integrate/webhooks/#event-handling" target="_blank">idempotency</a> on your end to avoid processing the same event twice.</p>
        </blockquote>

        Parameters for each callback type can vary based on factors such as product type, payment method, trial availability, or other specific conditions.
      tags:
        - Manage subscriptions
      parameters:
        - in: header
          name: merchant
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainMerchantWebhook'
        - in: header
          name: signature
          required: true
          schema:
            $ref: '#/components/schemas/HeaderMainSignature'
        - schema:
            type: string
          in: header
          name: solidgate-event-id
          required: true
          description: Unique event identifier.
          example: e1765cf7-70f7-4e56-8fb2-bd88744a94d1
        - schema:
            type: string
            format: date-time
          in: header
          name: solidgate-event-created-at
          required: true
          description: Event creation time in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format with milliseconds.
          example: '2025-06-05T12:34:56.789Z'
        - schema:
            type: string
          in: header
          name: solidgate-event-type
          required: true
          description: Event type, indicating the specific event that occurred.
          example: subscription.updated.v2
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/SchemaBillingSubscriptionDiscriminatorWebhookExtended'
                - $ref: '#/components/schemas/SchemaBillingSubscriptionDiscriminatorWebhook'
            examples:
              extended create:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedCreate'
              extended expire:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedExpire'
              extended payment_attempt:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedPaymentAttempt'
              extended active:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedActive'
              extended renew:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedRenew'
              extended switch_product:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedSwitchProduct'
              extended order_update:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedUpdateOrder'
              extended pause:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedPause'
              extended pause_schedule.create:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedCreatePauseSchedule'
              extended pause_schedule.update:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedUpdatePauseSchedule'
              extended pause_schedule.delete:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedDeletePauseSchedule'
              extended resume:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedResume'
              extended recurring:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedRecurring'
              extended restore:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedRestore'
              extended cancel:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedCancel'
              extended scheduled_for_cancellation:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedScheduleCancellation'
              extended redemption:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedRedemption'
              extended retry:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedRetry'
              extended scheduled_for_retry:
                $ref: '#/components/examples/ExampleBillingWebhookExtendedScheduleRetry'
              init:
                $ref: '#/components/examples/ExampleBillingWebhookInit'
              renew:
                $ref: '#/components/examples/ExampleBillingWebhookRenew'
              update:
                $ref: '#/components/examples/ExampleBillingWebhookUpdate'
              cancel:
                $ref: '#/components/examples/ExampleBillingWebhookCancel'
              pause:
                $ref: '#/components/examples/ExampleBillingWebhookPause'
              resume:
                $ref: '#/components/examples/ExampleBillingWebhookResume'
              pause_schedule.create:
                $ref: '#/components/examples/ExampleBillingWebhookCreatePauseSchedule'
              pause_schedule.update:
                $ref: '#/components/examples/ExampleBillingWebhookUpdatePauseSchedule'
              pause_schedule.delete:
                $ref: '#/components/examples/ExampleBillingWebhookDeletePauseSchedule'
      responses:
        2XX:
          description: Return any 2XX status to confirm successful data receipt
components:
  securitySchemes:
    MerchantID:
      name: Merchant id
      type: apiKey
      in: header
  schemas:
    HeaderMainMerchant:
      type: string
      description: Unique <a href="https://docs.solidgate.com/payments/integrate/access-to-api/#retrieve-your-credentials" target="_blank">public key</a> provided upon registration and must be shared for identification purposes.
      example: api_pk_7b197...ba108f842
    HeaderMainSignature:
      type: string
      description: Request <a href="https://docs.solidgate.com/payments/integrate/access-to-api/#generate-signature" target="_blank">signature</a> that allows verification of merchant authenticity on the payment gateway server.
      example: M2E3OTkyNzcz...xMmExODI4
    RequestCheckoutSolutionsCreatePage:
      title: Payment
      type: object
      required:
        - order
        - page_customization
      properties:
        order:
          type: object
          description: Information required to create an order.
          required:
            - order_id
            - amount
            - currency
            - order_description
            - type
          properties:
            order_id:
              type: string
              description: Unique order identifier defined by the merchant, which can be used later to find this payment.
              maxLength: 255
            amount:
              type: integer
              description: |-
                Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> (cents for euros).

                <blockquote>
                  <p>For instance, 1020 means 10 EUR and 20 cents.</p>
                  <p>However, the value 0 is valid only for a <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount authorization</a> flow. In cases where the amount received from APM systems is 0, only PayPal is queried for processing.</p>
                </blockquote>
              minimum: 0
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the product price currency.
              minLength: 3
              maxLength: 3
            future_usage:
              type: object
              description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.
              properties:
                payment_type:
                  type: string
                  description: |-
                    Payment type for future usage.

                    <blockquote style="border-left: 4px solid #D1E6DF; ">
                      <p><b>Should be provided</b> for <a href="https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments" target="_blank">alternative payment methods</a> <code>alipay</code>, <code>bizum</code>, <code>mbway</code> or <code>wechatpay</code>.</p>
                    </blockquote>
                  enum:
                    - one-time
                    - unscheduled
            order_description:
              type: string
              description: |-
                A description of the order.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters.</p>
                </blockquote>

                <blockquote>                
                  <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
                </blockquote>
              maxLength: 255
            order_items:
              type: string
              description: Names and descriptions of the items included in the order.
            order_date:
              type: string
              description: Date of order creation defined by the merchant.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              maxLength: 50
            order_number:
              type: integer
              format: int32
              description: Sequential number of the order within the customer account.
            type:
              type: string
              deprecated: true
              description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
              enum:
                - auth
            settle_interval:
              type: integer
              description: |-
                Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
                - `240` hours = 10 days for Visa customer-initiated payments
                - `120` hours = 5 days for Visa merchant-initiated payments
                - `168` hours = 7 days for all other card brands

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
                </blockquote>
                <blockquote>
                  <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
                </blockquote>
              maximum: 240
              minimum: 0
            authorization_type:
              type: string
              enum:
                - final
                - estimated
              default: final
              description: |-
                Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.

                - <code>final</code> - standard authorization, no increments allowed
                - <code>estimated</code> - initial authorization with possible amount changes
            force3ds:
              type: boolean
              description: Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.
              default: false
            google_pay_allowed_auth_methods:
              type: array
              description: |-
                Array of allowed Google Pay authorization methods.

                - `PAN_ONLY` - this authentication method is associated with payment cards stored on file with the user’s Google Account. Returned payment data includes personal account number (PAN) with the expiration month and the expiration year.
                - `CRYPTOGRAM_3DS` - this authentication method is associated with cards stored as Android device tokens. Returned payment data includes a 3D Secure (3DS) cryptogram generated on the device.

                <blockquote>
                  <p>The capability to transmit only <code>PAN_ONLY</code> or <code>CRYPTOGRAM_3DS</code> is also available, and such transmission will work for both one-time payments and <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscriptions</a>.</p>
                </blockquote>
            customer_date_of_birth:
              type: string
              description: Customer's date of birth.
              format: date
              maxLength: 10
            customer_email:
              type: string
              description: |-
                Customer's email address.      

                <blockquote>
                  <p>Can be used for sending receipts and notifications; if not provided, the field still appears on the payment page with a note "For receipts and notifications".</p>
                </blockquote>
              maxLength: 100
            customer_first_name:
              type: string
              description: Customer's first name.
              maxLength: 100
            customer_last_name:
              type: string
              description: Customer's last name.
              maxLength: 100
            customer_phone:
              type: string
              description: |-
                Customer's phone number.

                <blockquote style="border-left: 4px solid #D1E6DF; ">
                  <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
                </blockquote>
              maxLength: 18
              pattern: ^\+[1-9]\d{1,14}$
            billing_address:
              type: object
              description: Billing address details.
              properties:
                country:
                  type: string
                  description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
                  minLength: 3
                  maxLength: 3
                state:
                  type: string
                  description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
                  maxLength: 10
                city:
                  type: string
                  description: City name.
                  maxLength: 100
                zip:
                  type: string
                  description: Address zip/postal code.
                  maxLength: 10
                address:
                  type: string
                  description: First line of the billing address.
                  maxLength: 100
            traffic_source:
              type: string
              description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
              maxLength: 255
            transaction_source:
              type: string
              description: Identifies the internal system or flow that triggered the transaction.
              maxLength: 255
            purchase_country:
              type: string
              description: |-
                Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

                <blockquote style="border-left: 4px solid #F2C4C4; ">                
                  <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
                  <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
                </blockquote>
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            geo_country:
              type: string
              description: Country where the customer account is registered on the merchant platform.
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            geo_city:
              type: string
              description: City where the customer account is registered on the merchant platform.
              maxLength: 100
            language:
              type: string
              description: |-
                Payment page language that customers can change to English.

                <blockquote>                
                  <p>It is also used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
                </blockquote>
              enum:
                - cs
                - da
                - de
                - el
                - en
                - es
                - fi
                - fr
                - it
                - nl
                - 'no'
                - pl
                - pt
                - ro
                - sk
                - sv
                - uk
            website:
              type: string
              description: Website from which the transaction took place.
              maxLength: 255
            order_metadata:
              type: object
              description: Metadata is useful for storing additional, structured information about an order.
              additionalProperties:
                type: string
                maxLength: 380
              maxProperties: 10
            success_url:
              type: string
              description: URL for browser redirect after a successful payment.
              maxLength: 255
            fail_url:
              type: string
              description: URL for browser redirect after a failed payment.
              maxLength: 255
            fraudulent:
              type: boolean
              description: Whether the merchant system has flagged this customer as suspicious.
              deprecated: true
              default: false
        page_customization:
          type: object
          description: Information required to <a href="https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/" target="_blank">customize</a> the payment page display.
          required:
            - public_name
          properties:
            public_name:
              type: string
              maxLength: 46
              description: |-
                Shop name.

                <blockquote>
                  <p>It is visible to customers on the payment page.</p>
                </blockquote>
            order_title:
              type: string
              maxLength: 100
              description: Names of goods or services you sell are visible to customers on the payment page.
            order_description:
              type: string
              description: |-
                A description of the order.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters.</p>
                </blockquote>

                <blockquote>                
                  <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
                </blockquote>
              maxLength: 401
            payment_methods:
              description: Additional <a href="https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments" target="_blank">alternative payment methods</a>.
              type: array
              items:
                type: string
            button_font_color:
              type: string
              description: |-
                Color of the font on the Pay Button.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to use HEX format.</p>
                </blockquote>
            button_color:
              type: string
              description: |-
                Color of the Pay Button.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to use HEX format.</p>
                </blockquote>
            font_name:
              type: string
              description: |-
                Font name on the payment page.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to use the Google Font name.</p>
                </blockquote>
              maxLength: 255
            is_cardholder_visible:
              type: boolean
              description: |-
                Display the field cardholder on the payment page.

                <blockquote>
                  <p>If the field is accepted as true, it will be displayed.</p>
                </blockquote>
            terms_url:
              type: string
              description: URL for the merchant Terms & Conditions will be attached to the checkbox.
              maxLength: 1000
            back_url:
              type: string
              description: |-
                URL where the customer should be redirected in case of clicks the <b>Back</b> button.

                <blockquote>
                  <p>Passing this parameter will add a <b>Back</b> button on your payment and status pages.</p>
                </blockquote>
              maxLength: 1000
    RequestCheckoutSolutionsCreateSubscriptionPaymentPage:
      title: Subscription payment
      type: object
      required:
        - order
        - page_customization
      properties:
        order:
          type: object
          description: Information required to create an order.
          required:
            - order_id
            - product_id
            - order_description
            - type
            - customer_account_id
          properties:
            order_id:
              type: string
              description: Unique order identifier defined by the merchant, which can be used later to find this payment.
              maxLength: 255
            product_id:
              type: string
              description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier of the subscription.
              format: uuid
              maxLength: 36
              minLength: 36
            product_price_id:
              description: |-
                Unique product price identifier.

                Set `product_price_id` for the <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscription</a> flow and to ensure correct pricing, specifically for multi-currency products.

                <blockquote>
                  <p>To get <code>product_price_id</code>, use <a href="https://api-docs.solidgate.com/#tag/Products-and-prices/operation/get-product-prices" target="_blank">get product prices</a> request.</p>
                </blockquote>
              type: string
              format: uuid
            order_description:
              type: string
              description: |-
                A description of the order.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters.</p>
                </blockquote>

                <blockquote>                
                  <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
                </blockquote>
              maxLength: 255
            order_items:
              type: string
              description: Names and descriptions of the items included in the order.
            order_date:
              type: string
              description: Date of order creation defined by the merchant.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              maxLength: 50
            order_number:
              type: integer
              format: int32
              description: Sequential number of the order within the customer account.
            type:
              type: string
              deprecated: true
              description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
              enum:
                - auth
            settle_interval:
              type: integer
              description: |-
                Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
                - `240` hours = 10 days for Visa customer-initiated payments
                - `120` hours = 5 days for Visa merchant-initiated payments
                - `168` hours = 7 days for all other card brands

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
                </blockquote>
                <blockquote>
                  <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
                </blockquote>
              maximum: 240
              minimum: 0
            authorization_type:
              type: string
              enum:
                - final
              default: final
              description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
            retry_attempt:
              type: integer
              description: |-
                Number of retry attempts for the subscription payments.

                <blockquote>
                  <p>Use it for analytics and conversion tuning purposes.</p>
                </blockquote>
              minimum: 0
            force3ds:
              type: boolean
              description: Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.
              default: false
            google_pay_allowed_auth_methods:
              type: array
              description: |-
                Array of allowed Google Pay authorization methods.

                - `PAN_ONLY` - this authentication method is associated with payment cards stored on file with the user’s Google Account. Returned payment data includes primary account number (PAN) with the expiration month and the expiration year.
                - `CRYPTOGRAM_3DS` - this authentication method is associated with cards stored as Android device tokens. Returned payment data includes a 3D Secure (3DS) cryptogram generated on the device.

                <blockquote>
                  <p>The capability to transmit only <code>PAN_ONLY</code> or <code>CRYPTOGRAM_3DS</code> is also available, and such transmission will work for both one-time payments and <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscriptions</a>.</p>
                </blockquote>
            customer_account_id:
              type: string
              description: Unique customer identifier defined by the merchant.
              maxLength: 100
            customer_date_of_birth:
              type: string
              description: Customer's date of birth.
              format: date
              maxLength: 10
            customer_email:
              type: string
              description: |-
                Customer's email address.      

                <blockquote>
                  <p>Can be used for sending receipts and notifications; if not provided, the field still appears on the payment page with a note "For receipts and notifications".</p>
                </blockquote>
              maxLength: 100
            customer_first_name:
              type: string
              description: Customer's first name.
              maxLength: 100
            customer_last_name:
              type: string
              description: Customer's last name.
              maxLength: 100
            customer_phone:
              type: string
              description: |-
                Customer's phone number.

                <blockquote style="border-left: 4px solid #D1E6DF; ">
                  <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
                </blockquote>
              maxLength: 18
              pattern: ^\+[1-9]\d{1,14}$
            billing_address:
              type: object
              description: Billing address details.
              properties:
                country:
                  type: string
                  description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
                  minLength: 3
                  maxLength: 3
                state:
                  type: string
                  description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
                  maxLength: 10
                city:
                  type: string
                  description: City name.
                  maxLength: 100
                zip:
                  type: string
                  description: Address zip/postal code.
                  maxLength: 10
                address:
                  type: string
                  description: First line of the billing address.
                  maxLength: 100
            traffic_source:
              type: string
              description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
              maxLength: 255
            transaction_source:
              type: string
              description: Identifies the internal system or flow that triggered the transaction.
              maxLength: 255
            purchase_country:
              type: string
              description: |-
                Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

                <blockquote style="border-left: 4px solid #F2C4C4; ">                
                  <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
                  <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
                </blockquote>
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            geo_country:
              type: string
              description: Customer's registration country in the <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO-3166</a> alpha-3 country code format.
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            geo_city:
              type: string
              description: City where the customer account is registered on the merchant platform.
              maxLength: 100
            language:
              type: string
              description: |-
                Payment page language that customers can change to English.

                <blockquote>                
                  <p>It is also used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
                </blockquote>
              enum:
                - cs
                - da
                - de
                - el
                - en
                - es
                - fi
                - fr
                - it
                - nl
                - 'no'
                - pl
                - pt
                - ro
                - sk
                - sv
                - uk
            website:
              type: string
              description: Website from which the transaction took place.
              maxLength: 255
            order_metadata:
              type: object
              description: Metadata is useful for storing additional, structured information about an order.
              additionalProperties:
                type: string
                maxLength: 380
              maxProperties: 10
            success_url:
              type: string
              description: URL for browser redirect after a successful payment.
              maxLength: 255
            fail_url:
              type: string
              description: URL for browser redirect after a failed payment.
              maxLength: 255
            fraudulent:
              type: boolean
              description: Whether the merchant system has flagged this customer as suspicious.
              deprecated: true
              default: false
        page_customization:
          type: object
          description: Information required to <a href="https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/" target="_blank">customize</a> the payment page display.
          required:
            - public_name
          properties:
            public_name:
              type: string
              maxLength: 46
              description: |-
                Shop name.

                <blockquote>
                  <p>It is visible to customers on the payment page.</p>
                </blockquote>
            order_title:
              type: string
              maxLength: 100
              description: Names of goods or services you sell are visible to customers on the payment page.
            order_description:
              type: string
              description: |-
                A description of the order.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters.</p>
                </blockquote>

                <blockquote>                
                  <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
                </blockquote>
              maxLength: 401
            payment_methods:
              description: Additional <a href="https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments" target="_blank">alternative payment methods</a>.
              type: array
              items:
                type: string
            button_font_color:
              type: string
              description: |-
                Color of the font on the Pay Button.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to use HEX format.</p>
                </blockquote>
            button_color:
              type: string
              description: |-
                Color of the Pay Button.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to use HEX format.</p>
                </blockquote>
            font_name:
              type: string
              description: |-
                Font name on the payment page.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to use the Google Font name.</p>
                </blockquote>
              maxLength: 255
            is_cardholder_visible:
              type: boolean
              description: |-
                Display the field cardholder on the payment page.

                <blockquote>
                  <p>If the field is accepted as true, it will be displayed.</p>
                </blockquote>
            terms_url:
              type: string
              description: URL for the merchant Terms & Conditions will be attached to the checkbox.
              maxLength: 1000
            back_url:
              type: string
              description: |-
                URL where the customer should be redirected in case of clicks the <b>Back</b> button.

                <blockquote>
                  <p>Passing this parameter will add a <b>Back</b> button on your payment and status pages.</p>
                </blockquote>
              maxLength: 1000
    ResponseCheckoutSolutionsPage:
      title: Success
      type: object
      properties:
        url:
          type: string
          description: Specific URL where the customer should be directed to complete their transaction.
          example: https://payment-page.solidgate.com/VxKnj3D
        id:
          type: string
          description: Unique payment page identifier.
          example: VxKnj3D
        guid:
          type: string
          description: Unique payment session identifier.
          deprecated: true
      required:
        - url
        - id
    ResponseCheckoutSolutionsAuthenticationFailed:
      title: Authentication failed
      type: object
      properties:
        error:
          description: Error object.
          properties:
            code:
              type: string
              description: <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#101-authentication-failed" target="_blank">Unauthorized access</a> due to invalid credentials.
              default: 1.01
              example: '1.01'
            message:
              type: array
              description: Array of error messages applied to the decline payment.
              items:
                example: Authentication failed
          required:
            - code
            - message
      required:
        - error
    ResponseCheckoutSolutionsError:
      title: Error
      type: object
      properties:
        error:
          description: Error object.
          properties:
            code:
              type: string
              description: Error <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">code</a>.
              example: '2.01'
            message:
              type: object
              description: |-
                An object provide details about the error or status.

                <blockquote>
                  <p>Contain key-value pairs explaining the issue in more detail.</p>
                </blockquote>
          required:
            - code
            - message
      required:
        - error
    RequestCheckoutSolutionsDeactivatePage:
      title: Deactivate payment page
      type: object
      required:
        - id
      properties:
        id:
          type: string
          description: |-
            Unique payment page identifier.

            <blockquote>                
              <p>Can be found at the end of the payment page URL.</p>
            </blockquote>
          example: VxKnj3D
    RequestCheckoutSolutionsCreateLink:
      title: Payment
      type: object
      required:
        - order
        - page_customization
      properties:
        order:
          type: object
          description: Information required to create an order.
          required:
            - amount
            - currency
            - type
          properties:
            amount:
              type: integer
              description: |-
                Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> (cents for euros).

                <blockquote>
                  <p>For instance, 1020 means 10 EUR and 20 cents.</p>
                  <p>However, the value 0 is valid only for a <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount authorization</a> flow.</p>
                </blockquote>
              minimum: 0
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the product price currency.
              minLength: 3
              maxLength: 3
            future_usage:
              type: object
              description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.
              properties:
                payment_type:
                  type: string
                  description: |-
                    Payment type for future usage.

                    <blockquote style="border-left: 4px solid #D1E6DF; ">
                      <p><b>Should be provided</b> for <a href="https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments" target="_blank">alternative payment methods</a> <code>alipay</code>, <code>bizum</code>, <code>mbway</code> or <code>wechatpay</code>.</p>
                    </blockquote>
                  enum:
                    - one-time
                    - unscheduled
            order_description:
              type: string
              description: |-
                A description of the order.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters.</p>
                </blockquote>

                <blockquote>                
                  <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
                </blockquote>
              maxLength: 255
            type:
              type: string
              deprecated: true
              description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
              enum:
                - auth
            settle_interval:
              type: integer
              description: |-
                Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
                - `240` hours = 10 days for Visa customer-initiated payments
                - `120` hours = 5 days for Visa merchant-initiated payments
                - `168` hours = 7 days for all other card brands

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
                </blockquote>
                <blockquote>
                  <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
                </blockquote>
              maximum: 240
              minimum: 0
            authorization_type:
              type: string
              enum:
                - final
                - estimated
              default: final
              description: |-
                Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.

                - <code>final</code> - standard authorization, no increments allowed
                - <code>estimated</code> - initial authorization with possible amount changes
            google_pay_allowed_auth_methods:
              type: array
              description: |-
                Array of allowed Google Pay authorization methods.

                - `PAN_ONLY` - this authentication method is associated with payment cards stored on file with the user’s Google Account. Returned payment data includes personal account number (PAN) with the expiration month and the expiration year.
                - `CRYPTOGRAM_3DS` - this authentication method is associated with cards stored as Android device tokens. Returned payment data includes a 3D Secure (3DS) cryptogram generated on the device.

                <blockquote>
                  <p>The capability to transmit only <code>PAN_ONLY</code> or <code>CRYPTOGRAM_3DS</code> is also available, and such transmission will work for both one-time payments and <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscriptions</a>.</p>
                </blockquote>
            traffic_source:
              type: string
              description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
              maxLength: 255
            transaction_source:
              type: string
              description: Identifies the internal system or flow that triggered the transaction.
              maxLength: 255
            language:
              type: string
              description: |-
                Payment link language that customers can change to English.

                <blockquote>                
                  <p>It is also used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
                </blockquote>
              enum:
                - cs
                - da
                - de
                - el
                - en
                - es
                - fi
                - fr
                - it
                - nl
                - 'no'
                - pl
                - pt
                - ro
                - sk
                - sv
                - uk
            website:
              type: string
              description: Website from which the transaction took place.
              maxLength: 255
            order_metadata:
              type: object
              description: Metadata is useful for storing additional, structured information about an object.
              additionalProperties:
                type: string
                maxLength: 380
              maxProperties: 10
            success_url:
              type: string
              description: URL for browser redirect after a successful payment.
              maxLength: 255
            fail_url:
              type: string
              description: |-
                URL for browser redirect after a failed payment.

                <blockquote style="border-left: 4px solid #F2C4C4;">
                  <p><b>Should not be</b> provided if you want to use the user's card details on a failed payment  for retry logic.</p>
                </blockquote>
              maxLength: 255
        page_customization:
          type: object
          description: Information required to <a href="https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/" target="_blank">customize</a> the payment page display.
          required:
            - public_name
          properties:
            public_name:
              type: string
              maxLength: 46
              description: |-
                Shop name.

                <blockquote>
                  <p>It is visible to customers on the payment page.</p>
                </blockquote>
            order_title:
              type: string
              maxLength: 100
              description: Names of goods or services you sell are visible to customers on the payment page.
            order_description:
              type: string
              description: |-
                A description of the order.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters.</p>
                </blockquote>

                <blockquote>                
                  <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
                </blockquote>
              maxLength: 401
            payment_methods:
              description: Additional <a href="https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments" target="_blank">alternative payment methods</a>.
              type: array
              items:
                type: string
            button_font_color:
              type: string
              description: |-
                Color of the font on the Pay Button.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to use HEX format.</p>
                </blockquote>
            button_color:
              type: string
              description: |-
                Color of the Pay Button.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to use HEX format.</p>
                </blockquote>
            font_name:
              type: string
              description: |-
                Font name on the payment page.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to use the Google Font name.</p>
                </blockquote>
              maxLength: 255
            is_cardholder_visible:
              type: boolean
              description: |-
                Display the field cardholder on the payment page.

                <blockquote>
                  <p>If the field is accepted as true, it will be displayed.</p>
                </blockquote>
            terms_url:
              type: string
              description: URL for the merchant Terms & Conditions will be attached to the checkbox.
              maxLength: 1000
            back_url:
              type: string
              description: |-
                URL where the customer should be redirected in case of clicks the <b>Back</b> button.

                <blockquote>
                  <p>Passing this parameter will add a <b>Back</b> button on your payment and status pages.</p>
                </blockquote>
              maxLength: 1000
        configuration:
          type: object
          description: Configuration settings for the payment link.
          properties:
            usage_mode:
              type: string
              default: reusable
              enum:
                - reusable
                - single_use
              description: |-
                Determines the payment link usage mode.
                - <code>reusable</code> allows multiple successful payments
                - <code>single_use</code> only one successful payment allowed per link
            amount_setter:
              type: string
              default: merchant
              enum:
                - merchant
                - payer
              description: |-
                Defines the method for setting the payment amount.
                - <code>merchant</code> the merchant sets the amount directly
                - <code>payer</code> the amount is determined based on payer input
    RequestCheckoutSolutionsCreateSubscriptionPaymentLink:
      title: Subscription payment
      type: object
      required:
        - order
        - page_customization
      properties:
        order:
          type: object
          description: Information required to create an order.
          required:
            - product_id
            - type
          properties:
            product_id:
              type: string
              description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier of the subscription.
              format: uuid
              maxLength: 36
              minLength: 36
            product_price_id:
              description: |-
                Unique product price identifier.

                Set `product_price_id` for the <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscription</a> flow and to ensure correct pricing, specifically for multi-currency products.

                <blockquote>
                  <p>To get <code>product_price_id</code>, use <a href="https://api-docs.solidgate.com/#tag/Products-and-prices/operation/get-product-prices" target="_blank">get product prices</a> request.</p>
                </blockquote>
              type: string
              format: uuid
            order_description:
              type: string
              description: |-
                A description of the order.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters.</p>
                </blockquote>

                <blockquote>                
                  <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
                </blockquote>
              maxLength: 255
            type:
              type: string
              deprecated: true
              description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
              enum:
                - auth
            settle_interval:
              type: integer
              description: |-
                Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
                - `240` hours = 10 days for Visa customer-initiated payments
                - `120` hours = 5 days for Visa merchant-initiated payments
                - `168` hours = 7 days for all other card brands

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
                </blockquote>
                <blockquote>
                  <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
                </blockquote>
              maximum: 240
              minimum: 0
            authorization_type:
              type: string
              enum:
                - final
              default: final
              description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
            google_pay_allowed_auth_methods:
              type: array
              description: |-
                Array of allowed Google Pay authorization methods.

                - `PAN_ONLY` - this authentication method is associated with payment cards stored on file with the user’s Google Account. Returned payment data includes primary account number (PAN) with the expiration month and the expiration year.
                - `CRYPTOGRAM_3DS` - this authentication method is associated with cards stored as Android device tokens. Returned payment data includes a 3D Secure (3DS) cryptogram generated on the device.

                <blockquote>
                  <p>The capability to transmit only <code>PAN_ONLY</code> or <code>CRYPTOGRAM_3DS</code> is also available, and such transmission will work for both one-time payments and <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscriptions</a>.</p>
                </blockquote>
            traffic_source:
              type: string
              description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
              maxLength: 255
            transaction_source:
              type: string
              description: Identifies the internal system or flow that triggered the transaction.
              maxLength: 255
            language:
              type: string
              description: |-
                Payment link language that customers can change to English.

                <blockquote>                
                  <p>It is also used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
                </blockquote>
              enum:
                - cs
                - da
                - de
                - el
                - en
                - es
                - fi
                - fr
                - it
                - nl
                - 'no'
                - pl
                - pt
                - ro
                - sk
                - sv
                - uk
            website:
              type: string
              description: Website from which the transaction took place.
              maxLength: 255
            order_metadata:
              type: object
              description: Metadata is useful for storing additional, structured information about an object.
              additionalProperties:
                type: string
                maxLength: 380
              maxProperties: 10
            success_url:
              type: string
              description: URL for browser redirect after a successful payment.
              maxLength: 255
            fail_url:
              type: string
              description: |-
                URL for browser redirect after a failed payment.

                <blockquote style="border-left: 4px solid #F2C4C4;">
                  <p><b>Should not be</b> provided if you want to use the user's card details on a failed payment  for retry logic.</p>
                </blockquote>
              maxLength: 255
        page_customization:
          type: object
          description: Information required to <a href="https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/" target="_blank">customize</a> the payment page display.
          required:
            - public_name
          properties:
            public_name:
              type: string
              maxLength: 46
              description: |-
                Shop name.

                <blockquote>
                  <p>It is visible to customers on the payment page.</p>
                </blockquote>
            order_title:
              type: string
              maxLength: 100
              description: Names of goods or services you sell are visible to customers on the payment page.
            order_description:
              type: string
              description: |-
                A description of the order.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to keep the description brief to improve the clarity of payment processing, ideally not exceeding 100 characters.</p>
                </blockquote>

                <blockquote>                
                  <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
                </blockquote>
              maxLength: 401
            payment_methods:
              description: Additional <a href="https://docs.solidgate.com/payments/integrate/payment-page/customize-payment-page/#alternative-payments" target="_blank">alternative payment methods</a>.
              type: array
              items:
                type: string
            button_font_color:
              type: string
              description: |-
                Color of the font on the Pay Button.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to use HEX format.</p>
                </blockquote>
            button_color:
              type: string
              description: |-
                Color of the Pay Button.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to use HEX format.</p>
                </blockquote>
            font_name:
              type: string
              description: |-
                Font name on the payment page.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to use the Google Font name.</p>
                </blockquote>
              maxLength: 255
            is_cardholder_visible:
              type: boolean
              description: |-
                Display the field cardholder on the payment page.

                <blockquote>
                  <p>If the field is accepted as true, it will be displayed.</p>
                </blockquote>
            terms_url:
              type: string
              description: URL for the merchant Terms & Conditions will be attached to the checkbox.
              maxLength: 1000
            back_url:
              type: string
              description: |-
                RL where the customer should be redirected in case of clicks the <b>Back</b> button.

                <blockquote>
                  <p>Passing this parameter will add a <b>Back</b> button on your payment and status pages.</p>
                </blockquote>
              maxLength: 1000
    ResponseCheckoutSolutionsLink:
      title: Success
      type: object
      properties:
        url:
          type: string
          description: Specific URL where the customer should be directed to complete their transaction.
          example: https://payment-page.solidgate.com/link/Q6J3212g7K
        id:
          type: string
          description: Unique payment link identifier.
          example: Q6J3212g7K
      required:
        - url
        - id
    RequestCheckoutSolutionsDeactivateLink:
      title: Deactivate payment link
      type: object
      required:
        - id
      properties:
        id:
          type: string
          description: |-
            Unique payment link identifier.

            <blockquote>                
              <p>Can be found at the end of the payment link URL.</p>
            </blockquote>
          example: Q6J3212g7K
    SchemaCardsExternalMpiDsVersion:
      description: |-
        Required information to process a payment that has been 3DS authenticated using a third-party merchant plug-in (MPI).

        <blockquote style="border-left: 4px solid #F2E7C4; ">
          <p><b>Highly recommended</b> to provide this data, as it reduces the risk of transaction failures.</p>
        </blockquote>
      required:
        - three_ds_version
        - eci
        - cryptogram
        - ds_transaction_id
        - authentication_response
        - three_ds_flow
      properties:
        three_ds_version:
          type: string
          description: |-
            Indicates the version of 3D Secure used for authentication.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in the <code>2.X.X</code> pattern.</p>
            </blockquote>
          enum:
            - 2.1.0
            - 2.2.0
        three_ds_flow:
          type: string
          description: Identifies the authentication <a href="https://docs.solidgate.com/payments/card-payments/3ds-verification/#mpi-data-insights" target="_blank">flow</a>.
          enum:
            - frictionless
            - challenge
            - none
        acs_challenge_mandated_ind:
          type: string
          description: |-
            Indicates the issuer preference for whether or not a 3DS challenge should be performed.

            The issuer has the final say on whether or not the customer receives the challenge.

            <blockquote>
              <p>Possible values as they are defined in 3D Secure 2 protocols.</p>
            </blockquote>
          minLength: 1
          maxLength: 1
        transaction_challenge_exemption:
          type: string
          description: |-
            Access Control Server (ACS) applies an exemption to authenticate the transaction without requesting a challenge. 

            <blockquote>
              <p>Possible values as they are defined in 3D Secure 2 protocols.</p>
            </blockquote>
          minLength: 2
          maxLength: 2
        challenge_cancel_ind:
          type: string
          description: |-
            Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.

            <blockquote>
              <p>Possible values as defined in 3D Secure 2 protocols.</p>
            </blockquote>
          minLength: 2
          maxLength: 2
        eci:
          type: string
          description: Electronic Commerce Indicator (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/" target="_blank">ECI</a>) level associated with the 3D Secure enrollment result.
          minLength: 1
          maxLength: 2
        cryptogram:
          type: string
          description: |-
            Base64 encoded cardholder authentication value (20 bytes in decoded form) used for validating the authentication result.

            In 3D Secure 2 this is the `authenticationValue` returned in the ARes (if <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">frictionless flow</a>) or the RReq (if a <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">challenge flow</a>).
          minLength: 1
          maxLength: 64
        cryptogram_algorithm:
          type: string
          description: Algorithm used by Issuer Access Control Server (ACS) to calculate the cryptogram.
          minLength: 1
          maxLength: 1
        authentication_response:
          type: string
          description: |-
            Transaction <a href="https://docs.solidgate.com/payments/card-payments/3ds-verification/#mpi-data-insights" target="_blank">status</a> is returned from the card Issuer’s Access Control Server (ACS) or Scheme Directory Server (DS).

            This is the value from `transStatus` received in:
            - the ARes (Authentication Response) message in case of <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">frictionless flow</a>
            - the last CRes (Challenge Response) message in case of <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">challenge flow</a>
            - or in the RReq (Results Request) message sent after the cardholder completes the challenge

            <blockquote>
              <p>If the transaction was frictionless, there are no CRes or RReq messages.</p>
            </blockquote>
          enum:
            - 'Y'
            - A
        ds_transaction_reason:
          type: string
          description: |-
            Code indicating the reason for the `transStatus` in 3D Secure 2.

            <blockquote>
              <p>Possible values as defined in 3D Secure 2 protocols.</p>
            </blockquote>
          minLength: 2
          maxLength: 2
        ds_transaction_id:
          type: string
          description: |-
            Transaction identifier assigned by the Directory Server (DS) to identify a single transaction.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for <code>eci</code> values <code>01</code>, <code>02</code>, <code>05</code>, and <code>06</code> when 3DS2 is used.</p>
            </blockquote>
          minLength: 1
          maxLength: 100
        three_ds_server_transaction_id:
          type: string
          description: Identifier assigned by the 3D Secure 2 server to a single transaction.
          minLength: 1
          maxLength: 100
        acs_transaction_id:
          type: string
          description: Transaction identifier assigned by the ACS to identify a single transaction.
          minLength: 36
          maxLength: 36
          format: uuid
        authentication_method:
          type: array
          description: |-
            Indicates the authentication <a href="https://docs.solidgate.com/payments/card-payments/3ds-verification/#mpi-data-insights" target="_blank">types</a> the issuer will use to challenge the cardholder in the ARes message, or those used by the ACS in the RReq message.

            <blockquote>
              <p>Value <code>12</code> (decoupled) is not supported.</p>
            </blockquote>
          items:
            type: string
            minLength: 2
            maxLength: 2
        authentication_timestamp:
          type: string
          description: Authentication datetime in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO-8601</a>.
          minLength: 6
          maxLength: 25
    SchemaCardsIndustryDataAirline:
      title: SchemaCardsIndustryDataAirline
      type: object
      required:
        - type
        - airline
      properties:
        type:
          type: string
          description: Type of entity used to identify the classification of the data being provided.
          enum:
            - airline
        airline:
          type: array
          minItems: 1
          description: Airline-related details.
          items:
            type: object
            required:
              - airline_code
              - airline_designator_code
              - airline_name
              - document_type
              - travel_agency_code
              - ticket
              - passenger
              - flight_legs
            additionalProperties: false
            properties:
              airline_code:
                type: string
                description: <a href="https://www.iata.org/en/services/codes" target="_blank">IATA</a> 3-digit accounting code (PAX) that identifies the carrier.
                maxLength: 3
                minLength: 3
              airline_designator_code:
                type: string
                description: <a href="https://www.iata.org/en/services/codes" target="_blank">IATA</a> 2-letter accounting code (PAX) that identifies the carrier.
              airline_name:
                type: string
                description: Name of the airline, as displayed on the bill.
                maxLength: 255
              boarding_fee:
                type: string
                description: Amount charged for boarding the plane, in minor units.
                minLength: 1
                maxLength: 18
              computerized_reservation_system:
                type: string
                description: <a href="https://en.wikipedia.org/wiki/Computer_reservation_system" target="_blank">CRS</a> used to make the reservation and purchase the ticket.
                minLength: 4
                maxLength: 4
              customer_reference_number:
                type: string
                maxLength: 20
                description: Alphanumeric customer reference number.
              document_type:
                type: string
                description: |-
                  A code identifying the type of item bought.

                  - <code>01</code> ticket
                  - <code>02</code> baggage receipt
                  - <code>03</code> exchange ticket
                  - <code>04</code> Miscellaneous Charges Order (MCO)
                  - <code>05</code> Electronic Miscellaneous Document (EMD)
                enum:
                  - '01'
                  - '02'
                  - '03'
                  - '04'
                  - '05'
              flight_date:
                type: string
                description: Datetime of flight departure.
                minLength: 10
                maxLength: 16
              agency_plan_name:
                type: string
                description: Two-letter agency plan identifier.
                minLength: 2
                maxLength: 2
              travel_agency_name:
                type: string
                description: Name of the travel agency.
                minLength: 1
                maxLength: 25
              travel_agency_code:
                type: string
                description: Unique identifier from <a href="https://www.iata.org/en/services/codes" target="_blank">IATA</a> for travel agency that issues the ticket.
                minLength: 1
                maxLength: 8
              agency_invoice_number:
                type: string
                description: Reference number for the invoice issued by the agency.
                minLength: 1
                maxLength: 6
              ticket:
                required:
                  - number
                  - issue_date
                  - issue_address
                description: Ticket-related details.
                additionalProperties: false
                properties:
                  number:
                    type: string
                    description: Unique identifier for the ticket.
                    minLength: 1
                    maxLength: 15
                  issue_date:
                    type: string
                    description: Date the ticket was issued to the passenger.
                    minLength: 6
                    maxLength: 6
                    format: YYMMDD
                  restricted:
                    type: boolean
                    description: Indicates if the ticket is restricted.
                    default: false
                  issue_address:
                    type: object
                    description: Address where the ticket was issued.
                    required:
                      - line1
                      - city
                      - country
                      - postal
                    additionalProperties: false
                    properties:
                      line1:
                        type: string
                        description: First line of the issue address.
                        minLength: 0
                        maxLength: 16
                      city:
                        type: string
                        description: City where the ticket was issued.
                        maxLength: 100
                      country:
                        type: string
                        description: Country where the ticket was issued.
                        format: iso_code_a3
                        minLength: 3
                        maxLength: 3
                      postal:
                        type: string
                        description: Postal code where the ticket was issued.
                        maxLength: 10
              passenger:
                type: object
                description: Passenger-related details.
                required:
                  - first_name
                  - last_name
                additionalProperties: false
                properties:
                  first_name:
                    type: string
                    description: First name of the passenger.
                    maxLength: 100
                  last_name:
                    type: string
                    description: Last name of the passenger.
                    maxLength: 100
                  date_of_birth:
                    type: string
                    description: Date of birth of the passenger.
                    format: yyyy-MM-dd
                    minLength: 10
                    maxLength: 10
                  phone_number:
                    type: string
                    description: Phone number of the passenger, including country code.
                    minLength: 3
                    maxLength: 30
                  traveller_type:
                    type: string
                    description: |-
                      <a href="https://www.iata.org/en/services/codes" target="_blank">IATA</a> passenger type code (PTC).

                      - <code>ADT</code> adult
                      - <code>CHD</code> child
                      - <code>INF</code> infant
                      - <code>SRC</code>/<code>YTH</code> student/youth
                      - <code>MIL</code> military, etc.
                    enum:
                      - ADT
                      - CHD
                      - INF
                      - SRC
                      - YTH
                      - MIL
                  code:
                    type: string
                    description: Passenger-specific code for identifying the traveler.
                    maxLength: 255
              flight_legs:
                type: array
                description: Flight legs details.
                minItems: 1
                maxItems: 4
                items:
                  type: object
                  required:
                    - flight_number
                    - carrier_code
                    - class_of_travel
                    - departure_date
                    - departure_airport
                    - arrival_airport
                  additionalProperties: false
                  properties:
                    flight_number:
                      type: string
                      description: Flight identifier.
                      minLength: 1
                      maxLength: 5
                    carrier_code:
                      type: string
                      description: <a href="https://www.iata.org/en/services/codes" target="_blank">IATA</a> 2-letter accounting code (PAX) that identifies the carrier.
                      minLength: 2
                      maxLength: 2
                    class_of_travel:
                      type: string
                      description: |-
                        A one-letter identifier for the travel class.

                        - <code>F</code> first class
                        - <code>J</code> business class
                        - <code>Y</code> economy class
                        - <code>W</code> premium economy, etc.
                      enum:
                        - F
                        - J
                        - 'Y'
                        - W
                    departure_date:
                      type: string
                      description: Datetime of travel in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
                      minLength: 16
                      maxLength: 16
                    departure_airport:
                      type: string
                      description: <a href="https://www.iata.org/en/services/codes" target="_blank">IATA</a> 3-letter airport code of the departure airport.
                      minLength: 3
                      maxLength: 3
                    departure_tax:
                      type: string
                      description: Amount of departure tax charged, in minor units.
                      minLength: 1
                      maxLength: 12
                    arrival_airport:
                      type: string
                      description: <a href="https://www.iata.org/en/services/codes" target="_blank">IATA</a> 3-letter airport code of the destination airport.
                      minLength: 3
                      maxLength: 3
                    fare_base_code:
                      type: string
                      description: Fare basis code.
                      minLength: 1
                      maxLength: 15
                    stop_over_code:
                      type: string
                      description: A one-letter code indicating stopover eligibility.
                      enum:
                        - O
                        - X
                      default: X
    SchemaCardsIndustryDataDiscriminatorAirline:
      title: SchemaCardsIndustryDataDiscriminatorAirline
      type: object
      description: |-
        <a href="https://docs.solidgate.com/payments/card-payments/industry-data/" target="_blank">Industry-related</a> data for airline payments.

        <blockquote>
          <p>Applicable to merchants operating under airline-related MCCs 3000–3350 or travel agencies MCC 4722.</p>
          <p>Supplying this enriched data can help reduce fees, improve fraud detection and dispute handling, increase customer trust, and support industry compliance.</p>
        </blockquote>
      properties:
        type:
          type: string
      discriminator:
        propertyName: type
        mapping:
          airline: '#/components/schemas/SchemaCardsIndustryDataAirline'
    SchemaCardsShippingAddressAppleGoogle:
      title: CardShippingAddressModel
      type: object
      description: |-
        Address to ship.

        <blockquote>
          <p>If this field is passed by the merchant - the customer cannot change this address.</p>
        </blockquote>
      properties:
        country:
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the shipping address.
          format: iso_code_a3
          example: USA
          maxLength: 3
          minLength: 3
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the shipping address.
          maxLength: 10
          example: NY
        city:
          type: string
          description: Shipping address city.
          maxLength: 100
          example: Boston
        zip:
          type: string
          description: Address zip/postal code where the person, business or institution is located.
          maxLength: 10
          example: '91191'
        address:
          type: string
          description: First and second line of the shipping address.
          maxLength: 100
          example: 123 Main St
    SchemaCardsDeviceSession:
      title: SchemaCardsDeviceSession
      type: object
      properties:
        id:
          type: string
          description: Unique device session identifier.
          maxLength: 255
          example: dsid_3a20_f9c1_4cd8_89d3_1c5
        provider:
          type: string
          description: Third-party provider for the device session.
          enum:
            - checkout
            - airwallex
          example: checkout
    SchemaCardsDeviceSessions:
      title: SchemaCardsDeviceSessions
      type: array
      description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/device-sessions/" target="_blank">Device sessions</a> with session ID and provider.
      items:
        $ref: '#/components/schemas/SchemaCardsDeviceSession'
    RequestCardsCharge:
      title: PAN Payment
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - payment_type
        - customer_email
        - ip_address
        - platform
        - card_number
        - card_exp_month
        - card_exp_year
        - type
      properties:
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The value <strong>0</strong> is valid only for <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount</a> flow. If set to <strong>null</strong>, the default fallback value <strong>0</strong> will be used. </p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        card_data_type:
          type: string
          description: Card data <a href="https://docs.solidgate.com/payments/card-payments/token-usage/#network-tokens" target="_blank">type</a>.
          default: pan
          enum:
            - pan
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
            - estimated
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        payment_type:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided. 

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_cvv</code> is not provided.</p>
              <p>Payment will be <b>declined</b> if:</p>
                <ul>
                  <li>neither <code>card_cvv</code> nor <code>payment_type</code> is specified</li>
                  <li><code>card_cvv</code> is specified alongside the <code>payment_type</code> <code>moto</code></li>
                </ul>
            </blockquote>
          enum:
            - 1-click
            - recurring
            - retry
            - installment
            - rebill
            - moto
        scheme_transaction_id:
          type: string
          description: |-
            Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments.
            - **Mastercard**: Alphanumeric (max length 16)
              - Positions 1-3: Financial Network Code
              - Positions 4-9: Banknet Reference Number
              - Positions 10-12: Space filled
              - Positions 13-16: Banknet Settlement Date
            - **Visa**: Numeric (15)
            - **Amex**: Alphanumeric (15)
            - **Discover**: Alphanumeric (16)

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with <code>payment_type</code> <code>moto</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to specify this parameter with <code>payment_type</code> <code>recurring</code>, <code>retry</code>, <code>installment</code>, or <code>rebill</code>, as the <code>scheme_transaction_id</code> ensures continuity between MITs and the original CIT.</p>
            </blockquote>
        transaction_link_id:
          type: string
          description: |-
            Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with customer-initiated (CIT) <code>payment_type</code> <code>moto</code> or <code>1-click</code> and <code>card_cvv</code>.</p>
            </blockquote>
          maxLength: 255
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to set <code>true</code> and send it with the <code>external_mpi_data</code> object, as it helps optimize payment success rates.</p>
            </blockquote>
          default: false
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersion'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_number:
          type: string
          description: |-
            Primary account number (PAN) of the card.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in its <strong>unmasked format</strong>, containing the full Primary Account Number (PAN) without any masked digits.</p>
            </blockquote>
          minLength: 12
          maxLength: 19
          pattern: ^[0-9]{12,19}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
          example: John Snow
        card_exp_month:
          type: string
          description: Expiry month of the card.
          minLength: 2
          maxLength: 2
        card_exp_year:
          type: integer
          description: Expiry year of the card.
        card_cvv:
          type: string
          description: Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.
          pattern: ^[0-9]{3,4}$
        card_pin:
          type: string
          description: |-
            Personal identification number (PIN) associated with the card.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> only for VERVE card brand.</p>
            </blockquote>
          maxLength: 10
        industry_data:
          $ref: '#/components/schemas/SchemaCardsIndustryDataDiscriminatorAirline'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          maxLength: 3
          minLength: 3
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsPaymentChargeDataTypeDpanApple:
      title: Payment
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - payment_type
        - dpan_source
        - scheme_transaction_id
        - customer_email
        - ip_address
        - platform
        - card_number
        - card_exp_month
        - card_exp_year
        - type
      properties:
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The value <strong>0</strong> is valid only for <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount</a> flow. If set to <strong>null</strong>, the default fallback value <strong>0</strong> will be used. </p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        card_data_type:
          type: string
          description: |-
            Card data <a href="https://docs.solidgate.com/payments/card-payments/token-usage/#network-tokens" target="_blank">type</a>.

            <blockquote>
              <p>If <code>card_data_type</code> is not provided, the default <code>pan</code> assumed for one-time payment with PAN.</p>
            </blockquote>
          default: pan
          enum:
            - dpan
        dpan_source:
          type: string
          description: |-
            Source for network tokens generated through Apple Pay.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_data_type</code> <code>dpan</code> is provided.</p>
            </blockquote>
          default: apple-pay
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
            - estimated
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        payment_type:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided. 

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_cvv</code> is not provided.</p>
              <p>Payment will be <b>declined</b> if:</p>
                <ul>
                  <li>neither <code>card_cvv</code> nor <code>payment_type</code> is specified</li>
                  <li><code>card_cvv</code> is specified alongside the <code>payment_type</code> <code>moto</code></li>
                </ul>
            </blockquote>
          enum:
            - recurring
            - retry
            - installment
            - rebill
            - moto
        scheme_transaction_id:
          type: string
          description: |-
            Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments.
            - **Mastercard**: Alphanumeric (max length 16)
              - Positions 1-3: Financial Network Code
              - Positions 4-9: Banknet Reference Number
              - Positions 10-12: Space filled
              - Positions 13-16: Banknet Settlement Date
            - **Visa**: Numeric (15)
            - **Amex**: Alphanumeric (15)
            - **Discover**: Alphanumeric (16)

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with <code>payment_type</code> <code>moto</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to specify this parameter with <code>payment_type</code> <code>recurring</code>, <code>retry</code>, <code>installment</code>, or <code>rebill</code>, as the <code>scheme_transaction_id</code> ensures continuity between MITs and the original CIT.</p>
            </blockquote>
        transaction_link_id:
          type: string
          description: |-
            Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with customer-initiated (CIT) <code>payment_type</code> <code>moto</code> or <code>1-click</code> and <code>card_cvv</code>.</p>
            </blockquote>
          maxLength: 255
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Should not be</b> provided with <code>true</code>.</p>
            </blockquote>
          default: false
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersion'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_number:
          type: string
          description: |-
            Primary account number (PAN) of the card.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in its <strong>unmasked format</strong>, containing the full Primary Account Number (PAN) without any masked digits.</p>
            </blockquote>
          minLength: 12
          maxLength: 19
          pattern: ^[0-9]{12,19}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
          example: John Snow
        card_exp_month:
          type: string
          description: Expiry month of the card.
          minLength: 2
          maxLength: 2
        card_exp_year:
          type: integer
          description: Expiry year of the card.
        card_cvv:
          type: string
          description: Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.
          pattern: ^[0-9]{3,4}$
        card_pin:
          type: string
          description: |-
            Personal identification number (PIN) associated with the card.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> only for VERVE card brand.</p>
            </blockquote>
          maxLength: 10
        industry_data:
          $ref: '#/components/schemas/SchemaCardsIndustryDataDiscriminatorAirline'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          maxLength: 3
          minLength: 3
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsPaymentChargeDataTypeDpanGoogle:
      title: Payment
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - payment_type
        - dpan_source
        - scheme_transaction_id
        - customer_email
        - ip_address
        - platform
        - card_number
        - card_exp_month
        - card_exp_year
        - type
      properties:
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The value <strong>0</strong> is valid only for <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount</a> flow. If set to <strong>null</strong>, the default fallback value <strong>0</strong> will be used. </p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        card_data_type:
          type: string
          description: |-
            Card data <a href="https://docs.solidgate.com/payments/card-payments/token-usage/#network-tokens" target="_blank">type</a>.

            <blockquote>
              <p>If <code>card_data_type</code> is not provided, the default <code>pan</code> assumed for one-time payment with PAN.</p>
            </blockquote>
          default: pan
          enum:
            - dpan
        dpan_source:
          type: string
          description: |-
            Source for network tokens generated through Google Pay.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_data_type</code> <code>dpan</code> is provided.</p>
            </blockquote>
          default: google-pay
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
            - estimated
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        payment_type:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided. 

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_cvv</code> is not provided.</p>
              <p>Payment will be <b>declined</b> if:</p>
                <ul>
                  <li>neither <code>card_cvv</code> nor <code>payment_type</code> is specified</li>
                  <li><code>card_cvv</code> is specified alongside the <code>payment_type</code> <code>moto</code></li>
                </ul>
            </blockquote>
          enum:
            - recurring
            - retry
            - installment
            - rebill
            - moto
        scheme_transaction_id:
          type: string
          description: |-
            Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments.
            - **Mastercard**: Alphanumeric (max length 16)
              - Positions 1-3: Financial Network Code
              - Positions 4-9: Banknet Reference Number
              - Positions 10-12: Space filled
              - Positions 13-16: Banknet Settlement Date
            - **Visa**: Numeric (15)
            - **Amex**: Alphanumeric (15)
            - **Discover**: Alphanumeric (16)

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with <code>payment_type</code> <code>moto</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to specify this parameter with <code>payment_type</code> <code>recurring</code>, <code>retry</code>, <code>installment</code>, or <code>rebill</code>, as the <code>scheme_transaction_id</code> ensures continuity between MITs and the original CIT.</p>
            </blockquote>
        transaction_link_id:
          type: string
          description: |-
            Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with customer-initiated (CIT) <code>payment_type</code> <code>moto</code> or <code>1-click</code> and <code>card_cvv</code>.</p>
            </blockquote>
          maxLength: 255
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Should not be</b> provided with <code>true</code>.</p>
            </blockquote>
          default: false
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersion'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_number:
          type: string
          description: |-
            Primary account number (PAN) of the card.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in its <strong>unmasked format</strong>, containing the full Primary Account Number (PAN) without any masked digits.</p>
            </blockquote>
          minLength: 12
          maxLength: 19
          pattern: ^[0-9]{12,19}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
          example: John Snow
        card_exp_month:
          type: string
          description: Expiry month of the card.
          minLength: 2
          maxLength: 2
        card_exp_year:
          type: integer
          description: Expiry year of the card.
        card_cvv:
          type: string
          description: Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.
          pattern: ^[0-9]{3,4}$
        card_pin:
          type: string
          description: |-
            Personal identification number (PIN) associated with the card.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> only for VERVE card brand.</p>
            </blockquote>
          maxLength: 10
        industry_data:
          $ref: '#/components/schemas/SchemaCardsIndustryDataDiscriminatorAirline'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          maxLength: 3
          minLength: 3
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsExternalMpiDsVersionDpanCitMit:
      description: |-
        Required information to process a payment that has been 3DS authenticated using a third-party merchant plug-in (MPI).

        <blockquote style="border-left: 4px solid #F2E7C4; ">
          <p><b>Highly recommended</b> to provide this data, as it reduces the risk of transaction failures.</p>
        </blockquote>
      required:
        - three_ds_version
        - eci
        - cryptogram
        - ds_transaction_id
        - authentication_response
        - three_ds_flow
      properties:
        three_ds_version:
          type: string
          description: |-
            Indicates the version of 3D Secure used for authentication.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in the <code>2.X.X</code> pattern.</p>
            </blockquote>
          enum:
            - 2.1.0
            - 2.2.0
        three_ds_flow:
          type: string
          description: Identifies the authentication <a href="https://docs.solidgate.com/payments/card-payments/3ds-verification/#mpi-data-insights" target="_blank">flow</a>.
          enum:
            - frictionless
            - challenge
            - none
        acs_challenge_mandated_ind:
          type: string
          description: |-
            Indicates the issuer preference for whether or not a 3DS challenge should be performed.

            The issuer has the final say on whether or not the customer receives the challenge.

            <blockquote>
              <p>Possible values as they are defined in 3D Secure 2 protocols.</p>
            </blockquote>
          minLength: 1
          maxLength: 1
        transaction_challenge_exemption:
          type: string
          description: |-
            Access Control Server (ACS) applies an exemption to authenticate the transaction without requesting a challenge. 

            <blockquote>
              <p>Possible values as they are defined in 3D Secure 2 protocols.</p>
            </blockquote>
          minLength: 2
          maxLength: 2
        challenge_cancel_ind:
          type: string
          description: |-
            Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled.

            <blockquote>
              <p>Possible values as defined in 3D Secure 2 protocols.</p>
            </blockquote>
          minLength: 2
          maxLength: 2
        eci:
          type: string
          description: Electronic Commerce Indicator (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/" target="_blank">ECI</a>) level associated with the 3D Secure enrollment result.
          minLength: 1
          maxLength: 2
        cryptogram:
          type: string
          description: |-
            Base64 encoded cardholder authentication value (20 bytes in decoded form) used for validating the authentication result.

            In 3D Secure 2 this is the `authenticationValue` returned in the ARes (if <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">frictionless flow</a>) or the RReq (if a <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">challenge flow</a>).

            <blockquote style="border-left: 4px solid #D1E6DF; ">
                <p><b>Should be provided</b> together with <code>payment_type</code> <code>1-click</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 64
        cryptogram_algorithm:
          type: string
          description: Algorithm used by Issuer Access Control Server (ACS) to calculate the cryptogram.
          minLength: 1
          maxLength: 1
        authentication_response:
          type: string
          description: |-
            Transaction <a href="https://docs.solidgate.com/payments/card-payments/3ds-verification/#mpi-data-insights" target="_blank">status</a> is returned from the card Issuer’s Access Control Server (ACS) or Scheme Directory Server (DS).

            This is the value from `transStatus` received in:
            - the ARes (Authentication Response) message in case of <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">frictionless flow</a>
            - the last CRes (Challenge Response) message in case of <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">challenge flow</a>
            - or in the RReq (Results Request) message sent after the cardholder completes the challenge

            <blockquote>
              <p>If the transaction was frictionless, there are no CRes or RReq messages.</p>
            </blockquote>
          enum:
            - 'Y'
            - A
        ds_transaction_reason:
          type: string
          description: |-
            Code indicating the reason for the `transStatus` in 3D Secure 2.

            <blockquote>
              <p>Possible values as defined in 3D Secure 2 protocols.</p>
            </blockquote>
          minLength: 2
          maxLength: 2
        ds_transaction_id:
          type: string
          description: |-
            Transaction identifier assigned by the Directory Server (DS) to identify a single transaction.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for <code>eci</code> values <code>01</code>, <code>02</code>, <code>05</code>, and <code>06</code> when 3DS2 is used.</p>
            </blockquote>
          minLength: 1
          maxLength: 100
        three_ds_server_transaction_id:
          type: string
          description: Identifier assigned by the 3D Secure 2 server to a single transaction.
          minLength: 1
          maxLength: 100
        acs_transaction_id:
          type: string
          description: Transaction identifier assigned by the ACS to identify a single transaction.
          minLength: 36
          maxLength: 36
          format: uuid
        authentication_method:
          type: array
          description: |-
            Indicates the authentication <a href="https://docs.solidgate.com/payments/card-payments/3ds-verification/#mpi-data-insights" target="_blank">types</a> the issuer will use to challenge the cardholder in the ARes message, or those used by the ACS in the RReq message.

            <blockquote>
              <p>Value <code>12</code> (decoupled) is not supported.</p>
            </blockquote>
          items:
            type: string
            minLength: 2
            maxLength: 2
        authentication_timestamp:
          type: string
          description: Authentication datetime in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO-8601</a>.
          minLength: 6
          maxLength: 25
    SchemaCardsPaymentChargeDataTypeDpanVts:
      title: Payment
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - payment_type
        - dpan_source
        - customer_email
        - ip_address
        - platform
        - card_number
        - card_exp_month
        - card_exp_year
        - type
      properties:
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The value <strong>0</strong> is valid only for <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount</a> flow. If set to <strong>null</strong>, the default fallback value <strong>0</strong> will be used. </p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        card_data_type:
          type: string
          description: |-
            Card data <a href="https://docs.solidgate.com/payments/card-payments/token-usage/#network-tokens" target="_blank">type</a>.

            <blockquote>
              <p>If <code>card_data_type</code> is not provided, the default <code>pan</code> assumed for one-time payment with PAN.</p>
            </blockquote>
          default: pan
          enum:
            - dpan
        dpan_source:
          type: string
          description: |-
            Source for network tokens generated through Visa Token Service (VTS).

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_data_type</code> <code>dpan</code> is provided.</p>
            </blockquote>
          default: vts
        eci:
          type: string
          description: |-
            Electronic Commerce Indicator (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/" target="_blank">ECI</a>) level associated with the network token authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to provide with <code>payment_type</code> <code>1-click</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 2
        cryptogram:
          type: string
          description: |-
            Base64 encoded cardholder authentication value provided with the network token and used for validating the authentication result.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> with <code>payment_type</code> <code>1-click</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 64
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
            - estimated
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        payment_type:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided. 

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_cvv</code> is not provided.</p>
              <p>Payment will be <b>declined</b> if:</p>
                <ul>
                  <li>neither <code>card_cvv</code> nor <code>payment_type</code> is specified</li>
                  <li><code>card_cvv</code> is specified alongside the <code>payment_type</code> <code>moto</code></li>
                </ul>
            </blockquote>
          enum:
            - 1-click
            - recurring
            - retry
            - installment
            - rebill
            - moto
        scheme_transaction_id:
          type: string
          description: |-
            Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments.
            - **Mastercard**: Alphanumeric (max length 16)
              - Positions 1-3: Financial Network Code
              - Positions 4-9: Banknet Reference Number
              - Positions 10-12: Space filled
              - Positions 13-16: Banknet Settlement Date
            - **Visa**: Numeric (15)
            - **Amex**: Alphanumeric (15)
            - **Discover**: Alphanumeric (16)

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with <code>payment_type</code> <code>moto</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to specify this parameter with <code>payment_type</code> <code>recurring</code>, <code>retry</code>, <code>installment</code>, or <code>rebill</code>, as the <code>scheme_transaction_id</code> ensures continuity between MITs and the original CIT.</p>
            </blockquote>
        transaction_link_id:
          type: string
          description: |-
            Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with customer-initiated (CIT) <code>payment_type</code> <code>moto</code> or <code>1-click</code> and <code>card_cvv</code>.</p>
            </blockquote>
          maxLength: 255
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to set <code>true</code> with <code>payment_type</code> <code>recurring</code>, <code>retry</code>, <code>installment</code>, or <code>rebill</code> and send it with the <code>external_mpi_data</code> object.</p>
            </blockquote>
          default: false
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersionDpanCitMit'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_number:
          type: string
          description: |-
            Primary account number (PAN) of the card.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in its <strong>unmasked format</strong>, containing the full Primary Account Number (PAN) without any masked digits.</p>
            </blockquote>
          minLength: 12
          maxLength: 19
          pattern: ^[0-9]{12,19}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
          example: John Snow
        card_exp_month:
          type: string
          description: Expiry month of the card.
          minLength: 2
          maxLength: 2
        card_exp_year:
          type: integer
          description: Expiry year of the card.
        card_cvv:
          type: string
          description: Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.
          pattern: ^[0-9]{3,4}$
        card_pin:
          type: string
          description: |-
            Personal identification number (PIN) associated with the card.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> only for VERVE card brand.</p>
            </blockquote>
          maxLength: 10
        industry_data:
          $ref: '#/components/schemas/SchemaCardsIndustryDataDiscriminatorAirline'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          maxLength: 3
          minLength: 3
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsPaymentChargeDataTypeDpanMdes:
      title: Payment
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - payment_type
        - dpan_source
        - customer_email
        - ip_address
        - platform
        - card_number
        - card_exp_month
        - card_exp_year
        - type
      properties:
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The value <strong>0</strong> is valid only for <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount</a> flow. If set to <strong>null</strong>, the default fallback value <strong>0</strong> will be used. </p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        card_data_type:
          type: string
          description: |-
            Card data <a href="https://docs.solidgate.com/payments/card-payments/token-usage/#network-tokens" target="_blank">type</a>.

            <blockquote>
              <p>If <code>card_data_type</code> is not provided, the default <code>pan</code> assumed for one-time payment with PAN.</p>
            </blockquote>
          default: pan
          enum:
            - dpan
        dpan_source:
          type: string
          description: |-
            Source for network tokens generated through Mastercard Digital Enablement Service (MDES).

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_data_type</code> <code>dpan</code> is provided.</p>
            </blockquote>
          default: mdes
        eci:
          type: string
          description: |-
            Electronic Commerce Indicator (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/" target="_blank">ECI</a>) level associated with the network token authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to provide with <code>payment_type</code> <code>1-click</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 2
        cryptogram:
          type: string
          description: |-
            Base64 encoded cardholder authentication value provided with the network token and used for validating the authentication result.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> with <code>payment_type</code> <code>1-click</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 64
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
            - estimated
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        payment_type:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided. 

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_cvv</code> is not provided.</p>
              <p>Payment will be <b>declined</b> if:</p>
                <ul>
                  <li>neither <code>card_cvv</code> nor <code>payment_type</code> is specified</li>
                  <li><code>card_cvv</code> is specified alongside the <code>payment_type</code> <code>moto</code></li>
                </ul>
            </blockquote>
          enum:
            - 1-click
            - recurring
            - retry
            - installment
            - rebill
            - moto
        scheme_transaction_id:
          type: string
          description: |-
            Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments.
            - **Mastercard**: Alphanumeric (max length 16)
              - Positions 1-3: Financial Network Code
              - Positions 4-9: Banknet Reference Number
              - Positions 10-12: Space filled
              - Positions 13-16: Banknet Settlement Date
            - **Visa**: Numeric (15)
            - **Amex**: Alphanumeric (15)
            - **Discover**: Alphanumeric (16)

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with <code>payment_type</code> <code>moto</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to specify this parameter with <code>payment_type</code> <code>recurring</code>, <code>retry</code>, <code>installment</code>, or <code>rebill</code>, as the <code>scheme_transaction_id</code> ensures continuity between MITs and the original CIT.</p>
            </blockquote>
        transaction_link_id:
          type: string
          description: |-
            Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with customer-initiated (CIT) <code>payment_type</code> <code>moto</code> or <code>1-click</code> and <code>card_cvv</code>.</p>
            </blockquote>
          maxLength: 255
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to set <code>true</code> with <code>payment_type</code> <code>recurring</code>, <code>retry</code>, <code>installment</code>, or <code>rebill</code> and send it with the <code>external_mpi_data</code> object.</p>
            </blockquote>
          default: false
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersionDpanCitMit'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_number:
          type: string
          description: |-
            Primary account number (PAN) of the card.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in its <strong>unmasked format</strong>, containing the full Primary Account Number (PAN) without any masked digits.</p>
            </blockquote>
          minLength: 12
          maxLength: 19
          pattern: ^[0-9]{12,19}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
          example: John Snow
        card_exp_month:
          type: string
          description: Expiry month of the card.
          minLength: 2
          maxLength: 2
        card_exp_year:
          type: integer
          description: Expiry year of the card.
        card_cvv:
          type: string
          description: Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.
          pattern: ^[0-9]{3,4}$
        industry_data:
          $ref: '#/components/schemas/SchemaCardsIndustryDataDiscriminatorAirline'
        card_pin:
          type: string
          description: |-
            Personal identification number (PIN) associated with the card.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> only for VERVE card brand.</p>
            </blockquote>
          maxLength: 10
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          maxLength: 3
          minLength: 3
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsPaymentChargeDataTypeDpanScof:
      title: Payment
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - payment_type
        - dpan_source
        - customer_email
        - ip_address
        - platform
        - card_number
        - card_exp_month
        - card_exp_year
        - type
      properties:
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The value <strong>0</strong> is valid only for <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount</a> flow. If set to <strong>null</strong>, the default fallback value <strong>0</strong> will be used. </p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        card_data_type:
          type: string
          description: |-
            Card data <a href="https://docs.solidgate.com/payments/card-payments/token-usage/#network-tokens" target="_blank">type</a>.

            <blockquote>
              <p>If <code>card_data_type</code> is not provided, the default <code>pan</code> assumed for one-time payment with PAN.</p>
            </blockquote>
          default: pan
          enum:
            - dpan
        dpan_source:
          type: string
          description: |-
            Source for network tokens generated through Secure Consumer Online Fraud (SCOF).

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_data_type</code> <code>dpan</code> is provided.</p>
            </blockquote>
          default: scof
        eci:
          type: string
          description: |-
            Electronic Commerce Indicator (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/" target="_blank">ECI</a>) level associated with the network token authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to provide with <code>payment_type</code> <code>1-click</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 2
        cryptogram:
          type: string
          description: |-
            Base64 encoded cardholder authentication value provided with the network token and used for validating the authentication result.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> with <code>payment_type</code> <code>1-click</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 64
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
            - estimated
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        payment_type:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided. 

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_cvv</code> is not provided.</p>
              <p>Payment will be <b>declined</b> if:</p>
                <ul>
                  <li>neither <code>card_cvv</code> nor <code>payment_type</code> is specified</li>
                  <li><code>card_cvv</code> is specified alongside the <code>payment_type</code> <code>moto</code></li>
                </ul>
            </blockquote>
          enum:
            - 1-click
            - recurring
            - retry
            - installment
            - rebill
            - moto
        scheme_transaction_id:
          type: string
          description: |-
            Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments.
            - **Mastercard**: Alphanumeric (max length 16)
              - Positions 1-3: Financial Network Code
              - Positions 4-9: Banknet Reference Number
              - Positions 10-12: Space filled
              - Positions 13-16: Banknet Settlement Date
            - **Visa**: Numeric (15)
            - **Amex**: Alphanumeric (15)
            - **Discover**: Alphanumeric (16)

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with <code>payment_type</code> <code>moto</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to specify this parameter with <code>payment_type</code> <code>recurring</code>, <code>retry</code>, <code>installment</code>, or <code>rebill</code>, as the <code>scheme_transaction_id</code> ensures continuity between MITs and the original CIT.</p>
            </blockquote>
        transaction_link_id:
          type: string
          description: |-
            Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with customer-initiated (CIT) <code>payment_type</code> <code>moto</code> or <code>1-click</code> and <code>card_cvv</code>.</p>
            </blockquote>
          maxLength: 255
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to set <code>true</code> with <code>payment_type</code> <code>recurring</code>, <code>retry</code>, <code>installment</code>, or <code>rebill</code> and send it with the <code>external_mpi_data</code> object.</p>
            </blockquote>
          default: false
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersionDpanCitMit'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_number:
          type: string
          description: |-
            Primary account number (PAN) of the card.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in its <strong>unmasked format</strong>, containing the full Primary Account Number (PAN) without any masked digits.</p>
            </blockquote>
          minLength: 12
          maxLength: 19
          pattern: ^[0-9]{12,19}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
          example: John Snow
        card_exp_month:
          type: string
          description: Expiry month of the card.
          minLength: 2
          maxLength: 2
        card_exp_year:
          type: integer
          description: Expiry year of the card.
        card_cvv:
          type: string
          description: Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.
          pattern: ^[0-9]{3,4}$
        card_pin:
          type: string
          description: |-
            Personal identification number (PIN) associated with the card.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> only for VERVE card brand.</p>
            </blockquote>
          maxLength: 10
        industry_data:
          $ref: '#/components/schemas/SchemaCardsIndustryDataDiscriminatorAirline'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          maxLength: 3
          minLength: 3
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    RequestCardsPaymentChargeDataType:
      title: DPAN Payment
      type: object
      properties:
        dpan_source:
          type: string
          description: Indicates whether the payload received from Apple Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/" target="_blank">decrypted</a>.
          default: false
      discriminator:
        propertyName: dpan_source
        mapping:
          apple-pay: '#/components/schemas/SchemaCardsPaymentChargeDataTypeDpanApple'
          google-pay: '#/components/schemas/SchemaCardsPaymentChargeDataTypeDpanGoogle'
          vts: '#/components/schemas/SchemaCardsPaymentChargeDataTypeDpanVts'
          mdes: '#/components/schemas/SchemaCardsPaymentChargeDataTypeDpanMdes'
          scof: '#/components/schemas/SchemaCardsPaymentChargeDataTypeDpanScof'
    RequestCardsProductBasedPaymentCharge:
      title: Product-based payment
      type: object
      required:
        - order_id
        - product_id
        - order_description
        - payment_type
        - customer_email
        - ip_address
        - platform
        - card_number
        - card_exp_month
        - card_exp_year
        - customer_account_id
        - type
      properties:
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief description of the order.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        payment_type:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided. 

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_cvv</code> is not provided.</p>
              <p>Payment will be <b>declined</b> if:</p>
                <ul>
                  <li>neither <code>card_cvv</code> nor <code>payment_type</code> is specified</li>
                  <li><code>card_cvv</code> is specified alongside the <code>payment_type</code> <code>moto</code></li>
                </ul>
            </blockquote>
          enum:
            - 1-click
            - recurring
            - retry
            - installment
            - rebill
            - moto
        scheme_transaction_id:
          type: string
          description: |-
            Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments.
            - **Mastercard**: Alphanumeric (max length 16)
              - Positions 1-3: Financial Network Code
              - Positions 4-9: Banknet Reference Number
              - Positions 10-12: Space filled
              - Positions 13-16: Banknet Settlement Date
            - **Visa**: Numeric (15)
            - **Amex**: Alphanumeric (15)
            - **Discover**: Alphanumeric (16)

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with <code>payment_type:moto</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to specify this parameter with <code>payment_type</code> <code>recurring</code>, <code>retry</code>, <code>installment</code>, or <code>rebill</code>, as the <code>scheme_transaction_id</code> ensures continuity between MITs and the original CIT.</p>
            </blockquote>
        transaction_link_id:
          type: string
          description: |-
            Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with customer-initiated (CIT) <code>payment_type</code> <code>moto</code> or <code>1-click</code> and <code>card_cvv</code>.</p>
            </blockquote>
          maxLength: 255
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to set <code>true</code> and send it with the <code>external_mpi_data</code> object, as it helps optimize payment success rates.</p>
            </blockquote>
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersion'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_number:
          type: string
          description: |-
            Primary account number (PAN) of the card.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in its <strong>unmasked format</strong>, containing the full Primary Account Number (PAN) without any masked digits.</p>
            </blockquote>
          minLength: 12
          maxLength: 19
          pattern: ^[0-9]{12,19}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
          example: John Snow
        card_exp_month:
          type: string
          description: Expiry month of the card.
          minLength: 2
          maxLength: 2
        card_exp_year:
          type: integer
          description: Expiry year of the card.
        card_cvv:
          type: string
          description: Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.
          pattern: ^[0-9]{3,4}$
        card_pin:
          type: string
          description: |-
            Personal identification number (PIN) associated with the card.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> only for VERVE card brand.</p>
            </blockquote>
          maxLength: 10
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">    
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    RequestCardsSubscriptionPaymentCharge:
      title: Subscription payment
      type: object
      required:
        - order_id
        - product_id
        - order_description
        - payment_type
        - customer_email
        - ip_address
        - platform
        - card_number
        - card_exp_month
        - card_exp_year
        - customer_account_id
        - type
      properties:
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        payment_type:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided. 

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> if <code>card_cvv</code> is not provided.</p>
              <p>Payment will be <b>declined</b> if:</p>
                <ul>
                  <li>neither <code>card_cvv</code> nor <code>payment_type</code> is specified</li>
                  <li><code>card_cvv</code> is specified alongside the <code>payment_type</code> <code>moto</code></li>
                </ul>
            </blockquote>
          enum:
            - 1-click
            - recurring
            - retry
            - installment
            - rebill
            - moto
        scheme_transaction_id:
          type: string
          description: |-
            Card scheme specific transaction identifier required for payments using stored card details from the first PSP transaction, such as recurring payments.
            - **Mastercard**: Alphanumeric (max length 16)
              - Positions 1-3: Financial Network Code
              - Positions 4-9: Banknet Reference Number
              - Positions 10-12: Space filled
              - Positions 13-16: Banknet Settlement Date
            - **Visa**: Numeric (15)
            - **Amex**: Alphanumeric (15)
            - **Discover**: Alphanumeric (16)

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with <code>payment_type:moto</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to specify this parameter with <code>payment_type</code> <code>recurring</code>, <code>retry</code>, <code>installment</code>, or <code>rebill</code>, as the <code>scheme_transaction_id</code> ensures continuity between MITs and the original CIT.</p>
            </blockquote>
        transaction_link_id:
          type: string
          description: |-
            Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided with customer-initiated (CIT) <code>payment_type</code> <code>moto</code> or <code>1-click</code> and <code>card_cvv</code>.</p>
            </blockquote>
          maxLength: 255
        retry_attempt:
          type: integer
          description: |-
            Number of retry attempts for the subscription payments.

            <blockquote>
              <p>Use it for analytics and conversion tuning purposes.</p>
            </blockquote>
          minimum: 0
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to set <code>true</code> and send it with the <code>external_mpi_data</code> object, as it helps optimize payment success rates.</p>
            </blockquote>
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersion'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_number:
          type: string
          description: |-
            Primary account number (PAN) of the card.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in its <strong>unmasked format</strong>, containing the full Primary Account Number (PAN) without any masked digits.</p>
            </blockquote>
          minLength: 12
          maxLength: 19
          pattern: ^[0-9]{12,19}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
          example: John Snow
        card_exp_month:
          type: string
          description: Expiry month of the card.
          minLength: 2
          maxLength: 2
        card_exp_year:
          type: integer
          description: Expiry year of the card.
        card_cvv:
          type: string
          description: Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.
          pattern: ^[0-9]{3,4}$
        card_pin:
          type: string
          description: |-
            Personal identification number (PIN) associated with the card.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> only for VERVE card brand.</p>
            </blockquote>
          maxLength: 10
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">    
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsOrder:
      title: CardsOrderModel
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      type: object
      required:
        - amount
        - currency
        - order_id
        - refunded_amount
        - status
      properties:
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
          example: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        order_description:
          type: string
          description: Brief order description.
          maxLength: 255
          example: Premium package
        psp_order_id:
          type: string
          description: PSP identifier generated by Solidgate.
        provider_payment_id:
          type: string
          description: |-
            PSP identifier generated by the PSP.

            <blockquote>
              <p>Value will be if the integration transmitted this data.</p>
            </blockquote>
        subscription_id:
          type: string
          description: Unique subscription identifier.
          format: uuid
          maxLength: 36
          minLength: 36
          example: 83b19018-cbc4-4df0-899a-dda84fd2705e
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>
              <p>This is the intended initial authorization amount.</p>
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
            </blockquote>
          example: 100
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          example: USD
        processing_amount:
          type: integer
          description: |-
            Amount of the payment in the smallest currency unit as it was processed by the payment service provider.

            <blockquote>
              <p>This amount may differ from the original order amount due to currency conversion or other processing factors.</p>
            </blockquote>
        processing_currency:
          type: string
          minLength: 3
          maxLength: 3
          description: |-
            Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the payment when it was processed by payment service provider.

            <blockquote>
              <p>In some cases, it is different from the original currency.</p>
            </blockquote>
          example: USD
        marketing_amount:
          type: integer
          description: |-
            Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date.

            <blockquote>
              <p>This is based on the intended initial authorization amount.</p>
              <p>It should not be considered financial information, but it can be used for forecasting.</p>
            </blockquote>
        marketing_currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the currency used for calculation of marketing amount.
          example: USD
        refunded_amount:
          description: Indicates the amount that has been already refunded.
          type: integer
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - processing
            - 3ds_verify
            - refunded
            - auth_ok
            - auth_failed
            - settle_ok
            - partial_settled
            - void_ok
          example: processing
        auth_code:
          type: string
          description: |-
            Transaction authorization code.

            <blockquote>
              <p>It can be empty if the provider does not pass a value.</p>
            </blockquote>
          example: 2w9m8
        payment_type:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided.
          enum:
            - 1-click
            - recurring
            - retry
            - installment
            - rebill
            - moto
        payment_method:
          type: string
          description: Payment method used for the transaction.
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
          example: example@example.com
        descriptor:
          type: string
          description: |-
            Identifying text that appears on a customer’s credit or debit card statement.

            <blockquote>
              <p>It includes information about the transaction and helps the cardholder recognize the charge.</p>
            </blockquote>
          example: google.com
        mid:
          type: string
          description: Merchant identifier in Solidgate.
          example: bank-mid-1
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
          example: facebook
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsBillingDetails:
      title: SchemaCardsBillingDetails
      type: object
      description: Billing address details.
      properties:
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
        zip:
          type: string
          description: Billing zip/postal code.
    SchemaCardsCardToken:
      title: CardsCardTokenModel
      type: object
      description: Token associated with a card method that can be used for subsequent payments.
      required:
        - token
      properties:
        token:
          type: string
          description: |-
            Token generated for a card method, enabling its use for future payments.

            <blockquote>
             <p>The <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> is not generated for all types of payment flows.</p>
            </blockquote>
          example: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
    SchemaCardsCard:
      title: CardModel
      type: object
      description: Object containing detailed information about the card used in the transaction.
      required:
        - bin
        - card_exp_month
        - card_exp_year
        - number
      properties:
        bank:
          type: string
          description: Name of the card issuer.
          example: JSC UNIVERSAL BANK
        bin:
          type: string
          minLength: 6
          maxLength: 6
          description: Card issuer's Bank Identification Number (BIN).
          example: '444111'
        brand:
          type: string
          description: Card brand.
          example: VISA
        card_exp_month:
          type: string
          description: Expiry month of the card.
          minLength: 2
          maxLength: 2
          example: '12'
        card_exp_year:
          type: integer
          description: Expiry year of the card.
          example: 2028
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
          example: John Snow
        card_type:
          type: string
          description: Card type.
          enum:
            - CREDIT
            - CREDIT/DEBIT
            - DEBIT
            - PREPAID
            - CHARGE CARD
            - DEFERRED DEBIT
          example: CREDIT
        is_reloadable:
          type: boolean
          description: |-
            <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#reloadable-prepaid-indicator" target="_blank">Indicator</a> of whether the card belongs to a reloadable program.

            <blockquote>
              <p><code>null</code> means the reloadable indicator is not available.</p>
            </blockquote>
          example: true
        card_id:
          type: string
          description: Unique identifier of the card used for the transaction.
          format: uuid
          example: 22733af4-f6c6-4368-b7d0-98aeb0253a57
        country:
          type: string
          description: Card issuer's country.
          format: iso_code_a3
          example: USA
          maxLength: 3
          minLength: 3
        number:
          type: string
          description: Masked card number.
          maxLength: 19
          example: 444111XXXXXX9435
        card_token:
          $ref: '#/components/schemas/SchemaCardsCardToken'
    SchemaCardsError:
      title: CardsError
      description: <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">Error</a> object.
      required:
        - code
        - messages
      properties:
        code:
          type: string
          description: Gateway <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">error code</a> for the declined payment.
          enum:
            - X.XX
        messages:
          type: array
          description: |-
            An array containing either strings or objects that provide details about the error or status.

            <blockquote>
              <p>When it is an array of strings, each string describes a separate issue. When it is an object, the object will contain key-value pairs explaining the issue in more detail.</p>
            </blockquote>
          items:
            oneOf:
              - type: string
              - type: object
        recommended_message_for_user:
          type: string
          description: Message with recommended next steps or additional information.
          example: The problem here lies with the data format and accuracy, validation error on the acquiring side
        merchant_advice_code:
          type: string
          description: |-
            Merchant Advice Codes (MACs) are introduced by Mastercard to clearly communicate to merchants the reason for declining transactions, and the course of action that merchants can take.

            <blockquote>
              <p>If present, the MAC contains information about why the payment failed, whether it can be retried and in some cases, the recommended duration after which it should be retried.</p>
              <p>Follow to the <a href="https://docs.solidgate.com/payments/card-payments/recover-revenue/merchant-advice-codes/" target="_blank">merchant advice codes</a> to get recommendations to handle the value.</p>
            </blockquote>
    SchemaCardsTransaction:
      title: CardTransactionModel
      type: object
      description: Details of a card transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.
      required:
        - amount
        - card
        - created_at
        - currency
        - id
        - operation
        - status
        - updated_at
      properties:
        id:
          type: string
          description: Unique transaction identifier.
          example: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-27 11:45:30'
        updated_at:
          type: string
          description: Datetime when the transaction was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-28 11:45:30'
        amount:
          type: integer
          description: Transaction amount.
          example: 100
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the transaction.
          maxLength: 3
          minLength: 3
          example: USD
        marketing_amount:
          type: integer
          description: |-
            Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date.

            <blockquote>
              <p>It should not be considered financial information, but it can be used for forecasting.</p>
            </blockquote>
        marketing_currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the currency used for calculation of marketing amount.
          minLength: 3
          maxLength: 3
          example: USD
        operation:
          type: string
          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - recurring-auth
            - refund
            - resign-auth
            - auth
            - settle
            - void
            - apple-pay
            - google-pay
          example: auth
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - processing
            - success
            - fail
            - verify
          example: success
        authorization_type:
          type: string
          enum:
            - final
            - estimated
            - incremental
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        scheme_transaction_id:
          type: string
          description: Card-scheme transaction identifier linking this transaction to the original customer-initiated payment.
        transaction_link_id:
          type: string
          description: Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.
          maxLength: 255
        descriptor:
          type: string
          description: |-
            Identifying text that appears on a customer’s credit or debit card statement.

            <blockquote>
              <p>It includes information about the transaction and helps the cardholder recognize the charge.</p>
            </blockquote>
          example: google.com
        billing_details:
          $ref: '#/components/schemas/SchemaCardsBillingDetails'
        refund_reason:
          type: string
          description: Text description of the refund reason.
          example: Solidgate - Issuer Fraud Notification
        refund_reason_code:
          type: string
          description: |-
            Code representing the <a href="https://docs.solidgate.com/payments/payments-insights/refund-reasons/" target="_blank">reason</a> for the refund.

            <blockquote>
              <p>This code is used to identify the reason for both <code>void</code> and <code>refund</code> transactions <code>operation</code></p>
            </blockquote>
          minLength: 4
          maxLength: 4
          example: '0022'
        card_token:
          $ref: '#/components/schemas/SchemaCardsCardToken'
        card:
          $ref: '#/components/schemas/SchemaCardsCard'
        error:
          $ref: '#/components/schemas/SchemaCardsError'
        payment_account_reference:
          type: string
          description: Payment Account Reference (PAR) is a unique, non-financial identifier for a payment account that remains consistent across card replacements.
          example: PAR_1A2B3C4D5E6F7G8H9
        arn_code:
          type: string
          description: |-
            Acquirer Reference Number (ARN) assigned to transactions.

            <blockquote>
              <p>Use ARN to check transaction <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">status</a>.</p>
            </blockquote>
        rrn_code:
          type: string
          description: Retrieval Reference Number (RRN) assigned to transactions, based on the <a href="https://en.wikipedia.org/wiki/ISO_8583" target="_blank">ISO 8583</a> standard.
          minLength: 12
          maxLength: 12
    SchemaCardsThreeDs:
      title: CardThreeDSExtendedModel
      type: object
      description: Information related to the processing of the payment.
      properties:
        eci:
          type: string
          description: |-
            Electronic Commerce Indicator (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/" target="_blank">ECI</a>) security level used to authorize the payment.

            <blockquote>
              <p>Applicable for <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure</a>, <a href="https://docs.solidgate.com/payments/digital-wallets/" target="_blank">digital wallet</a>, and <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/card-schemes-tokenization/" target="_blank">network token</a> payments.</p>
            </blockquote>
          example: '05'
        flow:
          type: string
          description: |-
            <a href="https://docs.solidgate.com/payments/card-payments/3ds-verification/#3d-secure" target="_blank">Specifies</a> whether and how the customer was involved in the 3D Secure.

            <blockquote>
              <p>Flow <code>null</code> indicates that 3D Secure authentication was not initiated for the transaction.</p>
            </blockquote>
          enum:
            - frictionless
            - challenge
            - none
            - unspecified
          example: none
        exception:
          type: string
          description: Strong Customer Authentication (<a href="https://docs.solidgate.com/payments/card-payments/3ds-verification/#3d-secure" target="_blank">SCA</a>) exception type applied to the transaction.
          enum:
            - low_value
            - transaction_risk_assessment
          example: low_value
    SchemaCardsRouting:
      title: SchemaCardsRouting
      type: object
      description: |-
        Payment routing information.

        <blockquote>
          <p>The availability of this object depends on whether routing is <a href="https://docs.solidgate.com/orchestration/routing/#configure-routing" target="_blank">configured</a> for your account.</p>
        </blockquote>
      properties:
        cascade_steps:
          type: array
          description: Details of the attempts made to process the payment.
          items:
            type: object
            properties:
              mid:
                type: string
                description: Merchant identifier in Solidgate.
              mid_descriptor:
                type: string
                description: Identifying text that appears on a customer's credit or debit card statement.
              route_id:
                type: string
                description: Route identifier configured in Solidgate.
              cascade_number:
                type: integer
                description: |-
                  Sequential number of the processing attempt in the routing cascade, fallback step number.

                  <blockquote>
                    <p>Indicates which attempt in the fallback sequence was used to process the payment.</p>
                  </blockquote>
              segment_id:
                type: string
                description: |-
                  Identifier of the segment used for this processing attempt in the routing configuration.

                  <blockquote>
                    <p>Each segment represents a specific processing configuration within a route.</p>
                  </blockquote>
    SchemaCardsAntifraudResult:
      type: object
      description: |-
        Pre-authorization decision returned by Solidgate Antifraud.  

        <blockquote>
          <p>Returned only when the merchant uses Solidgate’s internal antifraud service, which excludes provider-side fraud results.</p>
        </blockquote>
      properties:
        pre_auth:
          type: string
          description: |-
            Outcome of the real-time antifraud screening performed before the authorization request is sent.

            - `reject` - transaction declined
            - `review` - requires manual review
            - `pass` - approved to proceed
          enum:
            - reject
            - review
            - pass
          example: pass
    SchemaCardsAniResult:
      type: object
      description: |-
        ANI <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/verification-result/#ani" target="_blank">result</a> from the card scheme verifies whether the cardholder name matches the issuer’s records.

        <blockquote>
          <p>It helps confirm the cardholder’s identity, supporting the decision to approve, verify, or decline a transaction.</p>
        </blockquote>
      properties:
        status:
          type: string
          description: Outcome of the name match check performed against the issuer’s records.
          enum:
            - performed
            - not_performed
            - not_supported
          example: performed
        full_name_match:
          type: string
          description: Result of matching the full cardholder name against the issuer’s records.
          enum:
            - matched
            - partially_matched
            - not_matched
          example: matched
        first_name_match:
          type: string
          description: Result of matching the cardholder’s first name against the issuer’s records.
          enum:
            - matched
            - partially_matched
            - not_matched
          example: partially_matched
        last_name_match:
          type: string
          description: Result of matching the cardholder’s last name against the issuer’s records.
          enum:
            - matched
            - partially_matched
            - not_matched
          example: not_matched
    SchemaCardsVerificationResult:
      type: object
      description: Verification results for Address Verification Service (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/verification-result/#avs" target="_blank">AVS</a>), Card Verification Value (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/verification-result/#cvv" target="_blank">CVV</a>), and Account Name Inquiry (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/verification-result/#ani" target="_blank">ANI</a>), providing match status.
      properties:
        avs_result:
          type: string
          description: |-
            AVS <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/verification-result/#avs" target="_blank">result</a> from card schemes verifies if the billing address matches with the issuing bank.
            <blockquote>
              <p>It returns a value that indicates the level of match, assisting in the decision to approve, verify, or decline a transaction.</p>
            </blockquote>
          enum:
            - matched
            - partially_matched
            - not_matched
            - unsupported
            - unavailable
            - unknown
          example: matched
        cvv_result:
          type: string
          description: |-
            CVV <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/verification-result/#cvv" target="_blank">result</a> indicates whether the CVV code entered matches the one on the card, confirming the cardholder’s possession.

            <blockquote>
              <p>It helps assess transaction legitimacy and decide whether to approve, verify, or decline.</p>
            </blockquote>
          enum:
            - matched
            - not_matched
            - not_checked
            - unavailable
            - unknown
          example: matched
        ani:
          $ref: '#/components/schemas/SchemaCardsAniResult'
    SchemaCardsChargebackFlow:
      title: SchemaCardsChargebackFlow
      type: object
      description: Map of chargebacks where the keys are chargeback identifiers.
      required:
        - id
        - amount
        - dispute_amount
        - currency
        - type
        - status
      properties:
        id:
          type: integer
          description: Unique chargeback flow identifier.
          maxLength: 100
        date:
          type: string
          description: Datetime when the chargeback flow was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_date:
          type: string
          description: Datetime when the chargeback flow was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        settlement_date:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          description: Date when the chargeback flow was financially settled.
        deadline_date:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          description: |-
            Deadline for submitting a response to the dispute.

            <blockquote>
              <p>This corresponds to date + n, where n is a number of calendar days set by the scheme/acquirer.</p>
            </blockquote>
        amount:
          type: integer
          description: |-
            Amount involved in each stage of the chargeback process.

            <blockquote>
              <p>For example, there could be two records in <code>chargeback_flow</code> one with an amount of 113.58 USD and another with an amount of 100 USD.</p>
            </blockquote>
        dispute_amount:
          type: integer
          description: |-
            Specific amount disputed, typically in the smallest currency unit, that would be returned to the merchant if the dispute is resolved in their favor.

            <blockquote>
              <p>For example, if the second chargeback was successfully disputed, the <code>dispute_amount</code> would be 100 USD.</p>
            </blockquote>
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the chargeback amount.
          minLength: 3
          maxLength: 3
        type:
          type: string
          description: <a href="https://docs.solidgate.com/risks/chargebacks/#types" target="_blank">Type</a> of the chargeback flow.
          enum:
            - 1st_chb
            - 2nd_chb
            - arbitration
        status:
          type: string
          description: <a href="https://docs.solidgate.com/risks/chargebacks/#statuses" target="_blank">Status</a> of the chargeback.
          enum:
            - in_progress
            - document_sent
            - reversed
            - accepted
            - resolved
            - resolved_reversal
        arn_code:
          type: string
          description: |-
            Acquirer Reference Number (ARN) assigned to transactions.

            <blockquote>
              <p>Use ARN to check transaction <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">status</a>.</p>
            </blockquote>
    SchemaCardsChargeback:
      title: CardChargebackModel
      type: object
      description: Information about a chargeback, including identifiers, dates, amounts, status, and the flow of the chargeback process.
      required:
        - id
        - dispute_date
        - amount
        - currency
        - chargeback_flow
      properties:
        id:
          type: integer
          description: Unique chargeback identifier.
          example: 12345
          maxLength: 100
        dispute_date:
          type: string
          description: Date when the chargeback was created by the issuer.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ || ^\d{4}-\d{2}-\d{2}
          example: '2025-07-10 00:00:00'
        settlement_date:
          type: string
          description: Date when the chargeback was financially settled.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-07-11 00:00:00'
        amount:
          type: integer
          description: |-
            Amount that will be deducted for the chargeback on a specific order.

            <blockquote>
              <p>This amount may vary based on the user's decision to dispute a different amount.</p>
            </blockquote>
          example: 100
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the chargeback amount.
          maxLength: 3
          minLength: 3
          example: USD
        type:
          type: string
          description: <a href="https://docs.solidgate.com/risks/chargebacks/#types" target="_blank">Current type</a> of the chargeback.
          enum:
            - 1st_chb
            - 2nd_chb
            - arbitration
          example: 2nd_chb
        status:
          type: string
          description: <a href="https://docs.solidgate.com/risks/chargebacks/#statuses" target="_blank">Status</a> of the chargeback.
          enum:
            - in_progress
            - document_sent
            - reversed
            - accepted
            - resolved
            - resolved_reversal
          example: reversed
        reason_group:
          type: string
          description: |-
            <a href="https://docs.solidgate.com/risks/reason-codes/" target="_blank">Reason code</a> group.

            <blockquote>
              <p>It could be used for the segmentation and analytic purposes.</p>
            </blockquote>
          example: Fraud
        reason_code:
          type: string
          description: <a href="https://docs.solidgate.com/risks/reason-codes/" target="_blank">Reason code</a> for the chargeback provided by the card scheme.
          example: '10.4'
        reason_description:
          type: string
          description: <a href="https://docs.solidgate.com/risks/reason-codes/" target="_blank">Reason code</a> description for the chargeback provided by the card scheme.
          example: Fraud – Card-Absent Environment
        chargeback_flow:
          type: array
          description: Map of chargeback flows where the keys are chargeback flow identifiers.
          items:
            $ref: '#/components/schemas/SchemaCardsChargebackFlow'
    SchemaCardsDeviceInfo:
      title: SchemaCardsDeviceInfo
      type: object
      description: Information about the device used.
      properties:
        user_agent:
          type: string
          description: Device user-agent.
          minLength: 1
          maxLength: 1000
    SchemaCardsPayForm:
      title: CardPayFormModel
      description: Represents a payment form, including deprecated properties related to the form URL and token.
      type: object
      properties:
        form_url:
          type: string
          deprecated: true
          description: Payment form URL created for the order.
          example: https://example.com/pay_form_url
        token:
          type: string
          deprecated: true
          description: Secure payment token representing sensitive payment method information.
          example: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
    SchemaCardsPaymentAdviser:
      title: SchemaCardsPaymentAdviser
      description: Provides recommendations on which payment type to offer for future orders based on the card used.
      type: object
      properties:
        advise:
          type: string
          description: Recommendation for which payment type to use for the given order and card.
          deprecated: true
    ResponseCardsCharge:
      title: Success
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/SchemaCardsOrder'
            - type: object
              properties:
                product_id:
                  type: string
                  format: uuid
                  maxLength: 36
                  minLength: 36
                  description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
                product_name:
                  type: string
                  description: <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> name.
                  minLength: 1
                  maxLength: 500
                customer_account_id:
                  type: string
                  description: Unique customer identifier defined by the merchant.
                  maxLength: 100
                  example: 93a1c659-288d-4d62-929d-10e241078faa
                payment_method:
                  enum:
                    - card
                    - network-token
        transaction:
          $ref: '#/components/schemas/SchemaCardsTransaction'
        transactions:
          type: object
          description: Map of transactions where the keys are transaction identifiers.
          properties:
            <transaction_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsTransaction'
          required:
            - <transaction_id_value_#1>
        three_ds:
          $ref: '#/components/schemas/SchemaCardsThreeDs'
        routing:
          $ref: '#/components/schemas/SchemaCardsRouting'
        antifraud_result:
          $ref: '#/components/schemas/SchemaCardsAntifraudResult'
        verification_result:
          $ref: '#/components/schemas/SchemaCardsVerificationResult'
        chargebacks:
          type: object
          description: Map of chargebacks where the keys are chargeback identifiers.
          properties:
            <chargeback_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsChargeback'
        device_info:
          $ref: '#/components/schemas/SchemaCardsDeviceInfo'
        verify_url:
          type: string
          description: |-
            URL where the customer should be redirected to complete 3DS authentication.

            <blockquote>
              <p>Only after opening the URL and authenticating the order <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">status</a> change to <code>3ds_verify</code>.</p>
            </blockquote>
        redirect_url:
          type: string
          description: URL where customer should be redirected after finishing 3D Secure or redirect payment method.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        pay_form:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPayForm'
        payment_adviser:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPaymentAdviser'
      required:
        - order
        - transactions
    ResponseMainAuthenticationFailed:
      title: Authentication failed
      type: object
      properties:
        error:
          description: Error object.
          properties:
            code:
              type: string
              description: <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#101-authentication-failed" target="_blank">Unauthorized access</a> due to invalid credentials.
              default: 1.01
              example: '1.01'
            messages:
              type: array
              description: Array of error messages applied to the decline payment.
              items:
                example: Authentication failed
          required:
            - code
            - messages
      required:
        - error
    SchemaMainErrorInvalidData:
      title: SchemaMainErrorInvalidData
      type: object
      properties:
        code:
          type: string
          description: |-
            <a href="https://docs.solidgate.com/payments/payments-insights/error-codes" target="_blank">Code</a> indicating the reason for the payment decline, specifically related to validation errors.

            <blockquote>
              <p>These errors often suggest that the transaction data is incorrect or incomplete.</p>
            </blockquote>
          enum:
            - '2.01'
          example: '2.01'
        messages:
          type: array
          description: |-
            Array containing messages that specify why the payment was declined due to validation errors.

            <blockquote>
              <p>These messages can range from an incorrect card number to an invalid security code or billing address.</p>
            </blockquote>
          items:
            type: string
            example: Invalid data
      required:
        - code
        - messages
    SchemaMainErrorOrderNotFound:
      title: SchemaMainErrorOrderNotFound
      type: object
      properties:
        code:
          type: string
          description: <a href="https://docs.solidgate.com/payments/payments-insights/error-codes" target="_blank">Code</a> generated by the payment gateway, specifically indicating that the order was not found in the system.
          enum:
            - '2.01'
          example: '2.01'
        messages:
          type: object
          description: Object containing key-value pairs that clarify the reason for the payment decline, particularly in cases where the requested order does not exist.
      required:
        - code
        - messages
    SchemaMainErrorCardBrandNotSupported:
      title: SchemaMainErrorCardBrandNotSupported
      type: object
      properties:
        code:
          type: string
          description: |-
            <a href="https://docs.solidgate.com/payments/payments-insights/error-codes" target="_blank">Code</a> indicating that the card brand does not support the <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/" target="_blank">incremental authorization</a> feature.

            <blockquote>
              <p>This error occurs when attempting to use incremental authorization with a card brand that does not support this feature.</p>
            </blockquote>
          enum:
            - '2.04'
          example: '2.04'
        messages:
          type: array
          description: |-
            Array containing messages that specify why the payment was declined due to unsupported card brand for incremental authorization.

            <blockquote>
              <p>Supported card brands include American Express (Amex), Cartes Bancaires, Diners, Discover, JCB, Mastercard, Mexico Domestic (Network MX) and Visa.</p>
            </blockquote>
          items:
            type: string
            example: Card brand is not supported
      required:
        - code
        - messages
    SchemaMainError:
      title: SchemaMainError
      type: object
      properties:
        code:
          type: string
          description: <a href="https://docs.solidgate.com/payments/payments-insights/error-codes" target="_blank">Code</a> representing the specific error or status condition.
          enum:
            - X.XX
          example: X.XX
        messages:
          type: array
          description: |-
            Array containing either strings or objects that provide details about the error or status.

            <blockquote>
              <p>When it is an array of strings, each string describes a separate issue. When it is an object, the object will contain key-value pairs explaining the issue in more detail.</p>
            </blockquote>
          items:
            oneOf:
              - type: string
              - type: object
        recommended_message_for_user:
          type: string
          description: Message with recommended next steps or additional information.
          example: The user’s card balance has insufficient funds.
      required:
        - code
        - messages
    SchemaMainDiscriminatorError:
      description: Error object.
      properties:
        code:
          type: string
          description: Gateway <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">error code</a> for the declined payment.
      discriminator:
        propertyName: code
        mapping:
          2.01 Invalid data: '#/components/schemas/SchemaMainErrorInvalidData'
          2.01 Order not found: '#/components/schemas/SchemaMainErrorOrderNotFound'
          2.04 Card brand is not supported: '#/components/schemas/SchemaMainErrorCardBrandNotSupported'
          X.XX: '#/components/schemas/SchemaMainError'
    ResponseMainError:
      title: Error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/SchemaMainDiscriminatorError'
      required:
        - error
    SchemaCardsIndustryDataCarRental:
      title: SchemaCardsIndustryDataCarRental
      type: object
      required:
        - type
        - car_rental
      additionalProperties: false
      properties:
        type:
          type: string
          description: Type of entity used to identify the classification of the data being provided.
          enum:
            - car_rental
        car_rental:
          type: object
          description: Car rental-related details.
          required:
            - agreement_number
            - renter_name
            - pick_up_date
            - drop_off_date
            - refundability
            - return_location_id
            - pick_up_location
            - drop_off_location
            - distance_limit
          additionalProperties: false
          properties:
            agreement_number:
              type: string
              description: Rental agreement number for the car rental.
              maxLength: 9
            renter_name:
              type: string
              description: Name of the person renting the car.
              maxLength: 26
            pick_up_date:
              type: string
              description: UTC date and time of the rental pick-up in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
              format: date-time
              example: '2026-03-01T11:00:00Z'
            drop_off_date:
              type: string
              description: UTC date and time of the rental drop-off in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
              format: date-time
              example: '2026-03-05T16:30:00Z'
            refundability:
              type: string
              description: Indicates whether the booking is refundable, partially refundable, or non-refundable.
              enum:
                - refundable
                - non_refundable
                - partially_refundable
            rate:
              type: integer
              description: Daily rental rate in minor units.
              minimum: 0
            rate_indicator:
              type: string
              description: Specifies whether the provided rate is daily or weekly.
              enum:
                - D
                - W
            days_rented:
              type: string
              description: Number of days for which the car is rented.
              maxLength: 4
            customer_service_toll_free_number:
              type: string
              description: Customer service phone number of the car rental company.
              maxLength: 17
            rental_class_id:
              type: string
              description: Classification of the rental car.
              maxLength: 4
            tax_exempt_indicator:
              type: string
              description: Indicates whether goods or services were tax-exempt.
              enum:
                - 'Y'
                - 'N'
            fuel_charges:
              type: integer
              description: Fuel charges associated with the rental, in minor units.
              minimum: 0
            insurance_charges:
              type: integer
              description: Insurance charges associated with the rental, in minor units.
              minimum: 0
            no_show_indicator:
              type: string
              description: Indicates whether the customer did not pick up the rental car.
              enum:
                - 'Y'
                - 'N'
            one_way_drop_off_charges:
              type: integer
              description: Charge for returning a car to a location different from pick-up, in minor units.
              minimum: 0
            return_location_id:
              type: string
              description: Agency code, phone number, or address abbreviation of the return location.
              maxLength: 10
            pick_up_location:
              type: object
              description: Address where the car is picked up.
              required:
                - state
                - city
                - country
                - postal
              additionalProperties: false
              properties:
                street_line_1:
                  type: string
                  description: Street line 1 where the car is picked up.
                  maxLength: 100
                state:
                  type: string
                  description: State or province where the car is picked up in <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a>.
                  maxLength: 2
                city:
                  type: string
                  description: City where the car is picked up.
                  maxLength: 100
                country:
                  type: string
                  description: Country where the car is picked up.
                  format: iso_code_a3
                  minLength: 3
                  maxLength: 3
                postal:
                  type: string
                  description: Postcode associated with the picked up location.
                  maxLength: 10
            drop_off_location:
              type: object
              description: Address where the car is dropped off.
              required:
                - state
                - city
                - country
                - postal
              additionalProperties: false
              properties:
                street_line_1:
                  type: string
                  description: Street line 1 where the car is dropped off.
                  maxLength: 100
                state:
                  type: string
                  description: State or province where the car is dropped off in <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a>.
                  maxLength: 2
                city:
                  type: string
                  description: City where the car is dropped off.
                  maxLength: 100
                country:
                  type: string
                  description: Country where the car is dropped off.
                  format: iso_code_a3
                  minLength: 3
                  maxLength: 3
                postal:
                  type: string
                  description: Postcode associated with the dropped-off location.
                  maxLength: 10
            distance_limit:
              type: object
              description: Maximum allowed distance and cost for exceeding it.
              required:
                - limit
                - unit
                - additional_distance_cost
              additionalProperties: false
              properties:
                limit:
                  type: integer
                  description: Maximum distance allowed.
                  minimum: 0
                unit:
                  type: string
                  description: Unit of distance.
                  enum:
                    - miles
                    - km
                additional_distance_cost:
                  type: object
                  description: An additional cost is applied when the distance limit is exceeded.
                  required:
                    - amount
                    - currency
                  additionalProperties: false
                  properties:
                    amount:
                      type: integer
                      description: Cost amount in the smallest currency unit.
                      minimum: 0
                    currency:
                      type: string
                      description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
                      minLength: 3
                      maxLength: 3
    SchemaCardsIndustryDataDiscriminatorCarRental:
      title: SchemaCardsIndustryDataDiscriminatorCarRental
      type: object
      description: |-
        <a href="https://docs.solidgate.com/payments/card-payments/industry-data/" target="_blank">Industry-related</a> data for car rental payments.

        <blockquote>
          <p>Applicable to merchants operating under car-rental-related MCCs 3351–3500, 7512, 7513, and 7519.</p>
          <p>Supplying this enriched data can help reduce fees, improve fraud detection and dispute handling, increase customer trust, and support industry compliance.</p>
        </blockquote>
      properties:
        type:
          type: string
      discriminator:
        propertyName: type
        mapping:
          car_rental: '#/components/schemas/SchemaCardsIndustryDataCarRental'
    SchemaCardsGooglePayEncrypted:
      title: 'false'
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - signature
        - signedMessage
        - protocolVersion
        - type
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Google Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/" target="_blank">decrypted</a>.
          default: false
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The value <strong>0</strong> is valid only for <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount</a> flow. If set to <strong>null</strong>, the default fallback value <strong>0</strong> will be used. </p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Specifies the payment processing flow using <code>auth</code> for a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
            - estimated
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        force3ds:
          type: boolean
          description: Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.
          default: false
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
        industry_data:
          $ref: '#/components/schemas/SchemaCardsIndustryDataDiscriminatorCarRental'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        signature:
          type: string
          description: |-
            Verifies that the message came from Google, base64-encoded and created using ECDSA by the intermediate signing key.

            <blockquote>
              <p>This field is taken from Google's response.</p>
            </blockquote>
        signedMessage:
          type: string
          description: |-
            JSON object serialized as an HTML-safe string that contains the <code>encryptedMessage</code>, <code>ephemeralPublicKey</code>, and tag. It is serialized to simplify the signature verification process.

            <blockquote>
              <p>This field is taken from Google's response.</p>
            </blockquote>
        protocolVersion:
          type: string
          description: |-
            Identifies the encryption or signing scheme under which the message is created. It allows the protocol to evolve over time if needed. If it is not set, assume ECv0.

            <blockquote>
              <p>This field is taken from Google's response.</p>
            </blockquote>
        network:
          type: string
          description: Network (card brand) through which the payment is processed.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsGooglePayDecryptedECv1Card:
      title: CARD
      type: object
      required:
        - pan
        - expirationMonth
        - expirationYear
      properties:
        pan:
          type: string
          description: Personal account number charged.
          minLength: 12
          maxLength: 19
        expirationMonth:
          type: string
          description: PAN expiration month.
          minLength: 2
          maxLength: 2
        expirationYear:
          type: integer
          description: PAN expiration year.
          minLength: 4
          maxLength: 4
    SchemaCardsGooglePayDecryptedECv1TokenizedCard:
      title: TOKENIZED_CARD
      type: object
      required:
        - dpan
        - expirationMonth
        - expirationYear
        - authMethod
        - 3dsCryptogram
      properties:
        dpan:
          type: string
          description: Digital primary account number (DPAN) or device token of personal account number charged.
          minLength: 12
          maxLength: 19
        expirationMonth:
          type: string
          description: DPAN expiration month.
          minLength: 2
          maxLength: 2
        expirationYear:
          type: integer
          description: DPAN expiration year.
          minLength: 4
          maxLength: 4
        authMethod:
          type: string
          description: Google Pay authorization method.
          enum:
            - 3DS
        3dsCryptogram:
          type: string
          description: Base64 encoded cardholder authentication value (20 bytes in decoded form) used for validating the authentication result.
          maxLength: 100
        3dsEciIndicator:
          type: string
          description: |-
            Electronic Commerce Indicator (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/#eci-for-digital-wallets" target="_blank">ECI</a>) level associated with the 3D Secure enrollment result.

            <blockquote style="border-left: 4px solid #F2E7C4; ">                
                <p><b>Highly recommended</b> to provide eci value for better transaction success rate.</p>
            </blockquote>
          minLength: 1
          maxLength: 2
    SchemaCardsGooglePayDecryptedECv1:
      title: ECv1
      type: object
      required:
        - messageExpiration
        - messageId
        - paymentMethod
        - paymentMethodDetails
      properties:
        gatewayMerchantId:
          type: string
          description: Your public API key for submitting a payment data request to the Google API.
          maxLength: 255
        messageExpiration:
          type: string
          description: Timestamp set one week from the time of passing payload, formatted as a string of Unix epoch milliseconds.
          example: '1507738377032'
        messageId:
          type: string
          description: Message randomly generated for each payload by Google.
          maxLength: 255
        paymentMethod:
          type: string
          description: |-
            Payment method returned by Google Pay API in a signed and encrypted PaymentMethodToken payload.

            <blockquote>
              <p>Defines parameters of the <code>paymentMethodDetails</code> object.</p>
            </blockquote>
          enum:
            - CARD
            - TOKENIZED_CARD
        paymentMethodDetails:
          type: object
          description: Payment method details returned by Google Pay API.
          oneOf:
            - $ref: '#/components/schemas/SchemaCardsGooglePayDecryptedECv1Card'
            - $ref: '#/components/schemas/SchemaCardsGooglePayDecryptedECv1TokenizedCard'
    SchemaCardsGooglePayDecryptedECv2PanOnly:
      title: PAN_ONLY
      type: object
      required:
        - pan
        - expirationMonth
        - expirationYear
        - authMethod
      properties:
        authMethod:
          type: string
          description: |-
            Google Pay authorization method.

            <blockquote>
              <p>Defines parameters of the <code>paymentMethodDetails</code> object.</p>
            </blockquote>
          enum:
            - PAN_ONLY
        pan:
          type: string
          description: Personal account number charged.
          minLength: 12
          maxLength: 19
        expirationMonth:
          type: string
          description: PAN expiration month.
          minLength: 2
          maxLength: 2
        expirationYear:
          type: integer
          description: PAN expiration year.
          minLength: 4
          maxLength: 4
    SchemaCardsGooglePayDecryptedECv2Cryptogram3DS:
      title: CRYPTOGRAM_3DS
      type: object
      required:
        - pan
        - expirationMonth
        - expirationYear
        - authMethod
        - 3dsCryptogram
      properties:
        authMethod:
          type: string
          description: |-
            Google Pay authorization method.

            <blockquote>
              <p>Defines parameters of the <code>paymentMethodDetails</code> object.</p>
            </blockquote>
          enum:
            - CRYPTOGRAM_3DS
        3dsCryptogram:
          type: string
          description: Base64 encoded cardholder authentication value (20 bytes in decoded form) used for validating the authentication result.
          maxLength: 100
        pan:
          type: string
          description: Personal account number charged.
          minLength: 12
          maxLength: 19
        expirationMonth:
          type: string
          description: PAN expiration month.
          minLength: 2
          maxLength: 2
        expirationYear:
          type: integer
          description: PAN expiration year.
          minLength: 4
          maxLength: 4
        3dsEciIndicator:
          type: string
          description: |-
            Electronic Commerce Indicator (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/#eci-for-digital-wallets" target="_blank">ECI</a>) level associated with the 3D Secure enrollment result.

            <blockquote style="border-left: 4px solid #F2E7C4; ">                
                <p><b>Highly recommended</b> to provide eci value for better transaction success rate.</p>
            </blockquote>
          minLength: 1
          maxLength: 2
    SchemaCardsGooglePayDecryptedECv2:
      title: ECv2
      type: object
      required:
        - messageExpiration
        - messageId
        - paymentMethod
        - paymentMethodDetails
      properties:
        gatewayMerchantId:
          type: string
          description: Your public API key for submitting a payment data request to the Google API.
          maxLength: 255
        messageExpiration:
          type: string
          description: A timestamp set one week from the time of passing payload, formatted as a string of Unix epoch milliseconds.
          example: '1507738377032'
        messageId:
          type: string
          description: Message randomly generated for each payload by Google.
          maxLength: 255
        paymentMethod:
          type: string
          description: Payment method returned by Google Pay API in a signed and encrypted PaymentMethodToken payload.
          enum:
            - CARD
        paymentMethodDetails:
          type: object
          description: Payment method details returned by Google Pay API.
          oneOf:
            - $ref: '#/components/schemas/SchemaCardsGooglePayDecryptedECv2PanOnly'
            - $ref: '#/components/schemas/SchemaCardsGooglePayDecryptedECv2Cryptogram3DS'
    SchemaCardsGooglePayDecrypted:
      title: 'true'
      type: object
      required:
        - decrypted_data
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - protocolVersion
        - ip_address
        - platform
        - type
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Google Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/" target="_blank">decrypted</a>.
          default: false
        decrypted_data:
          type: object
          description: |-
            Object with decrypted Google Pay payment data.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><strong>Requires</strong> the request to include <code>type</code> <code>auth</code>.</p>
            </blockquote>
            <blockquote>
              <p>Please note that <code>decrypted_data</code> parameters are defined and validated based on the <code>protocolVersion</code> value, which are <code>ECv1</code> or <code>ECv2</code>.</p>
            </blockquote>
          oneOf:
            - $ref: '#/components/schemas/SchemaCardsGooglePayDecryptedECv1'
            - $ref: '#/components/schemas/SchemaCardsGooglePayDecryptedECv2'
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The value <strong>0</strong> is valid only for <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount</a> flow. If set to <strong>null</strong>, the default fallback value <strong>0</strong> will be used. </p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Specifies the payment processing flow using <code>auth</code> for a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
            - estimated
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        force3ds:
          type: boolean
          description: Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.
          default: false
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
        industry_data:
          $ref: '#/components/schemas/SchemaCardsIndustryDataDiscriminatorCarRental'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        protocolVersion:
          type: string
          description: |-
            Identifies the encryption or signing scheme under which the message is created.
            The expected values are <code>ECv1</code> or <code>ECv2</code>, which define the <code>decrypted_data</code> object parameters.

            <blockquote>
              <p>This field is taken from Google's response.</p>
            </blockquote>
          enum:
            - ECv1
            - ECv2
        network:
          type: string
          description: Network (card brand) through which the payment is processed.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    RequestCardsGooglePay:
      title: Payment
      type: object
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Google Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/" target="_blank">decrypted</a>.
          default: false
      discriminator:
        propertyName: is_decrypted
        mapping:
          'false': '#/components/schemas/SchemaCardsGooglePayEncrypted'
          'true': '#/components/schemas/SchemaCardsGooglePayDecrypted'
    SchemaCardsProductBasedPaymentGooglePayEncrypted:
      title: 'false'
      type: object
      required:
        - product_id
        - order_id
        - order_description
        - customer_email
        - customer_account_id
        - ip_address
        - platform
        - signature
        - signedMessage
        - protocolVersion
        - type
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Google Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/" target="_blank">decrypted</a>.
          default: false
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Specifies the payment processing flow using <code>auth</code> for a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        force3ds:
          type: boolean
          description: Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.
          default: false
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        signature:
          type: string
          description: |-
            Verifies that the message came from Google, base64-encoded and created using ECDSA by the intermediate signing key.

            <blockquote>
              <p>This field is taken from Google's response.</p>
            </blockquote>
        signedMessage:
          type: string
          description: |-
            JSON object serialized as an HTML-safe string that contains the <code>encryptedMessage</code>, <code>ephemeralPublicKey</code>, and tag. It is serialized to simplify the signature verification process.

            <blockquote>
              <p>This field is taken from Google's response.</p>
            </blockquote>
        protocolVersion:
          type: string
          description: |-
            Identifies the encryption or signing scheme under which the message is created. It allows the protocol to evolve over time if needed. If it is not set, assume ECv0.

            <blockquote>
              <p>This field is taken from Google's response.</p>
            </blockquote>
        network:
          type: string
          description: Network (card brand) through which the payment is processed.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsProductBasedPaymentGooglePayDecrypted:
      title: 'true'
      type: object
      required:
        - decrypted_data
        - product_id
        - order_id
        - order_description
        - customer_email
        - protocolVersion
        - customer_account_id
        - ip_address
        - platform
        - type
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Google Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/" target="_blank">decrypted</a>.
          default: false
        decrypted_data:
          type: object
          description: |-
            Object with decrypted Google Pay payment data.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><strong>Requires</strong> the request to include <code>type</code> <code>auth</code>.</p>
            </blockquote>
            <blockquote>
              <p>Please note that <code>decrypted_data</code> parameters are defined and validated based on the <code>protocolVersion</code> value, which are <code>ECv1</code> or <code>ECv2</code>.</p>
            </blockquote>
          oneOf:
            - $ref: '#/components/schemas/SchemaCardsGooglePayDecryptedECv1'
            - $ref: '#/components/schemas/SchemaCardsGooglePayDecryptedECv2'
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Specifies the payment processing flow using <code>auth</code> for a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        force3ds:
          type: boolean
          description: Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.
          default: false
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote>   
              <p>For format consistency, it is recommended to adhere to the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        protocolVersion:
          type: string
          description: |-
            Identifies the encryption or signing scheme under which the message is created.
            The expected values are <code>ECv1</code> or <code>ECv2</code>, which define the <code>decrypted_data</code> object parameters.

            <blockquote>
              <p>This field is taken from Google's response.</p>
            </blockquote>
          enum:
            - ECv1
            - ECv2
        network:
          type: string
          description: Network (card brand) through which the payment is processed.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    RequestCardsProductBasedPaymentGooglePay:
      title: Product-based payment
      type: object
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Google Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/" target="_blank">decrypted</a>.
          default: false
      discriminator:
        propertyName: is_decrypted
        mapping:
          'false': '#/components/schemas/SchemaCardsProductBasedPaymentGooglePayEncrypted'
          'true': '#/components/schemas/SchemaCardsProductBasedPaymentGooglePayDecrypted'
    SchemaCardsSubscriptionPaymentGooglePayEncrypted:
      title: 'false'
      type: object
      required:
        - product_id
        - order_id
        - order_description
        - customer_email
        - customer_account_id
        - ip_address
        - platform
        - signature
        - signedMessage
        - protocolVersion
        - type
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Google Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/" target="_blank">decrypted</a>.
          default: false
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Specifies the payment processing flow using <code>auth</code> for a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        retry_attempt:
          type: integer
          description: |-
            Number of retry attempts for the subscription payments.

            <blockquote>
              <p>Use it for analytics and conversion tuning purposes.</p>
            </blockquote>
          minimum: 0
        force3ds:
          type: boolean
          description: Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.
          default: false
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote>   
              <p>For format consistency, it is recommended to adhere to the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        signature:
          type: string
          description: |-
            Verifies that the message came from Google, base64-encoded and created using ECDSA by the intermediate signing key.

            <blockquote>
              <p>This field is taken from Google's response.</p>
            </blockquote>
        signedMessage:
          type: string
          description: |-
            JSON object serialized as an HTML-safe string that contains the <code>encryptedMessage</code>, <code>ephemeralPublicKey</code>, and tag. It is serialized to simplify the signature verification process.

            <blockquote>
              <p>This field is taken from Google's response.</p>
            </blockquote>
        protocolVersion:
          type: string
          description: |-
            Identifies the encryption or signing scheme under which the message is created. It allows the protocol to evolve over time if needed. If it is not set, assume ECv0.

            <blockquote>
              <p>This field is taken from Google's response.</p>
            </blockquote>
        network:
          type: string
          description: Network (card brand) through which the payment is processed.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsSubscriptionPaymentGooglePayDecrypted:
      title: 'true'
      type: object
      required:
        - decrypted_data
        - product_id
        - order_id
        - order_description
        - customer_email
        - protocolVersion
        - customer_account_id
        - ip_address
        - platform
        - type
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Google Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/" target="_blank">decrypted</a>.
          default: false
        decrypted_data:
          type: object
          description: |-
            Object with decrypted Google Pay payment data.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><strong>Requires</strong> the request to include <code>type</code> <code>auth</code>.</p>
            </blockquote>
            <blockquote>
              <p>Please note that <code>decrypted_data</code> parameters are defined and validated based on the <code>protocolVersion</code> value, which are <code>ECv1</code> or <code>ECv2</code>.</p>
            </blockquote>
          oneOf:
            - $ref: '#/components/schemas/SchemaCardsGooglePayDecryptedECv1'
            - $ref: '#/components/schemas/SchemaCardsGooglePayDecryptedECv2'
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Specifies the payment processing flow using <code>auth</code> for a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        retry_attempt:
          type: integer
          description: |-
            Number of retry attempts for the subscription payments.

            <blockquote>
              <p>Use it for analytics and conversion tuning purposes.</p>
            </blockquote>
          minimum: 0
        force3ds:
          type: boolean
          description: Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.
          default: false
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_holder:
          type: string
          description: |-
            Cardholder's name as it appears on the card, which is essential for transaction processing.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
            </blockquote>
          minLength: 2
          maxLength: 52
          pattern: ^\w.{0,50}[\w.]$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; ">   
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        protocolVersion:
          type: string
          description: |-
            Identifies the encryption or signing scheme under which the message is created.
            The expected values are <code>ECv1</code> or <code>ECv2</code>, which define the <code>decrypted_data</code> object parameters.

            <blockquote>
              <p>This field is taken from Google's response.</p>
            </blockquote>
          enum:
            - ECv1
            - ECv2
        network:
          type: string
          description: Network (card brand) through which the payment is processed.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    RequestCardsSubscriptionPaymentGooglePay:
      title: Subscription payment
      type: object
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Google Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/google-pay/google-pay-h2h/" target="_blank">decrypted</a>.
          default: false
      discriminator:
        propertyName: is_decrypted
        mapping:
          'false': '#/components/schemas/SchemaCardsSubscriptionPaymentGooglePayEncrypted'
          'true': '#/components/schemas/SchemaCardsSubscriptionPaymentGooglePayDecrypted'
    ResponseCardsGooglePay:
      title: Success
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/SchemaCardsOrder'
            - type: object
              properties:
                product_id:
                  type: string
                  format: uuid
                  maxLength: 36
                  minLength: 36
                  description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
                product_name:
                  type: string
                  description: <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> name.
                  minLength: 1
                  maxLength: 500
                customer_account_id:
                  type: string
                  description: Unique customer identifier defined by the merchant.
                  maxLength: 100
                  example: 93a1c659-288d-4d62-929d-10e241078faa
                payment_method:
                  enum:
                    - google-pay
        transaction:
          $ref: '#/components/schemas/SchemaCardsTransaction'
        transactions:
          type: object
          description: Map of transactions where the keys are transaction identifiers.
          properties:
            <transaction_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsTransaction'
          required:
            - <transaction_id_value_#1>
        three_ds:
          $ref: '#/components/schemas/SchemaCardsThreeDs'
        routing:
          $ref: '#/components/schemas/SchemaCardsRouting'
        antifraud_result:
          $ref: '#/components/schemas/SchemaCardsAntifraudResult'
        verification_result:
          $ref: '#/components/schemas/SchemaCardsVerificationResult'
        chargebacks:
          type: object
          description: Map of chargebacks where the keys are chargeback identifiers.
          properties:
            <chargeback_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsChargeback'
        device_info:
          $ref: '#/components/schemas/SchemaCardsDeviceInfo'
        verify_url:
          type: string
          description: |-
            URL where the customer should be redirected to complete 3DS authentication.

            <blockquote>
              <p>Only after opening the URL and authenticating the order <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">status</a> change to <code>3ds_verify</code>.</p>
            </blockquote>
        redirect_url:
          type: string
          description: URL where customer should be redirected after finishing 3D Secure or redirect payment method.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        pay_form:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPayForm'
        payment_adviser:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPaymentAdviser'
      required:
        - order
        - transactions
    SchemaCardsApplePayEncrypted:
      title: 'false'
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - data
        - header
        - signature
        - version
        - type
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Apple Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/" target="_blank">decrypted</a>.
          default: false
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The value <strong>0</strong> is valid only for <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount</a> flow. If set to <strong>null</strong>, the default fallback value <strong>0</strong> will be used. </p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
            - estimated
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        industry_data:
          $ref: '#/components/schemas/SchemaCardsIndustryDataDiscriminatorCarRental'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>             
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: Actual content of the `accept` HTTP header as sent by the client browser.
        header_accept_language:
          type: string
          description: String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.
        browser_color_depth:
          type: integer
          description: Color depth of the customer browser during the payment.
        browser_screen_height:
          type: integer
          description: Screen height of the customer browser during the payment.
        browser_screen_width:
          type: integer
          description: Screen width of the customer browser during the payment.
        browser_java_enabled:
          type: boolean
          description: Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.
        time_zone_offset:
          type: integer
          description: Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.
        user_agent:
          type: string
          description: Device user-agent.
          minLength: 1
          maxLength: 1000
        data:
          type: string
          description: Encrypted payment data, Base64 encoded as a string.
        signature:
          type: string
          description: |-
            Signature of the payment and header data.

            <blockquote>
              <p>The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm.</p>
            </blockquote>
        version:
          type: string
          description: |-
            Version information about the payment token.

            <blockquote>
              <p>Token uses <code>EC_v1</code> for ECC-encrypted data and <code>RSA_v1</code> for RSA-encrypted data.</p>
            </blockquote>
        network:
          type: string
          description: Network (card brand) through which the payment is processed.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        header:
          type: object
          required:
            - transactionId
            - publicKeyHash
          description: Additional version-dependent information used to decrypt and verify the payment.
          properties:
            transactionId:
              type: string
              description: |-
                Transaction identifier generated on the device.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
                </blockquote>
            applicationData:
              type: string
              description: Hash of the X.509 encoded public key bytes of the merchant’s certificate.
            ephemeralPublicKey:
              type: string
              description: |-
                Ephemeral public key bytes.

                <blockquote style="border-left: 4px solid #F2C4C4; ">    
                  <p><b>Required</b> if the version is <code>EC_v1</code> only.</p>
                </blockquote>
            publicKeyHash:
              type: string
              description: Hash of the <code>applicationData</code> property of the original <code>PKPaymentRequest</code> object.
            wrappedKey:
              type: string
              description: |-
                Symmetric key wrapped using your RSA public key.

                <blockquote style="border-left: 4px solid #F2C4C4; ">    
                  <p><b>Required</b> if the version is <code>RSA_v1</code> only.</p>
                </blockquote>
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsApplePayDecrypted3DSecure:
      title: 3DSecure
      type: object
      required:
        - onlinePaymentCryptogram
      properties:
        onlinePaymentCryptogram:
          type: string
          description: Base64 encoded cardholder authentication value (20 bytes in decoded form) used for validating the authentication result.
          maxLength: 100
        eciIndicator:
          type: string
          description: |-
            Electronic Commerce Indicator (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/eci/#eci-for-digital-wallets" target="_blank">ECI</a>) level associated with the 3D Secure enrollment result.

            <blockquote style="border-left: 4px solid #F2E7C4; ">                
              <p><b>Highly recommended</b> to provide eci value for better transaction success rate.</p>
            </blockquote>
          minLength: 1
          maxLength: 2
    SchemaCardsApplePayDecryptedEMV:
      title: EMV
      type: object
      required:
        - emvData
      properties:
        emvData:
          type: string
          description: EMV chip data.
        encryptedPINData:
          type: string
          description: Encrypted cardholder's PIN data.
    SchemaCardsApplePayDecrypted:
      title: 'true'
      type: object
      required:
        - decrypted_data
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - header
        - type
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Apple Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/" target="_blank">decrypted</a>.
          default: false
        decrypted_data:
          type: object
          description: |-
            Object with decrypted Apple Pay payment data.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <strong>Requires</strong> the request to include <code>type</code> <code>auth</code> and <code>force3ds</code> <code>false</code>.
            </blockquote>
          required:
            - applicationPrimaryAccountNumber
            - applicationExpirationDate
            - currencyCode
            - transactionAmount
            - deviceManufacturerIdentifier
            - paymentDataType
            - paymentData
          properties:
            applicationPrimaryAccountNumber:
              type: string
              description: Primary account number (PAN) of the card that funds the transaction.
              minLength: 12
              maxLength: 19
            applicationExpirationDate:
              type: string
              description: PAN expiration date in <code>YYMMDD</code> format.
              format: YYMMDD
              example: '281231'
            currencyCode:
              type: string
              description: |-
                Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the order.

                <blockquote>
                  <p>Apple Pay uses numeric code for <code>currencyCode</code>, for example, it sends <code>840</code> instead of <code>USD</code>.</p>
                </blockquote>
              minLength: 3
              maxLength: 3
            transactionAmount:
              type: integer
              description: Transaction amount.
              minimum: 0
            cardholderName:
              type: string
              description: Cardholder's name as it appears on the card, which is essential for transaction processing.
              minLength: 2
              maxLength: 52
              pattern: ^\w.{0,50}[\w.]$
            deviceManufacturerIdentifier:
              type: string
              description: Customer's device identifier.
              maxLength: 255
            paymentDataType:
              type: string
              description: |-
                Type of payment data sent by Apple Pay.

                <blockquote>                
                  <p>Defines parameters of the <code>paymentData</code> object.</p>
                </blockquote>
              enum:
                - 3DSecure
                - EMV
            paymentData:
              type: object
              description: Additional payment data sent by Apple Pay.
              oneOf:
                - $ref: '#/components/schemas/SchemaCardsApplePayDecrypted3DSecure'
                - $ref: '#/components/schemas/SchemaCardsApplePayDecryptedEMV'
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The value <strong>0</strong> is valid only for <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount</a> flow. If set to <strong>null</strong>, the default fallback value <strong>0</strong> will be used. </p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
            - estimated
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        industry_data:
          $ref: '#/components/schemas/SchemaCardsIndustryDataDiscriminatorCarRental'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>             
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: Actual content of the `accept` HTTP header as sent by the client browser.
        header_accept_language:
          type: string
          description: String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.
        browser_color_depth:
          type: integer
          description: Color depth of the customer browser during the payment.
        browser_screen_height:
          type: integer
          description: Screen height of the customer browser during the payment.
        browser_screen_width:
          type: integer
          description: Screen width of the customer browser during the payment.
        browser_java_enabled:
          type: boolean
          description: Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.
        time_zone_offset:
          type: integer
          description: Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.
        user_agent:
          type: string
          description: Device user-agent.
          minLength: 1
          maxLength: 1000
        version:
          type: string
          description: |-
            Version information about the payment token.

            <blockquote>
              <p>Token uses <code>EC_v1</code> for ECC-encrypted data and <code>RSA_v1</code> for RSA-encrypted data.</p>
            </blockquote>
        network:
          type: string
          description: Network (card brand) through which the payment is processed.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        header:
          type: object
          required:
            - transactionId
            - publicKeyHash
          description: Additional version-dependent information used to decrypt and verify the payment.
          properties:
            transactionId:
              type: string
              description: |-
                Transaction identifier generated on the device.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
                </blockquote>
            applicationData:
              type: string
              description: Hash of the X.509 encoded public key bytes of the merchant’s certificate.
            ephemeralPublicKey:
              type: string
              description: |-
                Ephemeral public key bytes.

                <blockquote style="border-left: 4px solid #F2C4C4; ">    
                  <p><b>Required</b> if the version is <code>EC_v1</code> only.</p>
                </blockquote>
            publicKeyHash:
              type: string
              description: Hash of the <code>applicationData</code> property of the original <code>PKPaymentRequest</code> object.
            wrappedKey:
              type: string
              description: |-
                Symmetric key wrapped using your RSA public key.

                <blockquote style="border-left: 4px solid #F2C4C4; ">    
                  <p><b>Required</b> if the version is <code>RSA_v1</code> only.</p>
                </blockquote>
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    RequestCardsApplePay:
      title: Payment
      type: object
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Apple Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/" target="_blank">decrypted</a>.
          default: false
      discriminator:
        propertyName: is_decrypted
        mapping:
          'false': '#/components/schemas/SchemaCardsApplePayEncrypted'
          'true': '#/components/schemas/SchemaCardsApplePayDecrypted'
    SchemaCardsProductBasedPaymentApplePayEncrypted:
      title: 'false'
      type: object
      required:
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - ip_address
        - platform
        - data
        - header
        - signature
        - version
        - type
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Apple Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/" target="_blank">decrypted</a>.
          default: false
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>            
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: Actual content of the `accept` HTTP header as sent by the client browser.
        header_accept_language:
          type: string
          description: String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.
        browser_color_depth:
          type: integer
          description: Color depth of the customer browser during the payment.
        browser_screen_height:
          type: integer
          description: Screen height of the customer browser during the payment.
        browser_screen_width:
          type: integer
          description: Screen width of the customer browser during the payment.
        browser_java_enabled:
          type: boolean
          description: Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.
        time_zone_offset:
          type: integer
          description: Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.
        user_agent:
          type: string
          description: Device user-agent.
          minLength: 1
          maxLength: 1000
        data:
          type: string
          description: Encrypted payment data, Base64 encoded as a string.
        signature:
          type: string
          description: |-
            Signature of the payment and header data.

            <blockquote>
              <p>The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm.</p>
            </blockquote>
        version:
          type: string
          description: |-
            Version information about the payment token.

            <blockquote>
              <p>Token uses `EC_v1` for ECC-encrypted data and `RSA_v1` for RSA-encrypted data.</p>
            </blockquote>
        network:
          type: string
          description: Network (card brand) through which the payment is processed.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        header:
          type: object
          required:
            - transactionId
            - publicKeyHash
          description: Additional version-dependent information used to decrypt and verify the payment.
          properties:
            transactionId:
              type: string
              description: |-
                Transaction identifier generated on the device.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
                </blockquote>
            applicationData:
              type: string
              description: Hash of the X.509 encoded public key bytes of the merchant’s certificate.
            ephemeralPublicKey:
              type: string
              description: |-
                Ephemeral public key bytes.

                <blockquote style="border-left: 4px solid #F2C4C4; ">    
                  <p><b>Required</b> if the version is <code>EC_v1</code> only.</p>
                </blockquote>
            publicKeyHash:
              type: string
              description: Hash of the <code>applicationData</code> property of the original <code>PKPaymentRequest</code> object.
            wrappedKey:
              type: string
              description: |-
                Symmetric key wrapped using your RSA public key.

                <blockquote style="border-left: 4px solid #F2C4C4; ">    
                  <p><b>Required</b> if the version is <code>RSA_v1</code> only.</p>
                </blockquote>
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsProductBasedPaymentApplePayDecrypted:
      title: 'true'
      type: object
      required:
        - decrypted_data
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - header
        - ip_address
        - platform
        - type
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Apple Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/" target="_blank">decrypted</a>.
          default: false
        decrypted_data:
          type: object
          description: |-
            Object with decrypted Apple Pay payment data.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <strong>Requires</strong> the request to include <code>type</code> <code>auth</code> and <code>force3ds</code> <code>false</code>.
            </blockquote>
          required:
            - applicationPrimaryAccountNumber
            - applicationExpirationDate
            - currencyCode
            - transactionAmount
            - deviceManufacturerIdentifier
            - paymentDataType
            - paymentData
          properties:
            applicationPrimaryAccountNumber:
              type: string
              description: Primary account number (PAN) of the card that funds the transaction.
              minLength: 12
              maxLength: 19
            applicationExpirationDate:
              type: string
              description: PAN expiration date in <code>YYMMDD</code> format.
              format: YYMMDD
              example: '281231'
            currencyCode:
              type: string
              description: |-
                Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the order.

                <blockquote>
                  <p>Apple Pay uses numeric code for <code>currencyCode</code>, for example, it sends <code>840</code> instead of <code>USD</code>.</p>
                </blockquote>
              minLength: 3
              maxLength: 3
            transactionAmount:
              type: integer
              description: Transaction amount.
              minimum: 0
            cardholderName:
              type: string
              description: Cardholder's name as it appears on the card, which is essential for transaction processing.
              minLength: 2
              maxLength: 52
              pattern: ^\w.{0,50}[\w.]$
            deviceManufacturerIdentifier:
              type: string
              description: Customer's device identifier.
              maxLength: 255
            paymentDataType:
              type: string
              description: |-
                Type of payment data sent by Apple Pay.

                <blockquote>                
                  <p>Defines parameters of the <code>paymentData</code> object.</p>
                </blockquote>
              enum:
                - 3DSecure
                - EMV
            paymentData:
              type: object
              description: Additional payment data sent by Apple Pay.
              oneOf:
                - $ref: '#/components/schemas/SchemaCardsApplePayDecrypted3DSecure'
                - $ref: '#/components/schemas/SchemaCardsApplePayDecryptedEMV'
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>            
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: Actual content of the `accept` HTTP header as sent by the client browser.
        header_accept_language:
          type: string
          description: String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.
        browser_color_depth:
          type: integer
          description: Color depth of the customer browser during the payment.
        browser_screen_height:
          type: integer
          description: Screen height of the customer browser during the payment.
        browser_screen_width:
          type: integer
          description: Screen width of the customer browser during the payment.
        browser_java_enabled:
          type: boolean
          description: Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.
        time_zone_offset:
          type: integer
          description: Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.
        user_agent:
          type: string
          description: Device user-agent.
          minLength: 1
          maxLength: 1000
        version:
          type: string
          description: |-
            Version information about the payment token.

            <blockquote>
              <p>Token uses <code>EC_v1</code> for ECC-encrypted data and <code>RSA_v1</code> for RSA-encrypted data.</p>
            </blockquote>
        network:
          type: string
          description: Network (card brand) through which the payment is processed.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        header:
          type: object
          required:
            - transactionId
            - publicKeyHash
          description: Additional version-dependent information used to decrypt and verify the payment.
          properties:
            transactionId:
              type: string
              description: |-
                Transaction identifier generated on the device.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
                </blockquote>
            applicationData:
              type: string
              description: Hash of the X.509 encoded public key bytes of the merchant’s certificate.
            ephemeralPublicKey:
              type: string
              description: |-
                Ephemeral public key bytes.

                <blockquote style="border-left: 4px solid #F2C4C4; ">    
                  <p><b>Required</b> if the version is <code>EC_v1</code> only.</p>
                </blockquote>
            publicKeyHash:
              type: string
              description: Hash of the <code>applicationData</code> property of the original <code>PKPaymentRequest</code> object.
            wrappedKey:
              type: string
              description: |-
                Symmetric key wrapped using your RSA public key.

                <blockquote style="border-left: 4px solid #F2C4C4; ">    
                  <p><b>Required</b> if the version is <code>RSA_v1</code> only.</p>
                </blockquote>
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    RequestCardsProductBasedPaymentApplePay:
      title: Product-based payment
      type: object
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Apple Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/" target="_blank">decrypted</a>.
          default: false
      discriminator:
        propertyName: is_decrypted
        mapping:
          'false': '#/components/schemas/SchemaCardsProductBasedPaymentApplePayEncrypted'
          'true': '#/components/schemas/SchemaCardsProductBasedPaymentApplePayDecrypted'
    SchemaCardsSubscriptionPaymentApplePayEncrypted:
      title: 'false'
      type: object
      required:
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - ip_address
        - platform
        - data
        - header
        - signature
        - version
        - type
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Apple Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/" target="_blank">decrypted</a>.
          default: false
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        retry_attempt:
          type: integer
          description: |-
            Number of retry attempts for the subscription payments.

            <blockquote>
              <p>Use it for analytics and conversion tuning purposes.</p>
            </blockquote>
          minimum: 0
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>            
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: Actual content of the `accept` HTTP header as sent by the client browser.
        header_accept_language:
          type: string
          description: String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.
        browser_color_depth:
          type: integer
          description: Color depth of the customer browser during the payment.
        browser_screen_height:
          type: integer
          description: Screen height of the customer browser during the payment.
        browser_screen_width:
          type: integer
          description: Screen width of the customer browser during the payment.
        browser_java_enabled:
          type: boolean
          description: Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.
        time_zone_offset:
          type: integer
          description: Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.
        user_agent:
          type: string
          description: Device user-agent.
          minLength: 1
          maxLength: 1000
        data:
          type: string
          description: Encrypted payment data, Base64 encoded as a string.
        signature:
          type: string
          description: |-
            Signature of the payment and header data.

            <blockquote>
              <p>The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm.</p>
            </blockquote>
        version:
          type: string
          description: |-
            Version information about the payment token.

            <blockquote>
              <p>Token uses `EC_v1` for ECC-encrypted data and `RSA_v1` for RSA-encrypted data.</p>
            </blockquote>
        network:
          type: string
          description: Network (card brand) through which the payment is processed.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        header:
          type: object
          required:
            - transactionId
            - publicKeyHash
          description: Additional version-dependent information used to decrypt and verify the payment.
          properties:
            transactionId:
              type: string
              description: |-
                Transaction identifier generated on the device.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
                </blockquote>
            applicationData:
              type: string
              description: Hash of the X.509 encoded public key bytes of the merchant’s certificate.
            ephemeralPublicKey:
              type: string
              description: |-
                Ephemeral public key bytes.

                <blockquote style="border-left: 4px solid #F2C4C4; ">    
                  <p><b>Required</b> if the version is <code>EC_v1</code> only.</p>
                </blockquote>
            publicKeyHash:
              type: string
              description: Hash of the <code>applicationData</code> property of the original <code>PKPaymentRequest</code> object.
            wrappedKey:
              type: string
              description: |-
                Symmetric key wrapped using your RSA public key.

                <blockquote style="border-left: 4px solid #F2C4C4; ">    
                  <p><b>Required</b> if the version is <code>RSA_v1</code> only.</p>
                </blockquote>
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    SchemaCardsSubscriptionPaymentApplePayDecrypted:
      title: 'true'
      type: object
      required:
        - decrypted_data
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - header
        - ip_address
        - platform
        - type
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Apple Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/" target="_blank">decrypted</a>.
          default: false
        decrypted_data:
          type: object
          description: |-
            Object with decrypted Apple Pay payment data.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <strong>Requires</strong> the request to include <code>type</code> <code>auth</code> and <code>force3ds</code> <code>false</code>.
            </blockquote>
          required:
            - applicationPrimaryAccountNumber
            - applicationExpirationDate
            - currencyCode
            - transactionAmount
            - deviceManufacturerIdentifier
            - paymentDataType
            - paymentData
          properties:
            applicationPrimaryAccountNumber:
              type: string
              description: Primary account number (PAN) of the card that funds the transaction.
              minLength: 12
              maxLength: 19
            applicationExpirationDate:
              type: string
              description: PAN expiration date in <code>YYMMDD</code> format.
              format: YYMMDD
              example: '281231'
            currencyCode:
              type: string
              description: |-
                Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the order.

                <blockquote>
                  <p>Apple Pay uses numeric code for <code>currencyCode</code>, for example, it sends <code>840</code> instead of <code>USD</code>.</p>
                </blockquote>
              minLength: 3
              maxLength: 3
            transactionAmount:
              type: integer
              description: Transaction amount.
              minimum: 0
            cardholderName:
              type: string
              description: Cardholder's name as it appears on the card, which is essential for transaction processing.
              minLength: 2
              maxLength: 52
              pattern: ^\w.{0,50}[\w.]$
            deviceManufacturerIdentifier:
              type: string
              description: Customer's device identifier.
              maxLength: 255
            paymentDataType:
              type: string
              description: |-
                Type of payment data sent by Apple Pay.

                <blockquote>                
                  <p>Defines parameters of the <code>paymentData</code> object.</p>
                </blockquote>
              enum:
                - 3DSecure
                - EMV
            paymentData:
              type: object
              description: Additional payment data sent by Apple Pay.
              oneOf:
                - $ref: '#/components/schemas/SchemaCardsApplePayDecrypted3DSecure'
                - $ref: '#/components/schemas/SchemaCardsApplePayDecryptedEMV'
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        retry_attempt:
          type: integer
          description: |-
            Number of retry attempts for the subscription payments.

            <blockquote>
              <p>Use it for analytics and conversion tuning purposes.</p>
            </blockquote>
          minimum: 0
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>            
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          maxLength: 3
          minLength: 3
          default: WEB
        header_accept:
          type: string
          description: Actual content of the `accept` HTTP header as sent by the client browser.
        header_accept_language:
          type: string
          description: String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.
        browser_color_depth:
          type: integer
          description: Color depth of the customer browser during the payment.
        browser_screen_height:
          type: integer
          description: Screen height of the customer browser during the payment.
        browser_screen_width:
          type: integer
          description: Screen width of the customer browser during the payment.
        browser_java_enabled:
          type: boolean
          description: Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.
        time_zone_offset:
          type: integer
          description: Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.
        user_agent:
          type: string
          description: Device user-agent.
          minLength: 1
          maxLength: 1000
        version:
          type: string
          description: |-
            Version information about the payment token.

            <blockquote>
              <p>Token uses <code>EC_v1</code> for ECC-encrypted data and <code>RSA_v1</code> for RSA-encrypted data.</p>
            </blockquote>
        network:
          type: string
          description: Network (card brand) through which the payment is processed.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        header:
          type: object
          required:
            - transactionId
            - publicKeyHash
          description: Additional version-dependent information used to decrypt and verify the payment.
          properties:
            transactionId:
              type: string
              description: |-
                Transaction identifier generated on the device.

                <blockquote style="border-left: 4px solid #F2E7C4; ">
                  <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
                </blockquote>
            applicationData:
              type: string
              description: Hash of the X.509 encoded public key bytes of the merchant’s certificate.
            ephemeralPublicKey:
              type: string
              description: |-
                Ephemeral public key bytes.

                <blockquote style="border-left: 4px solid #F2C4C4; ">    
                  <p><b>Required</b> if the version is <code>EC_v1</code> only.</p>
                </blockquote>
            publicKeyHash:
              type: string
              description: Hash of the <code>applicationData</code> property of the original <code>PKPaymentRequest</code> object.
            wrappedKey:
              type: string
              description: |-
                Symmetric key wrapped using your RSA public key.

                <blockquote style="border-left: 4px solid #F2C4C4; ">    
                  <p><b>Required</b> if the version is <code>RSA_v1</code> only.</p>
                </blockquote>
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    RequestCardsSubscriptionPaymentApplePay:
      title: Subscription payment
      type: object
      properties:
        is_decrypted:
          type: boolean
          description: Indicates whether the payload received from Apple Pay was previously <a href="https://docs.solidgate.com/payments/digital-wallets/apple-pay/apple-pay-h2h/" target="_blank">decrypted</a>.
          default: false
      discriminator:
        propertyName: is_decrypted
        mapping:
          'false': '#/components/schemas/SchemaCardsSubscriptionPaymentApplePayEncrypted'
          'true': '#/components/schemas/SchemaCardsSubscriptionPaymentApplePayDecrypted'
    ResponseCardsApplePay:
      title: Success
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/SchemaCardsOrder'
            - type: object
              properties:
                product_id:
                  type: string
                  format: uuid
                  maxLength: 36
                  minLength: 36
                  description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
                product_name:
                  type: string
                  description: <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> name.
                  minLength: 1
                  maxLength: 500
                customer_account_id:
                  type: string
                  description: Unique customer identifier defined by the merchant.
                  maxLength: 100
                  example: 93a1c659-288d-4d62-929d-10e241078faa
                payment_method:
                  enum:
                    - apple-pay
        transaction:
          $ref: '#/components/schemas/SchemaCardsTransaction'
        transactions:
          type: object
          description: Map of transactions where the keys are transaction identifiers.
          properties:
            <transaction_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsTransaction'
          required:
            - <transaction_id_value_#1>
        three_ds:
          $ref: '#/components/schemas/SchemaCardsThreeDs'
        routing:
          $ref: '#/components/schemas/SchemaCardsRouting'
        antifraud_result:
          $ref: '#/components/schemas/SchemaCardsAntifraudResult'
        verification_result:
          $ref: '#/components/schemas/SchemaCardsVerificationResult'
        chargebacks:
          type: object
          description: Map of chargebacks where the keys are chargeback identifiers.
          properties:
            <chargeback_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsChargeback'
        device_info:
          $ref: '#/components/schemas/SchemaCardsDeviceInfo'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        pay_form:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPayForm'
        payment_adviser:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPaymentAdviser'
      required:
        - order
        - transactions
    RequestCardsIncrement:
      title: Payment incremental auth
      type: object
      required:
        - order_id
        - amount
      properties:
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Increment amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The amount represents the increment value to add to the initial authorization, not the total amount.</p>
            </blockquote>
          minimum: 1
    ResponseCardsIncrement:
      title: Success
      type: object
      properties:
        transaction:
          type: object
          description: Transaction details for the incremental authorization.
          properties:
            id:
              type: string
              description: Unique transaction identifier.
              example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
            amount:
              type: integer
              description: Increment amount from the request in the smallest currency unit.
              example: 500
            currency:
              type: string
              description: Currency code from the initial order.
              example: EUR
            status:
              type: string
              description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
              example: processing
    RequestCardsRecurring:
      title: Payment
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - recurring_token
        - customer_email
        - ip_address
        - platform
        - payment_type
        - type
      properties:
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The value <strong>0</strong> is valid only for <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount</a> flow. If set to <strong>null</strong>, the default fallback value <strong>0</strong> will be used. </p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
            - estimated
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        payment_type:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided <code>1-click</code> for Apple Pay/Google Pay tokens.</p>
            </blockquote>
          enum:
            - 1-click
            - recurring
            - retry
            - installment
            - rebill
        recurring_token:
          type: string
          description: |-
            Token associated with a card method that could be used for subsequent payments.

            <blockquote>
              <p>The <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> is not generated for all types of payment flows.</p>
            </blockquote>
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to set <code>true</code> and send it with the <code>external_mpi_data</code> object, as it helps optimize payment success rates.</p>
            </blockquote>
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersion'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                 
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>             
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                  
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    RequestCardsProductBasedPaymentRecurring:
      title: Product-based payment
      type: object
      required:
        - product_id
        - order_id
        - order_description
        - recurring_token
        - customer_account_id
        - customer_email
        - ip_address
        - platform
        - payment_type
        - type
      properties:
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief description of the order.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        payment_type:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided <code>1-click</code> for Apple Pay/Google Pay tokens.</p>
            </blockquote>
          enum:
            - 1-click
            - recurring
            - retry
            - installment
            - rebill
        recurring_token:
          type: string
          description: |-
            Token associated with a card method that could be used for subsequent payments.

            <blockquote>
              <p>The <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> is not generated for all types of payment flows.</p>
            </blockquote>
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to set <code>true</code> and send it with the <code>external_mpi_data</code> object, as it helps optimize payment success rates.</p>
            </blockquote>
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersion'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>         
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    RequestCardsSubscriptionPaymentRecurring:
      title: Subscription payment
      type: object
      required:
        - product_id
        - order_id
        - order_description
        - recurring_token
        - customer_account_id
        - customer_email
        - ip_address
        - platform
        - payment_type
        - type
      properties:
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief description of the order.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        payment_type:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Should not be</b> provided <code>1-click</code> for Apple Pay/Google Pay tokens.</p>
            </blockquote>
          enum:
            - 1-click
            - recurring
            - retry
            - installment
            - rebill
        recurring_token:
          type: string
          description: |-
            Token associated with a card method that could be used for subsequent payments.

            <blockquote>
              <p>The <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> is not generated for all types of payment flows.</p>
            </blockquote>
        retry_attempt:
          type: integer
          description: |-
            Number of retry attempts for the subscription payments.

            <blockquote>
              <p>Use it for analytics and conversion tuning purposes.</p>
            </blockquote>
          minimum: 0
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to set <code>true</code> and send it with the <code>external_mpi_data</code> object, as it helps optimize payment success rates.</p>
            </blockquote>
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersion'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>         
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    ResponseCardsRecurring:
      title: Success
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/SchemaCardsOrder'
            - type: object
              properties:
                product_id:
                  type: string
                  format: uuid
                  maxLength: 36
                  minLength: 36
                  description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
                product_name:
                  type: string
                  description: <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> name.
                  minLength: 1
                  maxLength: 500
                customer_account_id:
                  type: string
                  description: Unique customer identifier defined by the merchant.
                  maxLength: 100
                  example: 93a1c659-288d-4d62-929d-10e241078faa
                payment_method:
                  enum:
                    - token
        transaction:
          allOf:
            - $ref: '#/components/schemas/SchemaCardsTransaction'
            - type: object
              properties:
                card_token:
                  allOf:
                    - $ref: '#/components/schemas/SchemaCardsCardToken'
                    - type: object
                      properties:
                        original_payment_method:
                          type: string
                          description: Payment method used to capture the card credentials at <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> creation.
                          enum:
                            - card
                            - apple-pay
                            - google-pay
                            - network-token
                            - click-to-pay
                          example: card
                card:
                  allOf:
                    - $ref: '#/components/schemas/SchemaCardsCard'
                    - type: object
                      properties:
                        card_token:
                          allOf:
                            - $ref: '#/components/schemas/SchemaCardsCardToken'
                            - type: object
                              properties:
                                original_payment_method:
                                  type: string
                                  description: Payment method used to capture the card credentials at <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> creation.
                                  enum:
                                    - card
                                    - apple-pay
                                    - google-pay
                                    - network-token
                                    - click-to-pay
                                  example: card
        transactions:
          type: object
          description: Map of transactions where the keys are transaction identifiers.
          properties:
            <transaction_id_value_#1>:
              allOf:
                - $ref: '#/components/schemas/SchemaCardsTransaction'
                - type: object
                  properties:
                    card_token:
                      allOf:
                        - $ref: '#/components/schemas/SchemaCardsCardToken'
                        - type: object
                          properties:
                            original_payment_method:
                              type: string
                              description: Payment method used to capture the card credentials at <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> creation.
                              enum:
                                - card
                                - apple-pay
                                - google-pay
                                - network-token
                                - click-to-pay
                              example: card
                    card:
                      allOf:
                        - $ref: '#/components/schemas/SchemaCardsCard'
                        - type: object
                          properties:
                            card_token:
                              allOf:
                                - $ref: '#/components/schemas/SchemaCardsCardToken'
                                - type: object
                                  properties:
                                    original_payment_method:
                                      type: string
                                      description: Payment method used to capture the card credentials at <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> creation.
                                      enum:
                                        - card
                                        - apple-pay
                                        - google-pay
                                        - network-token
                                        - click-to-pay
                                      example: card
          required:
            - <transaction_id_value_#1>
        three_ds:
          $ref: '#/components/schemas/SchemaCardsThreeDs'
        antifraud_result:
          $ref: '#/components/schemas/SchemaCardsAntifraudResult'
        verification_result:
          $ref: '#/components/schemas/SchemaCardsVerificationResult'
        chargebacks:
          type: object
          description: Map of chargebacks where the keys are chargeback identifiers.
          properties:
            <chargeback_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsChargeback'
        device_info:
          $ref: '#/components/schemas/SchemaCardsDeviceInfo'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        pay_form:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPayForm'
        payment_adviser:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPaymentAdviser'
      required:
        - order
        - transactions
    RequestCardsResign:
      title: Payment
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - recurring_token
        - customer_email
        - ip_address
        - platform
        - type
      properties:
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>                
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
              <p>The value <strong>0</strong> is valid only for <a href="https://docs.solidgate.com/payments/card-payments/zero-amount-authorization" target="_blank">zero-amount</a> flow. If set to <strong>null</strong>, the default fallback value <strong>0</strong> will be used. </p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief description of the order.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
            - estimated
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        recurring_token:
          type: string
          description: |-
            Token associated with a card method that could be used for subsequent payments.

            <blockquote>
              <p>The <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> is not generated for all types of payment flows.</p>
            </blockquote>
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to set <code>true</code> and send it with the <code>external_mpi_data</code> object, as it helps optimize payment success rates.</p>
            </blockquote>
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersion'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_cvv:
          type: string
          description: Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.
          pattern: ^[0-9]{3,4}$
        industry_data:
          $ref: '#/components/schemas/SchemaCardsIndustryDataDiscriminatorCarRental'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>            
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO 3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          maxLength: 3
          minLength: 3
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Object with <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank"> additional customer data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    RequestCardsProductBasedPaymentResign:
      title: Product-based payment
      type: object
      required:
        - product_id
        - order_id
        - order_description
        - recurring_token
        - customer_account_id
        - customer_email
        - ip_address
        - platform
        - type
      properties:
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief description of the order.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        recurring_token:
          type: string
          description: |-
            Token associated with a card method that could be used for subsequent payments.

            <blockquote>
              <p>The <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> is not generated for all types of payment flows.</p>
            </blockquote>
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to set <code>true</code> and send it with the <code>external_mpi_data</code> object, as it helps optimize payment success rates.</p>
            </blockquote>
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersion'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_cvv:
          type: string
          description: Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.
          pattern: ^[0-9]{3,4}$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    RequestCardsSubscriptionPaymentResign:
      title: Subscription payment
      type: object
      required:
        - product_id
        - order_id
        - order_description
        - recurring_token
        - customer_account_id
        - customer_email
        - ip_address
        - platform
        - type
      properties:
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to keep the payment description under 100 characters for clarity.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 255
        order_items:
          type: string
          description: Names and descriptions of the items included in the order.
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        order_number:
          type: integer
          format: int32
          description: Sequential number of the order within the customer account.
        type:
          type: string
          deprecated: true
          description: Initiates a <a href="https://docs.solidgate.com/payments/payments-overview/#auth--settle" target="_blank">two-step</a> payment flow.
          enum:
            - auth
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
            - `240` hours = 10 days for Visa customer-initiated payments
            - `120` hours = 5 days for Visa merchant-initiated payments
            - `168` hours = 7 days for all other card brands   

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
            <blockquote>
              <p>If <code>null</code>, the responsibility for initiating the second stage of the payment via a separate <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/settle-card-order" target="_blank">settle</a> request is on the API user.</p>
            </blockquote>
          maximum: 240
          minimum: 0
        authorization_type:
          type: string
          enum:
            - final
          default: final
          description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
        recurring_token:
          type: string
          description: |-
            Token associated with a card method that could be used for subsequent payments.

            <blockquote>
              <p>The <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> is not generated for all types of payment flows.</p>
            </blockquote>
        retry_attempt:
          type: integer
          description: |-
            Number of retry attempts for the subscription payments.

            <blockquote>
              <p>Use it for analytics and conversion tuning purposes.</p>
            </blockquote>
          minimum: 0
        force3ds:
          type: boolean
          description: |-
            Indicates whether to force 3D Secure (<a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a>) authentication.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to set <code>true</code> and send it with the <code>external_mpi_data</code> object, as it helps optimize payment success rates.</p>
            </blockquote>
        external_mpi_data:
          $ref: '#/components/schemas/SchemaCardsExternalMpiDsVersion'
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
          example: 93a1c659-288d-4d62-929d-10e241078faa
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number, including the country code.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        card_cvv:
          type: string
          description: Card verification value/code (CVV) for card sources, 3 digits for most cards and 4 digits for American Express cards.
          pattern: ^[0-9]{3,4}$
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        traffic_source:
          type: string
          description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
          maxLength: 255
        transaction_source:
          type: string
          description: Identifies the internal system or flow that triggered the transaction.
          maxLength: 255
        purchase_country:
          type: string
          description: |-
            Country where the goods are purchased in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> format.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> to specify if you are registered as a marketplace with international payment systems.</p>
              <p>Being a marketplace means you operate a platform where multiple sellers offer goods or services.</p>
            </blockquote>
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_country:
          type: string
          description: Country where the customer account is registered on the merchant platform.
          default: GBR
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        geo_city:
          type: string
          description: City where the customer account is registered on the merchant platform.
          maxLength: 100
        country:
          type: string
          description: Billing address country.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 10
        city:
          type: string
          description: Billing address city.
          maxLength: 100
        zip_code:
          type: string
          description: Postal code of the cardholder's billing address.
          maxLength: 10
        address:
          type: string
          description: First and second line of the billing address.
          maxLength: 100
        shipping_address:
          $ref: '#/components/schemas/SchemaCardsShippingAddressAppleGoogle'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        website:
          type: string
          description: Website from which payment is originated.
          maxLength: 255
        device:
          type: string
          description: Name and model of the device.
          maxLength: 50
        device_sessions:
          $ref: '#/components/schemas/SchemaCardsDeviceSessions'
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        header_accept:
          type: string
          description: |-
            Actual content of the `accept` HTTP header as sent by the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        header_accept_language:
          type: string
          description: |-
            String indicating the language of the browser, obtained via the `navigator.language` property of the client browser.

            <blockquote style="border-left: 4px solid #F2C4C4; ">
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to follow the <a href="https://tools.ietf.org/html/bcp47" target="_blank">IETF BCP 47</a> language tag standards for format consistency.</p>
            </blockquote>
        browser_color_depth:
          type: integer
          description: |-
            Color depth of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_height:
          type: integer
          description: |-
            Screen height of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_screen_width:
          type: integer
          description: |-
            Screen width of the customer browser during the payment.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        browser_java_enabled:
          type: boolean
          description: |-
            Boolean that represents the browser capacity to execute Java. The value is the one returned by the `navigator.javaEnabled()` function, it can be true or false.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        time_zone_offset:
          type: integer
          description: |-
            Time difference, in minutes, between UTC time and the local time of the cardholder's browser. Its value is 120 for a user in the UTC+2 time zone and -570 for the UTC-09:30 time zone.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
        user_agent:
          type: string
          description: |-
            Device user-agent.

            <blockquote style="border-left: 4px solid #F2C4C4; "> 
              <p><b>Required</b> for the <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3D Secure 2.0</a> <code>force3ds</code> <code>true</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_type_data:
          type: object
          description: Additional customer <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">data</a> to process payments in specific locations.
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        fraudulent:
          type: boolean
          description: Whether the merchant system has flagged this customer as suspicious.
          deprecated: true
          default: false
    ResponseCardsResign:
      title: Success
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/SchemaCardsOrder'
            - type: object
              properties:
                product_id:
                  type: string
                  format: uuid
                  maxLength: 36
                  minLength: 36
                  description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
                product_name:
                  type: string
                  description: <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> name.
                  minLength: 1
                  maxLength: 500
                customer_account_id:
                  type: string
                  description: Unique customer identifier defined by the merchant.
                  maxLength: 100
                  example: 93a1c659-288d-4d62-929d-10e241078faa
                payment_method:
                  enum:
                    - card
        transaction:
          $ref: '#/components/schemas/SchemaCardsTransaction'
        transactions:
          type: object
          description: Map of transactions where the keys are transaction identifiers.
          properties:
            <transaction_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsTransaction'
          required:
            - <transaction_id_value_#1>
        three_ds:
          $ref: '#/components/schemas/SchemaCardsThreeDs'
        routing:
          $ref: '#/components/schemas/SchemaCardsRouting'
        antifraud_result:
          $ref: '#/components/schemas/SchemaCardsAntifraudResult'
        verification_result:
          $ref: '#/components/schemas/SchemaCardsVerificationResult'
        chargebacks:
          type: object
          description: Map of chargebacks where the keys are chargeback identifiers.
          properties:
            <chargeback_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsChargeback'
        device_info:
          $ref: '#/components/schemas/SchemaCardsDeviceInfo'
        verify_url:
          type: string
          description: |-
            URL where the customer should be redirected to complete 3DS authentication.

            <blockquote>
              <p>Only after opening the URL and authenticating the order <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">status</a> change to <code>3ds_verify</code>.</p>
            </blockquote>
        redirect_url:
          type: string
          description: URL where customer should be redirected after finishing 3D Secure or redirect payment method.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        pay_form:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPayForm'
        payment_adviser:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPaymentAdviser'
      required:
        - order
        - transactions
    RequestCardsRefund:
      title: CardRequestRefund
      type: object
      properties:
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
            </blockquote>
          exclusiveMinimum: true
          minimum: 0
        refund_reason_code:
          type: string
          description: |-
            Code representing the <a href="https://docs.solidgate.com/payments/payments-insights/refund-reasons/" target="_blank">reason</a> for the refund.

            <blockquote>
              <p>This code is used to identify the reason for both <code>void</code> and <code>refund</code> transactions <code>operation</code></p>
            </blockquote>
          minLength: 4
          maxLength: 4
      required:
        - amount
        - order_id
    ResponseCardsRefund:
      title: Success
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/SchemaCardsOrder'
            - type: object
              properties:
                product_id:
                  type: string
                  format: uuid
                  maxLength: 36
                  minLength: 36
                  description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
                product_name:
                  type: string
                  description: <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> name.
                  minLength: 1
                  maxLength: 500
                customer_account_id:
                  type: string
                  description: Unique customer identifier defined by the merchant.
                  maxLength: 100
                  example: 93a1c659-288d-4d62-929d-10e241078faa
                payment_method:
                  enum:
                    - card
                    - network-token
                    - token
                    - apple-pay
                    - google-pay
        transaction:
          $ref: '#/components/schemas/SchemaCardsTransaction'
        transactions:
          type: object
          description: Map of transactions where the keys are transaction identifiers.
          properties:
            <transaction_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsTransaction'
          required:
            - <transaction_id_value_#1>
        three_ds:
          $ref: '#/components/schemas/SchemaCardsThreeDs'
        routing:
          $ref: '#/components/schemas/SchemaCardsRouting'
        antifraud_result:
          $ref: '#/components/schemas/SchemaCardsAntifraudResult'
        verification_result:
          $ref: '#/components/schemas/SchemaCardsVerificationResult'
        chargebacks:
          type: object
          description: Map of chargebacks where the keys are chargeback identifiers.
          properties:
            <chargeback_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsChargeback'
        device_info:
          $ref: '#/components/schemas/SchemaCardsDeviceInfo'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        pay_form:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPayForm'
        payment_adviser:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPaymentAdviser'
      required:
        - order
        - transactions
    RequestCardsVoid:
      title: RequestCardsVoid
      type: object
      properties:
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
          example: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
      required:
        - order_id
    ResponseCardsVoid:
      title: Success
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/SchemaCardsOrder'
            - type: object
              properties:
                product_id:
                  type: string
                  format: uuid
                  maxLength: 36
                  minLength: 36
                  description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
                product_name:
                  type: string
                  description: <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> name.
                  minLength: 1
                  maxLength: 500
                customer_account_id:
                  type: string
                  description: Unique customer identifier defined by the merchant.
                  maxLength: 100
                  example: 93a1c659-288d-4d62-929d-10e241078faa
                payment_method:
                  enum:
                    - card
                    - network-token
                    - token
                    - apple-pay
                    - google-pay
        transaction:
          $ref: '#/components/schemas/SchemaCardsTransaction'
        transactions:
          type: object
          description: Map of transactions where the keys are transaction identifiers.
          properties:
            <transaction_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsTransaction'
          required:
            - <transaction_id_value_#1>
        three_ds:
          $ref: '#/components/schemas/SchemaCardsThreeDs'
        routing:
          $ref: '#/components/schemas/SchemaCardsRouting'
        antifraud_result:
          $ref: '#/components/schemas/SchemaCardsAntifraudResult'
        verification_result:
          $ref: '#/components/schemas/SchemaCardsVerificationResult'
        chargebacks:
          type: object
          description: Map of chargebacks where the keys are chargeback identifiers.
          properties:
            <chargeback_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsChargeback'
        device_info:
          $ref: '#/components/schemas/SchemaCardsDeviceInfo'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        pay_form:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPayForm'
        payment_adviser:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPaymentAdviser'
      required:
        - order
        - transactions
    RequestCardsSettle:
      title: CardRequestSettle
      type: object
      properties:
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
          example: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount:
          type: integer
          description: |-
            Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
            </blockquote>
          exclusiveMinimum: true
          minimum: 0
          example: 1020
      required:
        - amount
        - order_id
    ResponseCardsSettle:
      title: Success
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/SchemaCardsOrder'
            - type: object
              properties:
                product_id:
                  type: string
                  format: uuid
                  maxLength: 36
                  minLength: 36
                  description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
                product_name:
                  type: string
                  description: <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> name.
                  minLength: 1
                  maxLength: 500
                customer_account_id:
                  type: string
                  description: Unique customer identifier defined by the merchant.
                  maxLength: 100
                  example: 93a1c659-288d-4d62-929d-10e241078faa
                payment_method:
                  enum:
                    - card
                    - network-token
                    - token
                    - apple-pay
                    - google-pay
        transaction:
          $ref: '#/components/schemas/SchemaCardsTransaction'
        transactions:
          type: object
          description: Map of transactions where the keys are transaction identifiers.
          properties:
            <transaction_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsTransaction'
          required:
            - <transaction_id_value_#1>
        three_ds:
          $ref: '#/components/schemas/SchemaCardsThreeDs'
        routing:
          $ref: '#/components/schemas/SchemaCardsRouting'
        antifraud_result:
          $ref: '#/components/schemas/SchemaCardsAntifraudResult'
        verification_result:
          $ref: '#/components/schemas/SchemaCardsVerificationResult'
        chargebacks:
          type: object
          description: Map of chargebacks where the keys are chargeback identifiers.
          properties:
            <chargeback_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsChargeback'
        device_info:
          $ref: '#/components/schemas/SchemaCardsDeviceInfo'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        pay_form:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPayForm'
        payment_adviser:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPaymentAdviser'
      required:
        - order
        - transactions
    RequestCardsStatus:
      title: RequestOrderId
      type: object
      properties:
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
          example: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
      required:
        - order_id
    SchemaCardsErrorDoNotHonor:
      title: SchemaMainErrorDoNotHonor
      type: object
      properties:
        code:
          type: string
          description: |-
            <a href="https://docs.solidgate.com/payments/payments-insights/error-codes" target="_blank">Code</a> indicating the reason for the payment decline, specifically related to validation errors.

            <blockquote>
              <p>These errors often indicate that the card has been declined for an unknown reason.</p>
            </blockquote>
          enum:
            - '3.08'
          example: '3.08'
        messages:
          type: array
          description: Array containing messages that specify why the payment was declined due to validation errors.
          items:
            type: string
            example: Do not honor
        recommended_message_for_user:
          type: string
          description: |-
            Recommended message to be displayed to the user for further action or information.

            <blockquote>
              <p>Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction.</p>
            </blockquote>
      required:
        - code
        - messages
    SchemaCardsDiscriminatorErrorSuccess:
      description: Error object.
      properties:
        code:
          type: string
          description: Gateway <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">error code</a> for the declined payment.
      discriminator:
        propertyName: code
        mapping:
          3.08 Do not honor: '#/components/schemas/SchemaCardsErrorDoNotHonor'
          X.XX: '#/components/schemas/SchemaCardsError'
    ResponseCardsStatus:
      title: Success
      type: object
      properties:
        order:
          type: object
          description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
          required:
            - amount
            - currency
            - order_id
            - refunded_amount
            - status
          properties:
            order_id:
              type: string
              description: |-
                Unique order identifier, which can be used to find the payment.

                <blockquote>
                  <p>For the first payment, the identifier is defined by the merchant.</p>
                  <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                </blockquote>
              maxLength: 255
              example: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
            order_description:
              type: string
              description: Brief order description.
              maxLength: 255
              example: Premium package
            psp_order_id:
              type: string
              description: PSP identifier generated by Solidgate.
            provider_payment_id:
              type: string
              description: |-
                PSP identifier generated by the PSP.

                <blockquote>
                  <p>Value will be if the integration transmitted this data.</p>
                </blockquote>
            product_id:
              type: string
              format: uuid
              maxLength: 36
              minLength: 36
              description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
            product_name:
              type: string
              description: <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> name.
              minLength: 1
              maxLength: 500
            subscription_id:
              type: string
              description: Unique subscription identifier.
              format: uuid
              maxLength: 36
              minLength: 36
              example: 83b19018-cbc4-4df0-899a-dda84fd2705e
            amount:
              type: integer
              description: |-
                Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

                  <blockquote>
                    <p>This is the intended initial authorization amount.</p>
                    <p>For instance, 1020 means 10 EUR and 20 cents.</p>
                  </blockquote>
                example: 100
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
              minLength: 3
              maxLength: 3
              example: USD
            processing_amount:
              type: integer
              description: |-
                Amount of the payment in the smallest currency unit as it was processed by the payment service provider.

                <blockquote>
                  <p>This amount may differ from the original order amount due to currency conversion or other processing factors.</p>
                </blockquote>
            processing_currency:
              type: string
              minLength: 3
              maxLength: 3
              description: |-
                Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the payment when it was processed by payment service provider.

                <blockquote>
                  <p>In some cases, it is different from the original currency.</p>
                </blockquote>
              example: USD
            marketing_amount:
              type: integer
              description: |-
                Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date.

                <blockquote>
                  <p>This is based on the intended initial authorization amount.</p>
                  <p>It should not be considered financial information, but it can be used for forecasting.</p>
                </blockquote>
            marketing_currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the currency used for calculation of marketing amount.
              example: USD
            refunded_amount:
              description: Indicates the amount that has been already refunded.
              type: integer
            authorized_amount:
              type: integer
              description: Total authorized amount of the order.
            status:
              type: string
              description: |-
                <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.

                <blockquote>
                  <p>In the case of <code>auth_failed</code>, an <code>error</code> object will be returned at the order level in the response.</p>
                </blockquote>
              enum:
                - processing
                - 3ds_verify
                - refunded
                - auth_ok
                - auth_failed
                - settle_ok
                - partial_settled
                - void_ok
              example: processing
            auth_code:
              type: string
              description: |-
                Transaction authorization code.

                <blockquote>
                  <p>It can be empty if the provider does not pass a value.</p>
                </blockquote>
              example: 2w9m8
            payment_type:
              type: string
              description: Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided.
              enum:
                - 1-click
                - recurring
                - retry
                - installment
                - rebill
                - moto
            payment_method:
              type: string
              description: Payment method used for the transaction.
              enum:
                - card
                - network-token
                - token
                - apple-pay
                - google-pay
            customer_account_id:
              type: string
              description: Unique customer identifier defined by the merchant.
              maxLength: 100
              example: 93a1c659-288d-4d62-929d-10e241078faa
            customer_email:
              type: string
              description: Customer's email address.
              maxLength: 100
              example: example@example.com
            descriptor:
              type: string
              description: |-
                Identifying text that appears on a customer’s credit or debit card statement.

                <blockquote>
                  <p>It includes information about the transaction and helps the cardholder recognize the charge.</p>
                </blockquote>
              example: google.com
            mid:
              type: string
              description: Merchant identifier in Solidgate.
              example: bank-mid-1
            ip_address:
              type: string
              description: |-
                Public IP address of the cardholder, both IPv4 and IPv6 are supported.

                <blockquote>                
                  <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
                </blockquote>
              maxLength: 50
            traffic_source:
              type: string
              description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
              maxLength: 255
              example: facebook
            fraudulent:
              type: boolean
              description: Whether the merchant system has flagged this customer as suspicious.
              deprecated: true
              default: false
        error:
          description: |-
            <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">Error</a> object.

            <blockquote>
              <p>Returned only in cases of <code>auth_failed</code> status at the order, and <code>fail</code> status at transaction.</p>
            </blockquote>
          allOf:
            - $ref: '#/components/schemas/SchemaCardsDiscriminatorErrorSuccess'
        transaction:
          type: object
          description: Details of a card transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.
          required:
            - amount
            - card
            - created_at
            - currency
            - id
            - operation
            - status
            - updated_at
          properties:
            id:
              type: string
              description: Unique transaction identifier.
              example: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
              maxLength: 100
            created_at:
              type: string
              description: Datetime when the transaction was created.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-12-27 11:45:30'
            updated_at:
              type: string
              description: Datetime when the transaction was updated.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-12-28 11:45:30'
            amount:
              type: integer
              description: Transaction amount.
              example: 100
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the transaction.
              maxLength: 3
              minLength: 3
              example: USD
            marketing_amount:
              type: integer
              description: |-
                Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date.

                <blockquote>
                  <p>It should not be considered financial information, but it can be used for forecasting.</p>
                </blockquote>
            marketing_currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the currency used for calculation of marketing amount.
              minLength: 3
              maxLength: 3
              example: USD
            operation:
              type: string
              description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
              enum:
                - recurring-auth
                - refund
                - resign-auth
                - auth
                - settle
                - void
                - apple-pay
                - google-pay
              example: auth
            status:
              type: string
              description: |-
                <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.

                <blockquote>
                  <p>In the case of <code>fail</code>, an <code>error</code> object will be returned at the transaction level in the response.</p>
                </blockquote>
              enum:
                - processing
                - success
                - fail
                - verify
              example: success
            authorization_type:
              type: string
              enum:
                - final
                - estimated
                - incremental
              description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
            scheme_transaction_id:
              type: string
              description: Card-scheme transaction identifier linking this transaction to the original customer-initiated payment.
            transaction_link_id:
              type: string
              description: Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.
              maxLength: 255
            descriptor:
              type: string
              description: |-
                Identifying text that appears on a customer’s credit or debit card statement.

                <blockquote>
                  <p>It includes information about the transaction and helps the cardholder recognize the charge.</p>
                </blockquote>
              example: google.com
            billing_details:
              $ref: '#/components/schemas/SchemaCardsBillingDetails'
            refund_reason:
              type: string
              description: Text description of the refund reason.
              example: Solidgate - Issuer Fraud Notification
            refund_reason_code:
              type: string
              description: |-
                Code representing the <a href="https://docs.solidgate.com/payments/payments-insights/refund-reasons/" target="_blank">reason</a> for the refund.

                <blockquote>
                  <p>This code is used to identify the reason for both <code>void</code> and <code>refund</code> transactions <code>operation</code></p>
                </blockquote>
              minLength: 4
              maxLength: 4
              example: '0022'
            card_token:
              allOf:
                - $ref: '#/components/schemas/SchemaCardsCardToken'
                - type: object
                  properties:
                    original_payment_method:
                      type: string
                      description: Payment method used to capture the card credentials at <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> creation.
                      enum:
                        - card
                        - apple-pay
                        - google-pay
                        - network-token
                        - click-to-pay
                      example: card
            card:
              allOf:
                - $ref: '#/components/schemas/SchemaCardsCard'
                - type: object
                  properties:
                    card_token:
                      allOf:
                        - $ref: '#/components/schemas/SchemaCardsCardToken'
                        - type: object
                          properties:
                            original_payment_method:
                              type: string
                              description: Payment method used to capture the card credentials at <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> creation.
                              enum:
                                - card
                                - apple-pay
                                - google-pay
                                - network-token
                                - click-to-pay
                              example: card
            error:
              $ref: '#/components/schemas/SchemaCardsDiscriminatorErrorSuccess'
            payment_account_reference:
              type: string
              description: Payment Account Reference (PAR) is a unique, non-financial identifier for a payment account that remains consistent across card replacements.
              example: PAR_1A2B3C4D5E6F7G8H9
            arn_code:
              type: string
              description: |-
                Acquirer Reference Number (ARN) assigned to transactions.

                <blockquote>
                  <p>Use ARN to check transaction <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">status</a>.</p>
                </blockquote>
              example: '12345678901234567890123'
            rrn_code:
              type: string
              description: Retrieval Reference Number (RRN) assigned to transactions, based on the <a href="https://en.wikipedia.org/wiki/ISO_8583" target="_blank">ISO 8583</a> standard.
              minLength: 12
              maxLength: 12
              example: '100034876543'
        transactions:
          type: object
          description: Map of transactions where the keys are transaction identifiers.
          properties:
            <transaction_id_value_#1>:
              type: object
              description: Details of a card transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.
              required:
                - amount
                - card
                - created_at
                - currency
                - id
                - operation
                - status
                - updated_at
              properties:
                id:
                  type: string
                  description: Unique transaction identifier.
                  example: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
                  maxLength: 100
                created_at:
                  type: string
                  description: Datetime when the transaction was created.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-12-27 11:45:30'
                updated_at:
                  type: string
                  description: Datetime when the transaction was updated.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-12-28 11:45:30'
                amount:
                  type: integer
                  description: Transaction amount.
                  example: 100
                currency:
                  type: string
                  description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the transaction.
                  maxLength: 3
                  minLength: 3
                  example: USD
                marketing_amount:
                  type: integer
                  description: |-
                    Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date.

                    <blockquote>
                      <p>It should not be considered financial information, but it can be used for forecasting.</p>
                    </blockquote>
                marketing_currency:
                  type: string
                  description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the currency used for calculation of marketing amount.
                  minLength: 3
                  maxLength: 3
                  example: USD
                operation:
                  type: string
                  description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                  enum:
                    - recurring-auth
                    - refund
                    - resign-auth
                    - auth
                    - settle
                    - void
                    - apple-pay
                    - google-pay
                  example: auth
                status:
                  type: string
                  description: |-
                    <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.

                    <blockquote>
                      <p>In the case of <code>fail</code>, an <code>error</code> object will be returned at the transactions level in the response.</p>
                    </blockquote>
                  enum:
                    - processing
                    - success
                    - fail
                    - verify
                  example: success
                authorization_type:
                  type: string
                  enum:
                    - final
                    - estimated
                    - incremental
                  description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
                scheme_transaction_id:
                  type: string
                  description: Card-scheme transaction identifier linking this transaction to the original customer-initiated payment.
                transaction_link_id:
                  type: string
                  description: Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.
                  maxLength: 255
                descriptor:
                  type: string
                  description: |-
                    Identifying text that appears on a customer’s credit or debit card statement.

                    <blockquote>
                      <p>It includes information about the transaction and helps the cardholder recognize the charge.</p>
                    </blockquote>
                  example: google.com
                billing_details:
                  $ref: '#/components/schemas/SchemaCardsBillingDetails'
                refund_reason:
                  type: string
                  description: Text description of the refund reason.
                  example: Solidgate - Issuer Fraud Notification
                refund_reason_code:
                  type: string
                  description: |-
                    Code representing the <a href="https://docs.solidgate.com/payments/payments-insights/refund-reasons/" target="_blank">reason</a> for the refund.

                    <blockquote>
                      <p>This code is used to identify the reason for both <code>void</code> and <code>refund</code> transactions <code>operation</code></p>
                    </blockquote>
                  minLength: 4
                  maxLength: 4
                  example: '0022'
                card_token:
                  allOf:
                    - $ref: '#/components/schemas/SchemaCardsCardToken'
                    - type: object
                      properties:
                        original_payment_method:
                          type: string
                          description: Payment method used to capture the card credentials at <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> creation.
                          enum:
                            - card
                            - apple-pay
                            - google-pay
                            - network-token
                            - click-to-pay
                          example: card
                card:
                  allOf:
                    - $ref: '#/components/schemas/SchemaCardsCard'
                    - type: object
                      properties:
                        card_token:
                          allOf:
                            - $ref: '#/components/schemas/SchemaCardsCardToken'
                            - type: object
                              properties:
                                original_payment_method:
                                  type: string
                                  description: Payment method used to capture the card credentials at <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> creation.
                                  enum:
                                    - card
                                    - apple-pay
                                    - google-pay
                                    - network-token
                                    - click-to-pay
                                  example: card
                error:
                  $ref: '#/components/schemas/SchemaCardsDiscriminatorErrorSuccess'
                payment_account_reference:
                  type: string
                  description: Payment Account Reference (PAR) is a unique, non-financial identifier for a payment account that remains consistent across card replacements.
                  example: PAR_1A2B3C4D5E6F7G8H9
                arn_code:
                  type: string
                  description: |-
                    Acquirer Reference Number (ARN) assigned to transactions.

                    <blockquote>
                      <p>Use ARN to check transaction <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">status</a>.</p>
                    </blockquote>
                  example: '12345678901234567890123'
                rrn_code:
                  type: string
                  description: Retrieval Reference Number (RRN) assigned to transactions, based on the <a href="https://en.wikipedia.org/wiki/ISO_8583" target="_blank">ISO 8583</a> standard.
                  minLength: 12
                  maxLength: 12
                  example: '100034876543'
          required:
            - <transaction_id_value_#1>
        three_ds:
          $ref: '#/components/schemas/SchemaCardsThreeDs'
        routing:
          $ref: '#/components/schemas/SchemaCardsRouting'
        antifraud_result:
          $ref: '#/components/schemas/SchemaCardsAntifraudResult'
        verification_result:
          $ref: '#/components/schemas/SchemaCardsVerificationResult'
        chargebacks:
          type: object
          description: Map of chargebacks where the keys are chargeback identifiers.
          properties:
            <chargeback_id_value_#1>:
              $ref: '#/components/schemas/SchemaCardsChargeback'
        device_info:
          $ref: '#/components/schemas/SchemaCardsDeviceInfo'
        verify_url:
          type: string
          description: |-
            URL where the customer should be redirected to complete 3DS authentication.

            <blockquote>
              <p>Only after opening the URL and authenticating the order <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">status</a> change to <code>3ds_verify</code>.</p>
            </blockquote>
        redirect_url:
          type: string
          description: URL where customer should be redirected after finishing 3D Secure or redirect payment method.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        pay_form:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPayForm'
        payment_adviser:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPaymentAdviser'
      required:
        - order
        - transactions
    SchemaCardsDiscriminatorError:
      description: Error object.
      properties:
        code:
          type: string
          description: Gateway <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">error code</a> for the declined payment.
      discriminator:
        propertyName: code
        mapping:
          2.01 Order not found: '#/components/schemas/SchemaMainErrorOrderNotFound'
          X.XX: '#/components/schemas/SchemaCardsError'
    ResponseCardsError:
      title: Error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/SchemaCardsDiscriminatorError'
      required:
        - error
    RequestCardsArn:
      title: RequestCardsArn
      type: object
      properties:
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
          example: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
      required:
        - order_id
    SchemaCardsArnCode:
      title: CardArnCodeModel
      type: object
      properties:
        arn_code:
          type: string
          description: |-
            Acquirer Reference Number (ARN) assigned to transactions.

            <blockquote>
              <p>Use ARN to check transaction <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">status</a>.</p>
            </blockquote>
          example: '12345678901234567890123'
        created_at:
          type: string
          description: Datetime when the refund was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-27 11:45:30'
        amount_refunded:
          type: integer
          description: Refund amount.
          example: 100
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          example: USD
        transaction_status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - processing
            - success
            - fail
            - verify
          example: success
        sp_transaction_id:
          type: string
          description: Unique transaction identifier.
          deprecated: true
          maxLength: 100
          example: 9ec44dfd75936f248a5d68dd7045bbbd63ab10ad9246f
      required:
        - amount_refunded
        - arn_code
        - created_at
        - currency
        - transaction_status
    ResponseCardsArn:
      title: Success
      properties:
        arn_codes:
          type: array
          description: Array data with information about ARN codes corresponding to the order requested.
          items:
            $ref: '#/components/schemas/SchemaCardsArnCode'
    SchemaApmCardShippingAddress:
      title: SchemaApmCardShippingAddress
      type: object
      description: |-
        Address to ship.

        <blockquote>
          <p>If this field is passed by the merchant - the customer cannot change this address.</p>
        </blockquote>
      properties:
        country:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the shipping address.
          format: iso_code_a3
          minLength: 3
          maxLength: 3
        state:
          type: string
          description: Code of the state where the person, business or institution is located.
          maxLength: 100
        city:
          type: string
          description: City or town where the person, business or institution is located.
          maxLength: 100
        zip:
          type: string
          description: Address zip/postal code where the person, business or institution is located.
          maxLength: 10
        line1:
          type: string
          description: First line of the address.
          maxLength: 200
        line2:
          type: string
          description: Second line of the address.
          maxLength: 200
    RequestApmInitPaymentPaypal:
      title: RequestApmInitPaymentPaypal
      type: object
      required:
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal" target="_blank">method</a> name.
          enum:
            - paypal-vault
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For COP, CRC, HUF, LAK, RSD, and TWD, should pass the integer value of the amount with two zeros at the end (for example, XXXX00, which will be transferred as XXXX.00). The value 0 is valid only for obtaining a <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/#billing-agreement" target="_blank">billing agreement token</a> (recurring-token).</p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>For the init-payment subscription and one-time payments, the field value is displayed on the user's PayPal statement.</p>
              <p>For recurring subscription payments, this field is configured in the product settings as Public description when <a href="https://docs.solidgate.com/billing/product-and-price-management/#edit-product " target="_blank">editing</a> a product via Hub.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #F2C4C4;">               
              <p><b>Required</b> for <code>UGA</code>, <code>KEN</code>, <code>TZA</code>, <code>GHA</code> locations.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        shipping_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentAlipay:
      title: RequestApmInitPaymentAlipay
      type: object
      required:
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - billing_address
        - future_usage
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay" target="_blank">method</a> name.
          enum:
            - alipay
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For CNY currency, the amount should be in cents (e.g., 8900 = 89.00 CNY).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          default: CNY
        future_usage:
          type: object
          description: |-
            Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.

            <blockquote>
              <p>Use <code>one-time</code> for single payments or <code>unscheduled</code> for recurring payments.</p>
            </blockquote>
          required:
            - payment_type
          properties:
            payment_type:
              type: string
              description: Type of payment for future usage.
              enum:
                - one-time
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>The field value is displayed in the customer's Alipay transaction history.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Client platform used to select the appropriate customer confirmation path during checkout.

            <blockquote>                
              <p>APP opens authorization in an app context, MOB continues in mobile web, WEB runs a desktop browser flow.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    SchemaApmFutureUsageBlikDirect:
      title: direct
      type: object
      description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials for the <code>direct</code> flow.
      required:
        - payment_type
      properties:
        payment_type:
          type: string
          description: |-
            Type of payment for future usage.

            <blockquote><p>Use <code>unscheduled</code> with <code>direct</code> for <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik/blik-recurring/" target="_blank">Blik Recurring</a>.</p></blockquote>
          enum:
            - one-time
            - unscheduled
    SchemaApmFutureUsageBlikRedirect:
      title: redirect
      type: object
      description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials for the <code>redirect</code> flow.
      required:
        - payment_type
      properties:
        payment_type:
          type: string
          description: Type of payment for future usage.
          enum:
            - one-time
    SchemaApmCardBillingAddress:
      title: SchemaApmCardBillingAddress
      type: object
      description: Billing address details.
      properties:
        country:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
          format: iso_code_a3
          minLength: 3
          maxLength: 3
        state:
          type: string
          description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
          maxLength: 100
        city:
          type: string
          description: City name.
          maxLength: 100
        zip:
          type: string
          description: Address zip/postal code.
          maxLength: 10
        line1:
          type: string
          description: First line of the address.
          maxLength: 200
        line2:
          type: string
          description: Second line of the address.
          maxLength: 200
    SchemaApmPaymentTypeDataBlikCode:
      title: direct
      type: object
      properties:
        blik_code:
          type: string
          description: BLIK code, obtained from the Blik app, for transaction processing.
          minLength: 6
          maxLength: 6
          pattern: ^\d{6}$
      required:
        - blik_code
    RequestApmInitPaymentBlik:
      title: RequestApmInitPaymentBlik
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - billing_address
        - future_usage
        - payment_method_flow
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik" target="_blank">method</a> name.
          enum:
            - blik
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - PLN
        payment_method_flow:
          type: string
          description: Interaction <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/" target="_blank">process</a> according to this method.
          enum:
            - direct
            - redirect
        future_usage:
          type: object
          description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.
          oneOf:
            - $ref: '#/components/schemas/SchemaApmFutureUsageBlikDirect'
            - $ref: '#/components/schemas/SchemaApmFutureUsageBlikRedirect'
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #F2C4C4;">               
              <p><b>Required</b> for <code>UGA</code>, <code>KEN</code>, <code>TZA</code>, <code>GHA</code> locations.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: User-agent string of the device used by the customer.
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          oneOf:
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataBlikCode'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentBizum:
      title: RequestApmInitPaymentBizum
      type: object
      required:
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - customer_phone
        - ip_address
        - platform
        - payment_method
        - billing_address
        - future_usage
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/bizum" target="_blank">method</a> name.
          enum:
            - bizum
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For EUR currency, the amount should be in cents (e.g., 400 = 4.00 EUR).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          enum:
            - EUR
        future_usage:
          type: object
          description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.
          required:
            - payment_type
          properties:
            payment_type:
              type: string
              description: Type of payment for future usage.
              enum:
                - one-time
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>The field value is displayed in the customer's Bizum transaction history.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          minLength: 5
          maxLength: 15
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentBoleto:
      title: RequestApmInitPaymentBoleto
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto" target="_blank">method</a> name.
          enum:
            - boleto
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        payment_method_flow:
          type: string
          description: |-
            Interaction <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/" target="_blank">process</a> according to this method. 

            <blockquote>                
              <p>If the field is not specified, the process available in the method is used.</p>
            </blockquote>
          enum:
            - redirect
            - direct
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #F2C4C4;">                  
              <p><b>Required</b> for <code>UGA</code>, <code>KEN</code>, <code>TZA</code>, <code>GHA</code> locations.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            brazil_cpf:
              type: string
              description: Individual taxpayer registry identification number should be collected and provided for Brazilian customers.
              maxLength: 11
          required:
            - brazil_cpf
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentEfecty:
      title: RequestApmInitPaymentEfecty
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/efecty" target="_blank">method</a> name.
          enum:
            - efecty
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - COP
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: Public IP address of the cardholder.
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            colombia_cc:
              type: string
              description: Colombian citizen identifier number.
              maxLength: 10
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentGcash:
      title: RequestApmInitPaymentGcash
      type: object
      required:
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - billing_address
        - return_url
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash" target="_blank">method</a> name.
          enum:
            - gcash
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For PHP currency, the amount should be in cents (e.g., 2575 = 25.75 PHP).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          enum:
            - PHP
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>The field value is displayed in the customer's GCash transaction history.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentIdeal:
      title: RequestApmInitPaymentIdeal
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/ideal" target="_blank">method</a> name.
          enum:
            - ideal
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>
              <p>To prevent errors, most iDEAL systems reject descriptions containing characters that could cause issues, such as HTML editing codes, which might lead to problems.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 35
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 19
          pattern: ^\d{4}-\d{2}-\d{2}( \d{2}:\d{2}:\d{2})?$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #F2C4C4;">                  
              <p><b>Required</b> for <code>UGA</code>, <code>KEN</code>, <code>TZA</code>, <code>GHA</code> locations.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentMbway:
      title: RequestApmInitPaymentMbway
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - customer_phone
        - ip_address
        - platform
        - payment_method
        - billing_address
        - future_usage
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/mb-way" target="_blank">method</a> name.
          enum:
            - mbway
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
        future_usage:
          type: object
          description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.
          required:
            - payment_type
          properties:
            payment_type:
              type: string
              description: |-
                Type of payment for future usage.

                - `one-time` - no token created, for one-off use
                - `1-click` - token for future CIT without re-entering details
              enum:
                - one-time
                - 1-click
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        shipping_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>               
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    SchemaApmPaymentTypeDataMercadopagoArg:
      title: Argentina
      properties:
        argentina_dni:
          type: string
          description: National identity document code should be collected and provided for Argentinian cardholders.
          maxLength: 9
      required:
        - argentina_dni
    SchemaApmPaymentTypeDataMercadopagoBra:
      title: Brazil
      properties:
        brazil_cpf:
          type: string
          description: Individual taxpayer registry identification number should be collected and provided for Brazilian customers.
          maxLength: 11
      required:
        - brazil_cpf
    SchemaApmPaymentTypeDataMercadopagoChl:
      title: Chile
      properties:
        chile_ci:
          type: string
          description: Chilean citizen identifier number.
          maxLength: 9
      required:
        - chile_ci
    SchemaApmPaymentTypeDataMercadopagoCol:
      title: Colombia
      properties:
        colombia_cc:
          type: string
          description: Colombian citizen identifier number.
          maxLength: 10
      required:
        - colombia_cc
    SchemaApmPaymentTypeDataMercadopagoMex:
      title: Mexico
      properties:
        mexico_curp:
          type: string
          description: Unique Population Registry Code.
          minLength: 18
          maxLength: 18
      required:
        - mexico_curp
    SchemaApmPaymentTypeDataMercadopagoPer:
      title: Peru
      properties:
        peru_dni:
          type: string
          description: National identity document code for Peruvian cardholders.
          maxLength: 9
      required:
        - peru_dni
    SchemaApmPaymentTypeDataMercadopagoUry:
      title: Uruguay
      properties:
        uruguay_ci:
          type: string
          description: Cédula de Identidad (National Identity Card) for Uruguay.
          maxLength: 8
      required:
        - uruguay_ci
    RequestApmInitPaymentMercadopago:
      title: RequestApmInitPaymentMercadopago
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/mercado-pago" target="_blank">method</a> name.
          enum:
            - mercadopago
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil or VAT/PAIS in Argentina.</p>
            </blockquote>
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - ARS
            - BRL
            - CLP
            - COP
            - MXN
            - PEN
            - UYU
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        shipping_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>  
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: |-
            Additional data required to make payments with the specific payment methods. Specify the value that belongs to the user country.

            <blockquote>
              <p>ARG - <code>argentina_dni</code>, BRA - <code>brazil_cpf</code>, CHL - <code>chile_ci</code>, COL - <code>colombia_cc</code>, MEX - <code>mexico_curp</code>, PER - <code>peru_dni</code>, URY - <code>uruguay_ci</code>.</p>
            </blockquote>
          oneOf:
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoArg'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoBra'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoChl'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoCol'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoMex'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoPer'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoUry'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentMultibanco:
      title: RequestApmInitPaymentMultibanco
      type: object
      required:
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - billing_address
        - future_usage
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco" target="_blank">method</a> name.
          enum:
            - multibanco
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>
              <p>For EUR currency, the amount should be in cents (e.g., 2490 = 24.90 EUR).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          enum:
            - EUR
        future_usage:
          type: object
          description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.
          required:
            - payment_type
          properties:
            payment_type:
              type: string
              description: Type of payment for future usage.
              enum:
                - one-time
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          minLength: 5
          maxLength: 15
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmInitPaymentOpenbanking:
      title: RequestApmInitPaymentOpenbanking
      type: object
      required:
        - amount
        - currency
        - order_id
        - order_description
        - item_category
        - customer_email
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pay-by-bank/" target="_blank">method</a> name.
          enum:
            - openbanking
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
            - GBP
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: Type of goods.
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>   
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentOxxo:
      title: RequestApmInitPaymentOxxo
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/oxxo" target="_blank">method</a> name.
          enum:
            - oxxo
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - MXN
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            mexico_curp:
              type: string
              description: Unique Population Registry Code.
              minLength: 18
              maxLength: 18
          required:
            - mexico_curp
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmInitPaymentPix:
      title: RequestApmInitPaymentSmartPix
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
      properties:
        payment_method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> name.

            <blockquote style="border-left: 4px solid #F2C4C4;">                
              <p>Pix payments via redirect to the customer’s bank page.</p>
            </blockquote>
          enum:
            - pix
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Identifies the category of the item.

            - `physical_goods` - tangible item that can be shipped with proof of delivery
            - `digital_goods` - goods that are stored, delivered, and used in electronic format
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              enum:
                - BRA
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by customer at the moment of payment.           

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            brazil_cpf:
              type: string
              description: Individual taxpayer registry identification number should be collected and provided for Brazilian customers.
              maxLength: 11
          required:
            - brazil_cpf
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentPixQr:
      title: RequestApmInitPaymentPixQr
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
      properties:
        payment_method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix" target="_blank">method</a> name.

            <blockquote style="border-left: 4px solid #F2C4C4;">                
              <p>Pix payments via redirect to a page with QR.</p>
            </blockquote>
          enum:
            - pix-qr
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Identifies the category of the item.

            - `physical_goods` - tangible item that can be shipped with proof of delivery
            - `digital_goods` - goods that are stored, delivered, and used in electronic format
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              enum:
                - BRA
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform, which the customer used at the moment of payment.           

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data that is required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            brazil_cpf:
              type: string
              description: Individual taxpayer registry identification number should be collected and provided for Brazilian customers.
              maxLength: 11
          required:
            - brazil_cpf
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    SchemaApmFutureUsageBillingPeriodPixAutomatico:
      title: Pix Automático billing period
      type: object
      description: |-
        Recurring billing interval for the mandate.

        <blockquote>
          <p>Only the following <code>unit</code> and <code>value</code> pairs are accepted.</p>
        </blockquote>
      oneOf:
        - title: Weekly (7 days)
          type: object
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Billing interval unit.
              enum:
                - day
            value:
              type: integer
              description: Must be <code>7</code> with <code>day</code> for a weekly interval.
              enum:
                - 7
          additionalProperties: false
        - title: Weekly (1 week)
          type: object
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Billing interval unit.
              enum:
                - week
            value:
              type: integer
              description: Must be <code>1</code> with <code>week</code> for a weekly interval.
              enum:
                - 1
          additionalProperties: false
        - title: Monthly
          type: object
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Billing interval unit.
              enum:
                - month
            value:
              type: integer
              description: Must be <code>1</code> with <code>month</code> for a monthly interval.
              enum:
                - 1
          additionalProperties: false
        - title: Quarterly
          type: object
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Billing interval unit.
              enum:
                - month
            value:
              type: integer
              description: Must be <code>3</code> with <code>month</code> for a quarterly interval.
              enum:
                - 3
          additionalProperties: false
        - title: Semi-annually
          type: object
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Billing interval unit.
              enum:
                - month
            value:
              type: integer
              description: Must be <code>6</code> with <code>month</code> for a semi-annual interval.
              enum:
                - 6
          additionalProperties: false
        - title: Annually (12 months)
          type: object
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Billing interval unit.
              enum:
                - month
            value:
              type: integer
              description: Must be <code>12</code> with <code>month</code> for an annual interval.
              enum:
                - 12
          additionalProperties: false
        - title: Annually (1 year)
          type: object
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Billing interval unit.
              enum:
                - year
            value:
              type: integer
              description: Must be <code>1</code> with <code>year</code> for an annual interval.
              enum:
                - 1
          additionalProperties: false
    SchemaApmFutureUsagePixAutomatico:
      title: Future usage for Pix Automático
      type: object
      description: Defines recurring <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">mandate</a> parameters.
      required:
        - payment_type
        - billing_period
        - max_amount
      properties:
        payment_type:
          type: string
          description: Pix Automático mandate authorization.
          enum:
            - recurring
        billing_period:
          $ref: '#/components/schemas/SchemaApmFutureUsageBillingPeriodPixAutomatico'
        max_amount:
          type: integer
          description: Maximum authorized charge amount per billing cycle in the smallest currency unit for BRL.
          exclusiveMinimum: true
          minimum: 0
    RequestApmInitPaymentPixAutomatico:
      title: RequestApmInitPaymentPixAutomatico
      type: object
      description: |-
        Initial charge for <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">Pix Automático</a> when the billing plan is not taken from a Solidgate product.

        <blockquote>
          <p>Use <code>future_usage</code> to define the mandate interval and authorization ceiling. For catalog based flows, use the product based init payment schema instead.</p>
        </blockquote>
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
        - future_usage
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> name.
          enum:
            - pix-automatico
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        future_usage:
          $ref: '#/components/schemas/SchemaApmFutureUsagePixAutomatico'
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Identifies the category of the item.

            - `physical_goods` - tangible item that can be shipped with proof of delivery
            - `digital_goods` - goods that are stored, delivered, and used in electronic format
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              enum:
                - BRA
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by customer at the moment of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            brazil_cpf:
              type: string
              description: Individual taxpayer registry identification number should be collected and provided for Brazilian customers.
              maxLength: 11
          required:
            - brazil_cpf
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentPrzelewy24:
      title: RequestApmInitPaymentPrzelewy24
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/przelewy24" target="_blank">method</a> name.
          enum:
            - przelewy24
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - PLN
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #F2C4C4;">                  
              <p><b>Required</b> for <code>UGA</code>, <code>KEN</code>, <code>TZA</code>, <code>GHA</code> locations.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentPse:
      title: RequestApmInitPaymentPSE
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pse" target="_blank">method</a> name.
          enum:
            - pse
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - COP
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: Public IP address of the cardholder.
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            colombia_cc:
              type: string
              description: Colombian citizen identifier number.
              maxLength: 10
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentSencillito:
      title: RequestApmInitPaymentSencillito
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/sencillito" target="_blank">method</a> name.
          enum:
            - sencillito
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - CLP
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: Public IP address of the cardholder.
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            chile_ci:
              type: string
              description: Chilean citizen identifier number.
              maxLength: 9
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentServipag:
      title: RequestApmInitPaymentServipag
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/servipag" target="_blank">method</a> name.
          enum:
            - servipag
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - CLP
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: Public IP address of the cardholder.
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            chile_ci:
              type: string
              description: Chilean citizen identifier number.
              maxLength: 9
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentUpi:
      title: RequestApmInitPaymentUpi
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - customer_first_name
        - customer_last_name
        - customer_phone
        - ip_address
        - platform
        - user_agent
        - payment_method
        - billing_address
        - payment_type_data
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi" target="_blank">method</a> name.
          enum:
            - upi
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - INR
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              format: iso_code_a3
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: |-
                Address zip/postal code.

                <blockquote>                
                  <p>For addresses in India, the zip code must exactly be 6 characters long.</p>
                </blockquote>
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
            - zip
        shipping_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote> 
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            india_vpa:
              type: string
              description: |-
                The Virtual Payment Address (VPA) used for UPI (Unified Payments Interface) transactions in India. VPA allows users to send and receive money electronically without requiring bank account details.

                <blockquote>
                  <p>For more information on how VPA works, refer to the <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi" target="_blank">UPI payment method details</a>.</p>
                </blockquote>
              minLength: 1
              maxLength: 130
              pattern: ^.{1,100}@.{1,30}$
          required:
            - india_vpa
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmInitPaymentWebpay:
      title: RequestApmInitPaymentWebpay
      type: object
      required:
        - order_id
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/webpay" target="_blank">method</a> name.
          enum:
            - servipag
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - CLP
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 19
          pattern: ^\d{4}-\d{2}-\d{2}( \d{2}:\d{2}:\d{2})?$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: Public IP address of the cardholder.
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            chile_ci:
              type: string
              description: Chilean citizen identifier number.
              maxLength: 9
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentWechatpay:
      title: RequestApmInitPaymentWechatpay
      type: object
      required:
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - billing_address
        - future_usage
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay" target="_blank">method</a> name.
          enum:
            - wechatpay
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For CNY currency, the amount should be in cents (e.g., 8900 = 89.00 CNY).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          default: CNY
        future_usage:
          type: object
          description: |-
            Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.

            <blockquote>
              <p>Use <code>one-time</code> for single payments or <code>unscheduled</code> for recurring payments.</p>
            </blockquote>
          required:
            - payment_type
          properties:
            payment_type:
              type: string
              description: Type of payment for future usage.
              enum:
                - one-time
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>The field value is displayed in the customer's WeChat Pay transaction history.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Client platform used to determine how the payer authorization journey is started.

            <blockquote>                
              <p>APP starts authorization in an app context, MOB follows a mobile browser path, WEB uses a desktop browser path.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitPaymentDiscriminator:
      title: Payment
      type: object
      discriminator:
        propertyName: payment_method
        mapping:
          paypal-vault: '#/components/schemas/RequestApmInitPaymentPaypal'
          alipay: '#/components/schemas/RequestApmInitPaymentAlipay'
          blik: '#/components/schemas/RequestApmInitPaymentBlik'
          bizum: '#/components/schemas/RequestApmInitPaymentBizum'
          boleto: '#/components/schemas/RequestApmInitPaymentBoleto'
          efecty: '#/components/schemas/RequestApmInitPaymentEfecty'
          gcash: '#/components/schemas/RequestApmInitPaymentGcash'
          ideal: '#/components/schemas/RequestApmInitPaymentIdeal'
          mbway: '#/components/schemas/RequestApmInitPaymentMbway'
          mercadopago: '#/components/schemas/RequestApmInitPaymentMercadopago'
          multibanco: '#/components/schemas/RequestApmInitPaymentMultibanco'
          openbanking: '#/components/schemas/RequestApmInitPaymentOpenbanking'
          oxxo: '#/components/schemas/RequestApmInitPaymentOxxo'
          pix: '#/components/schemas/RequestApmInitPaymentPix'
          pix-qr: '#/components/schemas/RequestApmInitPaymentPixQr'
          pix-automatico: '#/components/schemas/RequestApmInitPaymentPixAutomatico'
          przelewy24: '#/components/schemas/RequestApmInitPaymentPrzelewy24'
          pse: '#/components/schemas/RequestApmInitPaymentPse'
          sencillito: '#/components/schemas/RequestApmInitPaymentSencillito'
          servipag: '#/components/schemas/RequestApmInitPaymentServipag'
          upi: '#/components/schemas/RequestApmInitPaymentUpi'
          webpay: '#/components/schemas/RequestApmInitPaymentWebpay'
          wechatpay: '#/components/schemas/RequestApmInitPaymentWechatpay'
    RequestApmInitOneTimeProductPaypal:
      title: RequestApmInitOneTimeProductPaypal
      type: object
      required:
        - order_id
        - customer_email
        - ip_address
        - platform
        - payment_method
        - product_id
        - customer_account_id
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal" target="_blank">method</a> name.
          enum:
            - paypal-vault
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: |-
            Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.

            <blockquote>                
              <p>Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR.</p>
            </blockquote>
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>For the init-payment subscription and one-time payments, the field value is displayed on the user's PayPal statement.</p>
              <p>For recurring subscription payments, this field is configured in the product settings as Public description when <a href="https://docs.solidgate.com/billing/product-and-price-management/#edit-product " target="_blank">editing</a> a product via Hub.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #F2C4C4;">                
              <p><b>Required</b> for <code>UGA</code>, <code>KEN</code>, <code>TZA</code>, <code>GHA</code> locations.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security.</p>
            </blockquote>
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductAlipay:
      title: RequestApmInitOneTimeProductAlipay
      type: object
      required:
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - customer_phone
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay" target="_blank">method</a> name.
          enum:
            - alipay
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          default: CNY
        future_usage:
          type: object
          description: |-
            Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.

            <blockquote>
              <p>Use <code>one-time</code> for single payments or <code>unscheduled</code> for recurring payments.</p>
            </blockquote>
          properties:
            payment_type:
              type: string
              description: Type of payment for future usage.
              enum:
                - one-time
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>The field value is displayed in the customer's Alipay transaction history.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Client platform used to select the appropriate customer confirmation path during checkout.

            <blockquote>                
              <p>APP opens authorization in an app context, MOB continues in mobile web, WEB runs a desktop browser flow.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    SchemaApmFutureUsageBlikOneTimeProduct:
      title: Future usage for Blik one-time product payment
      type: object
      description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.
      required:
        - payment_type
      properties:
        payment_type:
          type: string
          description: Type of payment for future usage.
          enum:
            - one-time
    RequestApmInitOneTimeProductBlik:
      title: RequestApmInitOneTimeProductBlik
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - billing_address
        - ip_address
        - platform
        - payment_method_flow
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik" target="_blank">method</a> name.
          enum:
            - blik
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - PLN
        payment_method_flow:
          type: string
          description: Interaction <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/" target="_blank">process</a> according to this method.
          enum:
            - direct
            - redirect
        future_usage:
          $ref: '#/components/schemas/SchemaApmFutureUsageBlikOneTimeProduct'
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #F2C4C4;">               
              <p><b>Required</b> for <code>UGA</code>, <code>KEN</code>, <code>TZA</code>, <code>GHA</code> locations.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: User-agent string of the device used by the customer.
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          oneOf:
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataBlikCode'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductBoleto:
      title: RequestApmInitOneTimeProductBoleto
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - billing_address
        - ip_address
        - platform
        - payment_type_data
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto" target="_blank">method</a> name.
          enum:
            - boleto
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        payment_method_flow:
          type: string
          description: |-
            Interaction <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/" target="_blank">process</a> according to this method. 

            <blockquote>                
              <p>If the field is not specified, the process available in the method is used.</p>
            </blockquote>
          enum:
            - redirect
            - direct
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #F2C4C4;">                  
              <p><b>Required</b> for <code>UGA</code>, <code>KEN</code>, <code>TZA</code>, <code>GHA</code> locations.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data that is required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            brazil_cpf:
              type: string
              description: Individual taxpayer registry identification number should be collected and provided for Brazilian customers.
              maxLength: 11
          required:
            - brazil_cpf
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductEfecty:
      title: RequestApmInitOneTimeProductEfecty
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - billing_address
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/efecty" target="_blank">method</a> name.
          enum:
            - efecty
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - COP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: Public IP address of the cardholder.
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            colombia_cc:
              type: string
              description: Colombian citizen identifier number.
              maxLength: 10
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductGcash:
      title: RequestApmInitOneTimeProductGcash
      type: object
      required:
        - currency
        - order_id
        - order_description
        - customer_email
        - customer_first_name
        - customer_last_name
        - product_id
        - customer_account_id
        - ip_address
        - platform
        - payment_method
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash" target="_blank">method</a> name.
          enum:
            - gcash
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          enum:
            - PHP
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>The field value is displayed in the customer's GCash transaction history.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductIdeal:
      title: RequestApmInitOneTimeProductIdeal
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - billing_address
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/ideal" target="_blank">method</a> name.
          enum:
            - ideal
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>
              <p>To prevent errors, most iDEAL systems reject descriptions containing characters that could cause issues, such as HTML editing codes, which might lead to problems.</p>
            </blockquote>
          maxLength: 35
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #F2C4C4;">                  
              <p><b>Required</b> for <code>UGA</code>, <code>KEN</code>, <code>TZA</code>, <code>GHA</code> locations.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductMbway:
      title: RequestApmInitOneTimeProductMbway
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - customer_phone
        - billing_address
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/mb-way" target="_blank">method</a> name.
          enum:
            - mbway
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
        future_usage:
          type: object
          description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.
          properties:
            payment_type:
              type: string
              description: |-
                Type of payment for future usage.

                - `one-time` - no token created, for one-off use
                - `1-click` - token for future CIT without re-entering details
              enum:
                - one-time
                - 1-click
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        shipping_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>               
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmInitOneTimeProductMultibanco:
      title: RequestApmInitOneTimeProductMultibanco
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - billing_address
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco" target="_blank">method</a> name.
          enum:
            - multibanco
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          enum:
            - EUR
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          minLength: 5
          maxLength: 15
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmInitOneTimeProductMercadopago:
      title: RequestApmInitOneTimeProductMercadopago
      type: object
      required:
        - order_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
        - product_id
        - customer_account_id
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/mercado-pago" target="_blank">method</a> name.
          enum:
            - mercadopago
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>                
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil or VAT/PAIS in Argentina.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: |-
            Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.

            <blockquote>                
              <p>Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR.</p>
            </blockquote>
          enum:
            - ARS
            - BRL
            - CLP
            - COP
            - MXN
            - PEN
            - UYU
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: |-
            Additional data required to make payments with the specific payment methods. Specify the value that belongs to the user country.

            <blockquote>
              <p>ARG - <code>argentina_dni</code>, BRA - <code>brazil_cpf</code>, CHL - <code>chile_ci</code>, COL - <code>colombia_cc</code>, MEX - <code>mexico_curp</code>, PER - <code>peru_dni</code>, URY - <code>uruguay_ci</code>.</p>
            </blockquote>
          oneOf:
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoArg'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoBra'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoChl'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoCol'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoMex'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoPer'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoUry'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductOpenbanking:
      title: RequestApmInitOneTimeProductOpenbanking
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - item_category
        - billing_address
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pay-by-bank/" target="_blank">method</a> name.
          enum:
            - openbanking
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
            - GBP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: Type of goods.
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>   
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductOxxo:
      title: RequestApmInitOneTimeProductOxxo
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - billing_address
        - ip_address
        - platform
        - payment_type_data
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/oxxo" target="_blank">method</a> name.
          enum:
            - oxxo
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - MXN
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data that is required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            mexico_curp:
              type: string
              description: Unique Population Registry Code.
              minLength: 18
              maxLength: 18
          required:
            - mexico_curp
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmInitOneTimeProductPix:
      title: RequestApmInitOneTimeProductSmartPix
      type: object
      required:
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
      properties:
        payment_method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> name.

            <blockquote style="border-left: 4px solid #F2C4C4;">                
              <p>Pix payments via redirect to the customer’s bank page.</p>
            </blockquote>
          enum:
            - pix
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier of the <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscription</a>.

            <blockquote>                
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Identifies the category of the item.

            - `physical_goods` - tangible item that can be shipped with proof of delivery
            - `digital_goods` - goods that are stored, delivered, and used in electronic format
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              enum:
                - BRA
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform, which the customer used at the moment of payment.           

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data that is required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            brazil_cpf:
              type: string
              description: Individual taxpayer registry identification number should be collected and provided for Brazilian customers.
              maxLength: 11
          required:
            - brazil_cpf
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductPixQr:
      title: RequestApmInitPaymentPixQr
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - billing_address
        - ip_address
        - platform
        - payment_type_data
      properties:
        payment_method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix" target="_blank">method</a> name.

            <blockquote style="border-left: 4px solid #F2C4C4;">                
              <p>Pix payments via redirect to a page with QR.</p>
            </blockquote>
          enum:
            - pix-qr
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Identifies the category of the item.

            - `physical_goods` - tangible item that can be shipped with proof of delivery
            - `digital_goods` - goods that are stored, delivered, and used in electronic format
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              enum:
                - BRA
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform, which the customer used at the moment of payment.           

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data that is required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            brazil_cpf:
              type: string
              description: Individual taxpayer registry identification number should be collected and provided for Brazilian customers.
              maxLength: 11
          required:
            - brazil_cpf
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    SchemaApmFutureUsagePixAutomaticoProductCeiling:
      title: Pix Automático future usage product ceiling
      type: object
      description: Pix Automático authorization ceiling settings for product-based and subscription payments.
      properties:
        max_amount:
          type: integer
          description: Maximum authorized charge amount per billing cycle in the smallest currency unit for BRL.
          exclusiveMinimum: true
          minimum: 0
    RequestApmInitOneTimeProductPixAutomatico:
      title: RequestApmInitOneTimeProductPixAutomatico
      type: object
      description: |-
        Pix Automático init payment using a Solidgate <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">subscription product</a>. Billing interval comes from the product.

        <blockquote>
          <p>Optional <code>future_usage.max_amount</code> sets a custom authorization ceiling. For product-based payment, sending <code>future_usage.billing_period</code> results in a validation error.</p>
        </blockquote>
      required:
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> name.
          enum:
            - pix-automatico
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier of the <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscription</a>.

            <blockquote>
              <p>The product billing period must be approved by the Central Bank of Brazil.</p>
              <p>If the product defines a trial, it must be at least 2 days.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        future_usage:
          $ref: '#/components/schemas/SchemaApmFutureUsagePixAutomaticoProductCeiling'
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Identifies the category of the item.

            - `physical_goods` - tangible item that can be shipped with proof of delivery
            - `digital_goods` - goods that are stored, delivered, and used in electronic format
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              enum:
                - BRA
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform, which the customer used at the moment of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data that is required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            brazil_cpf:
              type: string
              description: Individual taxpayer registry identification number should be collected and provided for Brazilian customers.
              maxLength: 11
          required:
            - brazil_cpf
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductPrzelewy24:
      title: RequestApmInitOneTimeProductPrzelewy24
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - billing_address
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/przelewy24" target="_blank">method</a> name.
          enum:
            - przelewy24
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - PLN
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #F2C4C4;">                  
              <p><b>Required</b> for <code>UGA</code>, <code>KEN</code>, <code>TZA</code>, <code>GHA</code> locations.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductPse:
      title: RequestApmInitPaymentPSE
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - billing_address
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pse" target="_blank">method</a> name.
          enum:
            - pse
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - COP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: Public IP address of the cardholder.
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            colombia_cc:
              type: string
              description: Colombian citizen identifier number.
              maxLength: 10
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductSencillito:
      title: RequestApmInitOneTimeProductSencillito
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - billing_address
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/sencillito" target="_blank">method</a> name.
          enum:
            - sencillito
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - CLP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: Public IP address of the cardholder.
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            chile_ci:
              type: string
              description: Chilean citizen identifier number.
              maxLength: 9
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductServipag:
      title: RequestApmInitOneTimeProductServipag
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - billing_address
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/servipag" target="_blank">method</a> name.
          enum:
            - servipag
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - CLP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: Public IP address of the cardholder.
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            chile_ci:
              type: string
              description: Chilean citizen identifier number.
              maxLength: 9
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductUpi:
      title: RequestApmInitOneTimeProductUpi
      type: object
      required:
        - product_id
        - order_id
        - customer_account_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - customer_phone
        - ip_address
        - user_agent
        - platform
        - payment_method
        - billing_address
        - payment_type_data
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi" target="_blank">method</a> name.
          enum:
            - upi
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - INR
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              format: iso_code_a3
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: |-
                Address zip/postal code.

                <blockquote>                
                  <p>For addresses in India, the zip code must exactly be 6 characters long.</p>
                </blockquote>
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
            - zip
        shipping_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            india_vpa:
              type: string
              description: |-
                The Virtual Payment Address (VPA) used for UPI (Unified Payments Interface) transactions in India. VPA allows users to send and receive money electronically without requiring bank account details.

                <blockquote>
                  <p>For more information on how VPA works, refer to the <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi" target="_blank">UPI payment method details</a>.</p>
                </blockquote>
              minLength: 1
              maxLength: 130
              pattern: ^.{1,100}@.{1,30}$
          required:
            - india_vpa
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductWebpay:
      title: RequestApmInitOneTimeProductWebpay
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - billing_address
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/webpay" target="_blank">method</a> name.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - CLP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: Public IP address of the cardholder.
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            chile_ci:
              type: string
              description: Chilean citizen identifier number.
              maxLength: 9
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductWechatpay:
      title: RequestApmInitOneTimeProductWechatpay
      type: object
      required:
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay" target="_blank">method</a> name.
          enum:
            - wechatpay
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          default: CNY
        future_usage:
          type: object
          description: |-
            Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.

            <blockquote>
              <p>Use <code>one-time</code> for single payments or <code>unscheduled</code> for recurring payments.</p>
            </blockquote>
          properties:
            payment_type:
              type: string
              description: Type of payment for future usage.
              enum:
                - one-time
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>The field value is displayed in the customer's WeChat Pay transaction history.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Client platform used to determine how the payer authorization journey is started.

            <blockquote>                
              <p>APP starts authorization in an app context, MOB follows a mobile browser path, WEB uses a desktop browser path.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitOneTimeProductDiscriminator:
      title: Product-based payment
      type: object
      discriminator:
        propertyName: payment_method
        mapping:
          paypal-vault: '#/components/schemas/RequestApmInitOneTimeProductPaypal'
          alipay: '#/components/schemas/RequestApmInitOneTimeProductAlipay'
          blik: '#/components/schemas/RequestApmInitOneTimeProductBlik'
          boleto: '#/components/schemas/RequestApmInitOneTimeProductBoleto'
          efecty: '#/components/schemas/RequestApmInitOneTimeProductEfecty'
          gcash: '#/components/schemas/RequestApmInitOneTimeProductGcash'
          ideal: '#/components/schemas/RequestApmInitOneTimeProductIdeal'
          mbway: '#/components/schemas/RequestApmInitOneTimeProductMbway'
          multibanco: '#/components/schemas/RequestApmInitOneTimeProductMultibanco'
          mercadopago: '#/components/schemas/RequestApmInitOneTimeProductMercadopago'
          openbanking: '#/components/schemas/RequestApmInitOneTimeProductOpenbanking'
          oxxo: '#/components/schemas/RequestApmInitOneTimeProductOxxo'
          pix: '#/components/schemas/RequestApmInitOneTimeProductPix'
          pix-qr: '#/components/schemas/RequestApmInitOneTimeProductPixQr'
          pix-automatico: '#/components/schemas/RequestApmInitOneTimeProductPixAutomatico'
          przelewy24: '#/components/schemas/RequestApmInitOneTimeProductPrzelewy24'
          pse: '#/components/schemas/RequestApmInitOneTimeProductPse'
          sencillito: '#/components/schemas/RequestApmInitOneTimeProductSencillito'
          servipag: '#/components/schemas/RequestApmInitOneTimeProductServipag'
          upi: '#/components/schemas/RequestApmInitOneTimeProductUpi'
          webpay: '#/components/schemas/RequestApmInitOneTimeProductWebpay'
          wechatpay: '#/components/schemas/RequestApmInitOneTimeProductWechatpay'
    RequestApmInitSubscriptionPaypal:
      title: RequestApmSubscriptionPaypal
      type: object
      required:
        - order_id
        - customer_email
        - ip_address
        - platform
        - payment_method
        - product_id
        - customer_account_id
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal" target="_blank">method</a> name.
          enum:
            - paypal-vault
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: |-
            Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.

            <blockquote>                
              <p>Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR.</p>
            </blockquote>
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>For the init-payment subscription and one-time payments, the field value is displayed on the user's PayPal statement.</p>
              <p>For recurring subscription payments, this field is configured in the product settings as Public description when <a href="https://docs.solidgate.com/billing/product-and-price-management/#edit-product " target="_blank">editing</a> a product via Hub.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for <code>UGA</code>, <code>KEN</code>, <code>TZA</code>, <code>GHA</code> locations.</p>
            </blockquote>
            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security.</p>
            </blockquote>
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitSubscriptionAlipay:
      title: RequestApmSubscriptionAlipay
      type: object
      required:
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - customer_phone
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay" target="_blank">method</a> name.
          enum:
            - alipay
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: |-
            Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.

            <blockquote>                
              <p>Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR.</p>
            </blockquote>
          minLength: 3
          maxLength: 3
          default: CNY
        future_usage:
          type: object
          description: |-
            Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.

            <blockquote>
              <p>Use <code>one-time</code> for single payments or <code>unscheduled</code> for recurring payments.</p>
            </blockquote>
          properties:
            payment_type:
              type: string
              description: Type of payment for future usage.
              enum:
                - unscheduled
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Client platform used to select the appropriate customer confirmation path during checkout.

            <blockquote>                
              <p>APP opens authorization in an app context, MOB continues in mobile web, WEB runs a desktop browser flow.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security.</p>
            </blockquote>
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    SchemaApmFutureUsageBlikSubscription:
      title: Future usage for Blik subscription payment
      type: object
      description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.
      required:
        - payment_type
      properties:
        payment_type:
          type: string
          description: Type of payment for future usage.
          enum:
            - unscheduled
    RequestApmInitSubscriptionBlik:
      title: RequestApmSubscriptionBlik
      type: object
      required:
        - order_id
        - product_id
        - customer_email
        - customer_account_id
        - ip_address
        - platform
        - payment_method
        - billing_address
        - future_usage
        - payment_method_flow
        - payment_type_data
        - user_agent
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik" target="_blank">method</a> name.
          enum:
            - blik
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - PLN
        payment_method_flow:
          type: string
          description: Interaction <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/" target="_blank">process</a> according to this method.
          enum:
            - direct
        future_usage:
          $ref: '#/components/schemas/SchemaApmFutureUsageBlikSubscription'
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: User-agent string of the device used by the customer.
          minLength: 1
          maxLength: 1000
        payment_type_data:
          $ref: '#/components/schemas/SchemaApmPaymentTypeDataBlikCode'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitSubscriptionGcash:
      title: RequestApmSubscriptionGcash
      type: object
      required:
        - order_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - customer_account_id
        - product_id
        - ip_address
        - platform
        - payment_method
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash" target="_blank">method</a> name.
          enum:
            - gcash
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: |-
            Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.

            <blockquote>                
              <p>Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR.</p>
            </blockquote>
          minLength: 3
          maxLength: 3
          enum:
            - PHP
          default: PHP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security.</p>
            </blockquote>
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitSubscriptionMbway:
      title: RequestApmSubscriptionMbway
      type: object
      required:
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - customer_phone
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/mb-way" target="_blank">method</a> name.
          enum:
            - mbway
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: |-
            Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.

            <blockquote>                
              <p>Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR.</p>
            </blockquote>
          enum:
            - EUR
        future_usage:
          type: object
          description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.
          properties:
            payment_type:
              type: string
              description: Type of payment for future usage.
              enum:
                - recurring
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>For the init-payment subscription and one-time payments, the field value is displayed on the user's payment statement.</p>
              <p>For recurring subscription payments, this field is configured in the product settings as Public description when <a href="https://docs.solidgate.com/billing/product-and-price-management/#edit-product " target="_blank">editing</a> a product via Hub.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security.</p>
            </blockquote>
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitSubscriptionMultibanco:
      title: RequestApmInitSubscriptionMultibanco
      type: object
      required:
        - payment_method
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - billing_address
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco" target="_blank">method</a> name.
          enum:
            - multibanco
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: |-
            Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.

            <blockquote>
              <p>Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR.</p>
            </blockquote>
          minLength: 3
          maxLength: 3
          enum:
            - EUR
        future_usage:
          type: object
          description: Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.
          properties:
            payment_type:
              type: string
              description: Type of payment for future usage.
              enum:
                - recurring
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>
              <p>For the init-payment subscription and one-time payments, the field value is displayed on the user's payment statement.</p>
              <p>For recurring subscription payments, this field is configured in the product settings as Public description when <a href="https://docs.solidgate.com/billing/product-and-price-management/#edit-product " target="_blank">editing</a> a product via Hub.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          minLength: 5
          maxLength: 15
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmInitSubscriptionMercadopago:
      title: RequestApmSubscriptionMercadopago
      type: object
      required:
        - order_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
        - product_id
        - customer_account_id
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/mercado-pago" target="_blank">method</a> name.
          enum:
            - mercadopago
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil or VAT/PAIS in Argentina.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: |-
            Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.

            <blockquote>                
              <p>Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR.</p>
            </blockquote>
          enum:
            - ARS
            - BRL
            - CLP
            - COP
            - MXN
            - PEN
            - UYU
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              format: iso_code_a3
              maxLength: 3
              minLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: |-
            Additional data required to make payments with the specific payment methods. Specify the value that belongs to the user country.

            <blockquote>
              <p>ARG - <code>argentina_dni</code>, BRA - <code>brazil_cpf</code>, CHL - <code>chile_ci</code>, COL - <code>colombia_cc</code>, MEX - <code>mexico_curp</code>, PER - <code>peru_dni</code>, URY - <code>uruguay_ci</code>.</p>
            </blockquote>
          oneOf:
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoArg'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoBra'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoChl'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoCol'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoMex'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoPer'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataMercadopagoUry'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitSubscriptionPix:
      title: RequestApmSubscriptionSmartPix
      type: object
      required:
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
      properties:
        payment_method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> name.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p>Pix payments via redirect to the customer’s bank page.</p>
            </blockquote>
          enum:
            - pix
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Product identifier of the <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscription</a>.

            <blockquote>                
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Identifies the category of the item.

            - `physical_goods` - tangible item that can be shipped with proof of delivery
            - `digital_goods` - goods that are stored, delivered, and used in electronic format
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              enum:
                - BRA
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform, which the customer used at the moment of payment.           

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data that is required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            brazil_cpf:
              type: string
              description: Individual taxpayer registry identification number should be collected and provided for Brazilian customers.
              maxLength: 11
          required:
            - brazil_cpf
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitSubscriptionPixQr:
      title: RequestApmSubscriptionPixQr
      type: object
      required:
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
      properties:
        payment_method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> name.

            <blockquote style="border-left: 4px solid #F2C4C4;">
              <p>Pix payments via redirect to a page with QR.</p>
            </blockquote>
          enum:
            - pix-qr
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Product identifier of the <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscription</a>.

            <blockquote>
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Identifies the category of the item.

            - `physical_goods` - tangible item that can be shipped with proof of delivery
            - `digital_goods` - goods that are stored, delivered, and used in electronic format
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              enum:
                - BRA
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform, which the customer used at the moment of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data that is required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            brazil_cpf:
              type: string
              description: Individual taxpayer registry identification number should be collected and provided for Brazilian customers.
              maxLength: 11
          required:
            - brazil_cpf
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitSubscriptionPixAutomatico:
      title: RequestApmSubscriptionPixAutomatico
      type: object
      description: |-
        Pix Automático subscription init.

        <blockquote>
          <p>Optional <code>future_usage.max_amount</code> sets a custom authorization ceiling. For subscription payment, sending <code>future_usage.billing_period</code> results in a validation error.</p>
        </blockquote>
      required:
        - order_id
        - product_id
        - customer_account_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
        - payment_method
        - payment_type_data
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> name.
          enum:
            - pix-automatico
        order_id:
          type: string
          description: Unique order identifier, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Product identifier of the <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscription</a>.

            <blockquote>
              <p>Use for product-based billing plans approved by the Central Bank of Brazil.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        future_usage:
          $ref: '#/components/schemas/SchemaApmFutureUsagePixAutomaticoProductCeiling'
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.
            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Identifies the category of the item.

            - `physical_goods` - tangible item that can be shipped with proof of delivery
            - `digital_goods` - goods that are stored, delivered, and used in electronic format
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              enum:
                - BRA
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform, which the customer used at the moment of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>
              <p>User-agent string of the customer's device, including browser version and operating system.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data that is required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">APMs</a>.
          properties:
            brazil_cpf:
              type: string
              description: Individual taxpayer registry identification number should be collected and provided for Brazilian customers.
              maxLength: 11
          required:
            - brazil_cpf
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitSubscriptionUpi:
      title: RequestApmInitPaymentUpi
      type: object
      required:
        - product_id
        - order_id
        - customer_account_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - customer_phone
        - ip_address
        - user_agent
        - platform
        - payment_method
        - billing_address
        - payment_type_data
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi" target="_blank">method</a> name.
          enum:
            - upi
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - INR
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              format: iso_code_a3
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: |-
                Address zip/postal code.

                <blockquote>                
                  <p>For addresses in India, the zip code must exactly be 6 characters long.</p>
                </blockquote>
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
          required:
            - country
            - zip
        shipping_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security.</p>
            </blockquote>
          minLength: 1
          maxLength: 1000
        payment_type_data:
          type: object
          description: Additional data required for the specific payment method.
          properties:
            india_vpa:
              type: string
              description: |-
                The Virtual Payment Address (VPA) used for UPI (Unified Payments Interface) transactions in India. VPA allows users to send and receive money electronically without requiring bank account details.

                <blockquote>
                  <p>For more information on how VPA works, refer to the <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi" target="_blank">UPI payment method details</a>.</p>
                </blockquote>
              minLength: 1
              maxLength: 130
              pattern: ^.{1,100}@.{1,30}$
          required:
            - india_vpa
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitSubscriptionWechatpay:
      title: RequestApmSubscriptionWechatpay
      type: object
      required:
        - order_id
        - product_id
        - customer_email
        - customer_account_id
        - customer_phone
        - ip_address
        - platform
        - payment_method
        - billing_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay" target="_blank">method</a> name.
          enum:
            - wechatpay
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: |-
            Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.

            <blockquote>                
              <p>Additionally, it is imperative to specify currencies for multi-currency subscription-based products, such as in USD and EUR.</p>
            </blockquote>
          minLength: 3
          maxLength: 3
          default: CNY
        future_usage:
          type: object
          description: |-
            Defines the <a href="https://docs.solidgate.com/payments/alternative-payments/manage-alternative-payments/init-alternative-payment/" target="_blank">usage</a> of stored payment credentials.

            <blockquote>
              <p>Use <code>one-time</code> for single payments or <code>unscheduled</code> for recurring payments.</p>
            </blockquote>
          properties:
            payment_type:
              type: string
              description: Type of payment for future usage.
              enum:
                - unscheduled
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        item_category:
          type: string
          description: |-
            Type of goods.

            <blockquote style="border-left: 4px solid #F2E7C4;">                
              <p><b>Highly recommended</b> to provide the <code>shipping_address</code> details for <code>physical_goods</code>.</p>
            </blockquote>
          enum:
            - physical_goods
            - digital_goods
        billing_address:
          type: object
          description: Billing address details.
          required:
            - country
          properties:
            country:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code of the billing address.
              minLength: 3
              maxLength: 3
            state:
              type: string
              description: <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> address state code of the billing address.
              maxLength: 100
            city:
              type: string
              description: City name.
              maxLength: 100
            zip:
              type: string
              description: Address zip/postal code.
              maxLength: 10
            line1:
              type: string
              description: First line of the address.
              maxLength: 200
            line2:
              type: string
              description: Second line of the address.
              maxLength: 200
        shipping_address:
          $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Client platform used to determine how the payer authorization journey is started.

            <blockquote>                
              <p>APP starts authorization in an app context, MOB follows a mobile browser path, WEB uses a desktop browser path.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        user_agent:
          type: string
          description: |-
            User-agent string of the device used by the customer.

            <blockquote>                
              <p>The user-agent string offers comprehensive details about the web browser, its version, and the device operating system, aiding in device identification for enhanced user experiences, analytics, and security.</p>
            </blockquote>
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        success_url:
          type: string
          description: URL for browser redirect after a successful payment.
          maxLength: 255
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
          maxLength: 255
    RequestApmInitSubscriptionDiscriminator:
      title: Subscription payment
      type: object
      discriminator:
        propertyName: payment_method
        mapping:
          paypal-vault: '#/components/schemas/RequestApmInitSubscriptionPaypal'
          alipay: '#/components/schemas/RequestApmInitSubscriptionAlipay'
          blik: '#/components/schemas/RequestApmInitSubscriptionBlik'
          gcash: '#/components/schemas/RequestApmInitSubscriptionGcash'
          mbway: '#/components/schemas/RequestApmInitSubscriptionMbway'
          multibanco: '#/components/schemas/RequestApmInitSubscriptionMultibanco'
          mercadopago: '#/components/schemas/RequestApmInitSubscriptionMercadopago'
          pix: '#/components/schemas/RequestApmInitSubscriptionPix'
          pix-qr: '#/components/schemas/RequestApmInitSubscriptionPixQr'
          pix-automatico: '#/components/schemas/RequestApmInitSubscriptionPixAutomatico'
          upi: '#/components/schemas/RequestApmInitSubscriptionUpi'
          wechatpay: '#/components/schemas/RequestApmInitSubscriptionWechatpay'
    SchemaApmOrderResponsePaypal:
      title: SchemaApmOrderResponsePayPal
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/" target="_blank">method</a> that was used to process the order.
          example: paypal-vault
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For COP, CRC, HUF, LAK, RSD, and TWD, should pass the integer value of the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">amount</a> with two zeros at the end (for example, XXXX00, which will be transferred as XXXX.00). The value 0 is valid only for obtaining a <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/#billing-agreement" target="_blank">billing agreement token</a> (recurring-token).</p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseAlipay:
      title: SchemaApmOrderResponseAlipay
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay/" target="_blank">method</a> that was used to process the order.
          example: alipay
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For CNY currency, the amount is in cents (e.g., 8900 = 89.00 CNY).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseBlik:
      title: SchemaApmOrderResponseBlik
      type: object
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
          example: blik
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - PLN
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">              
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseBizum:
      title: SchemaApmOrderResponseBizum
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/bizum/" target="_blank">method</a> that was used to process the order.
          example: bizum
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For EUR currency, the amount is in cents (e.g., 400 = 4.00 EUR).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseBoleto:
      title: SchemaApmOrderResponseBoleto
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
          example: boleto
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identidier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseEfecty:
      title: SchemaApmOrderResponseEfecty
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
          example: efecty
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - COP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseGcash:
      title: SchemaApmOrderResponseGcash
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash/" target="_blank">method</a> that was used to process the order.
          example: gcash
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For PHP currency, the amount is in cents, for example, 2575 = 25.75 PHP.</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseIdeal:
      title: SchemaApmOrderResponseIdeal
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
          example: ideal
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - settle_pending
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseMbway:
      title: SchemaApmOrderResponseMbway
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
          example: mbway
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4;">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseMercadopago:
      title: SchemaApmOrderResponseMercadopago
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
          example: mercadopago
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - ARS
            - BRL
            - CLP
            - COP
            - MXN
            - PEN
            - UYU
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseMultibanco:
      title: SchemaApmOrderResponseMultibanco
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco" target="_blank">method</a> that was used to process the order.
          example: multibanco
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>
              <p>For EUR currency, the amount is in cents (e.g., 2490 = 24.90 EUR).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4;">
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseOpenbanking:
      title: SchemaApmOrderResponseOpenbanking
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pay-by-bank/" target="_blank">method</a> that was used to process the order.
          enum:
            - openbanking
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
            - GBP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - settle_pending
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseOxxo:
      title: SchemaApmOrderResponseOxxo
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/oxxo/" target="_blank">method</a> that was used to process the order.
          example: oxxo
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - MXN
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4;">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponsePix:
      title: SchemaApmOrderResponseSmartPix
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> that was used to process the order.

            <blockquote style="border-left: 4px solid #F2C4C4;">                
              <p>Pix payments via redirect to the customer’s bank page.</p>
            </blockquote>
          example: pix
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4;">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponsePixQr:
      title: SchemaApmOrderResponsePixQr
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix" target="_blank">method</a> that was used to process the order.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p>Pix payments via redirect to a page with QR.</p>
            </blockquote>
          example: pix-qr
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponsePixAutomatico:
      title: SchemaApmOrderResponsePixAutomatico
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> that was used to process the order.
          example: pix-automatico
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        token:
          type: string
          description: |-
            Mandate or stored credential token for subsequent scheduled charges.

            <blockquote>
              <p>Present on recurring flows after the customer has authorized the mandate. Use it with the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/make-apm-recurring" target="_blank">recurring</a> endpoint.</p>
            </blockquote>
          maxLength: 255
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4;">
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponsePrzelewy24:
      title: SchemaApmOrderResponsePrzelewy24
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/przelewy24/" target="_blank">method</a> that was used to process the order.
          example: przelewy24
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - PLN
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponsePse:
      title: SchemaApmOrderResponsePse
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
          example: pse
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - COP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4;">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseSencillito:
      title: SchemaApmOrderResponseSencillito
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
          example: sencillito
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - CLP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseServipag:
      title: SchemaApmOrderResponseServipag
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
          example: servipag
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - CLP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseUpi:
      title: SchemaApmOrderResponseUpi
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
          example: upi
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - INR
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4;">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseWebpay:
      title: SchemaApmOrderResponseWebpay
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
          example: webpay
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - CLP
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">      
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmOrderResponseWechatpay:
      title: SchemaApmOrderResponseWechatpay
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay/" target="_blank">method</a> that was used to process the order.
          example: wechatpay
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For CNY currency, the amount is in cents (e.g., 8900 = 89.00 CNY).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
    SchemaApmDiscriminatorResponseOrder:
      type: object
      description: |-
        Details of an order, including identifiers, timestamps, amounts, status, and customer data.

          Order's structure may vary depending on the <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">alternative payment method</a> <code>method</code> used.
      properties:
        method:
          type: string
      discriminator:
        propertyName: method
        mapping:
          paypal-vault: '#/components/schemas/SchemaApmOrderResponsePaypal'
          alipay: '#/components/schemas/SchemaApmOrderResponseAlipay'
          blik: '#/components/schemas/SchemaApmOrderResponseBlik'
          bizum: '#/components/schemas/SchemaApmOrderResponseBizum'
          boleto: '#/components/schemas/SchemaApmOrderResponseBoleto'
          efecty: '#/components/schemas/SchemaApmOrderResponseEfecty'
          gcash: '#/components/schemas/SchemaApmOrderResponseGcash'
          ideal: '#/components/schemas/SchemaApmOrderResponseIdeal'
          mbway: '#/components/schemas/SchemaApmOrderResponseMbway'
          mercadopago: '#/components/schemas/SchemaApmOrderResponseMercadopago'
          multibanco: '#/components/schemas/SchemaApmOrderResponseMultibanco'
          openbanking: '#/components/schemas/SchemaApmOrderResponseOpenbanking'
          oxxo: '#/components/schemas/SchemaApmOrderResponseOxxo'
          pix: '#/components/schemas/SchemaApmOrderResponsePix'
          pix-qr: '#/components/schemas/SchemaApmOrderResponsePixQr'
          pix-automatico: '#/components/schemas/SchemaApmOrderResponsePixAutomatico'
          przelewy24: '#/components/schemas/SchemaApmOrderResponsePrzelewy24'
          pse: '#/components/schemas/SchemaApmOrderResponsePse'
          sencillito: '#/components/schemas/SchemaApmOrderResponseSencillito'
          servipag: '#/components/schemas/SchemaApmOrderResponseServipag'
          upi: '#/components/schemas/SchemaApmOrderResponseUpi'
          webpay: '#/components/schemas/SchemaApmOrderResponseWebpay'
          wechatpay: '#/components/schemas/SchemaApmOrderResponseWechatpay'
    SchemaApmTransactionsResponsePaypal:
      title: SchemaApmTransactionsResponsePaypal
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the transaction.
          example: paypal-vault
        id:
          type: string
          description: Unique identifier associated with a transaction.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: |-
            Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For COP, CRC, HUF, LAK, RSD, and TWD, should pass the integer value of the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">amount</a> with two zeros at the end (for example, XXXX00, which will be transferred as XXXX.00). The value 0 is valid only for obtaining a <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/#billing-agreement" target="_blank">billing agreement token</a> (recurring-token).</p>
            </blockquote>
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
        payer_details:
          description: |-
            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal/" target="_blank">APMs</a>.

            <blockquote>
              <p>It provides essential information such as the payer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal <code>paypal-vault</code> method.</p>
            </blockquote>
          type: object
          deprecated: true
          properties:
            invoice_id:
              type: string
              description: |-
                Unique invoice identifier provided by PayPal.

                <blockquote style="border-left: 4px solid #D1E6DF; ">
                  <p><b>Should be provided</b> only for the transactions with <code>paypal-vault</code> method.</p>
                </blockquote>
              format: uuid
              maxLength: 36
              minLength: 36
              deprecated: true
            payer_email:
              type: string
              description: |-
                Payer's email.

                <blockquote style="border-left: 4px solid #D1E6DF; ">
                  <p><b>Should be provided</b> only for the transactions with <code>paypal-vault</code> method.</p>
                </blockquote>
              deprecated: true
    SchemaApmTransactionsResponseAlipay:
      title: SchemaApmTransactionsResponseAlipay
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the transaction.
          example: alipay
        id:
          type: string
          description: Unique identifier associated with a transaction.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: |-
            Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For CNY currency, the amount is in cents (e.g., 8900 = 89.00 CNY).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseBlik:
      title: SchemaApmTransactionsResponseBlik
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the transaction.
          example: blik
        id:
          type: string
          description: Unique transaction identifier.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - PLN
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseBizum:
      title: SchemaApmTransactionsResponseBizum
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the transaction.
          example: bizum
        id:
          type: string
          description: Unique identifier associated with a transaction.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: |-
            Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For EUR currency, the amount is in cents (e.g., 400 = 4.00 EUR).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseBoleto:
      title: SchemaApmTransactionsResponseBoleto
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the transaction.
          example: boleto
        id:
          type: string
          description: Unique identifier associated with a transaction.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseEfecty:
      title: SchemaApmTransactionsResponseEfecty
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the transaction.
          example: efecty
        id:
          type: string
          description: Unique transaction identifier.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - COP
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseGcash:
      title: SchemaApmTransactionsResponseGcash
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the transaction.
          example: gcash
        id:
          type: string
          description: Unique identifier associated with a transaction.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: |-
            Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For PHP currency, the amount is in cents (e.g., 2575 = 25.75 PHP).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseIdeal:
      title: SchemaApmTransactionsResponseIdeal
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the transaction.
          example: ideal
        id:
          type: string
          description: Unique transaction identifier.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - settle_pending
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseMbway:
      title: SchemaApmTransactionsResponseMbway
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the transaction.
          example: mbway
        id:
          type: string
          description: Unique transaction identifier.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseMercadopago:
      title: SchemaApmTransactionsResponseMercadopago
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the transaction.
          example: mercadopago
        id:
          type: string
          description: Unique transaction identifier.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - ARS
            - BRL
            - CLP
            - COP
            - MXN
            - PEN
            - UYU
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseMultibanco:
      title: SchemaApmTransactionsResponseMultibanco
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco" target="_blank">method</a> that was used to process the transaction.
          example: multibanco
        id:
          type: string
          description: Unique identifier associated with a transaction.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: |-
            Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>
              <p>For EUR currency, the amount is in cents (e.g., 2490 = 24.90 EUR).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - refund
    SchemaApmTransactionsResponseOpenbanking:
      title: SchemaApmTransactionsResponseOpenbanking
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pay-by-bank/" target="_blank">method</a> that was used to process the transaction.
          example: openbanking
        id:
          type: string
          description: Unique identifier associated with a transaction.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
            - GBP
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - settle_pending
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseOxxo:
      title: SchemaApmTransactionsResponseOxxo
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/oxxo/" target="_blank">method</a> that was used to process the transaction.
          example: oxxo
        id:
          type: string
          description: Unique transaction identifier.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - MXN
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponsePix:
      title: SchemaApmTransactionsResponseSmartPix
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> that was used to process the transaction.

            <blockquote style="border-left: 4px solid #F2C4C4; ">               
              <p>Pix payments via redirect to the customer’s bank page.</p>
            </blockquote>
          example: pix
        id:
          type: string
          description: Unique identifier associated with a transaction.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponsePixQr:
      title: SchemaApmTransactionsResponsePixQr
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix" target="_blank">method</a> that was used to process the transaction.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p>Pix payments via redirect to a page with QR.</p>
            </blockquote>
          example: pix-qr
        id:
          type: string
          description: Unique transaction identifier.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponsePixAutomatico:
      title: SchemaApmTransactionsResponsePixAutomatico
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: 8Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> that was used to process the transaction.
          example: pix-automatico
        id:
          type: string
          description: Unique identifier associated with a transaction.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: |-
            <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.

            <blockquote>
              <p><code>pay</code> for the initial mandate or a one-off charge. <code>recurring</code> for subsequent scheduled charges using a stored token.</p>
            </blockquote>
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponsePrzelewy24:
      title: SchemaApmTransactionsResponsePrzelewy24
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/przelewy24/" target="_blank">method</a> that was used to process the transaction.
          example: przelewy24
        id:
          type: string
          description: Unique transaction identifier.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - PLN
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponsePse:
      title: SchemaApmTransactionsResponsePse
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pse/" target="_blank">method</a> that was used to process the transaction.
          example: pse
        id:
          type: string
          description: Unique identifier associated with a transaction.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - COP
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseSencillito:
      title: SchemaApmTransactionsResponseSencillito
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/sencillito/" target="_blank">method</a> that was used to process the transaction.
          example: sencillito
        id:
          type: string
          description: Unique transaction identifier.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - CLP
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseServipag:
      title: SchemaApmTransactionsResponseServipag
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/servipag/" target="_blank">method</a> that was used to process the transaction.
          example: servipag
        id:
          type: string
          description: Unique transaction identifier.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - CLP
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseUpi:
      title: SchemaApmTransactionsResponseUpi
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi/" target="_blank">method</a> that was used to process the transaction.
          example: upi
        id:
          type: string
          description: Unique transaction identifier.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - INR
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseWebpay:
      title: SchemaApmTransactionsResponseWebpay
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/webpay/" target="_blank">method</a> that was used to process the transaction.
          example: webpay
        id:
          type: string
          description: Unique transaction identifier.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - CLP
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmTransactionsResponseWechatpay:
      title: SchemaApmTransactionsResponseWechatpay
      type: object
      description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the transaction.
          example: wechatpay
        id:
          type: string
          description: Unique identifier associated with a transaction.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: |-
            Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For CNY currency, the amount is in cents (e.g., 8900 = 89.00 CNY).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
    SchemaApmDiscriminatorResponseTransactions:
      type: array
      description: |-
        Details of transactions, including payment method, identifiers, amounts, currencies, statuses, and types.

          Transaction's structure may vary depending on the <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">alternative payment method</a> <code>method</code> used.
      items:
        type: object
        required:
          - method
        properties:
          method:
            type: string
            description: Payment method used for the transaction.
        discriminator:
          propertyName: method
          mapping:
            paypal-vault: '#/components/schemas/SchemaApmTransactionsResponsePaypal'
            alipay: '#/components/schemas/SchemaApmTransactionsResponseAlipay'
            blik: '#/components/schemas/SchemaApmTransactionsResponseBlik'
            bizum: '#/components/schemas/SchemaApmTransactionsResponseBizum'
            boleto: '#/components/schemas/SchemaApmTransactionsResponseBoleto'
            efecty: '#/components/schemas/SchemaApmTransactionsResponseEfecty'
            gcash: '#/components/schemas/SchemaApmTransactionsResponseGcash'
            ideal: '#/components/schemas/SchemaApmTransactionsResponseIdeal'
            mbway: '#/components/schemas/SchemaApmTransactionsResponseMbway'
            mercadopago: '#/components/schemas/SchemaApmTransactionsResponseMercadopago'
            multibanco: '#/components/schemas/SchemaApmTransactionsResponseMultibanco'
            openbanking: '#/components/schemas/SchemaApmTransactionsResponseOpenbanking'
            oxxo: '#/components/schemas/SchemaApmTransactionsResponseOxxo'
            pix: '#/components/schemas/SchemaApmTransactionsResponsePix'
            pix-qr: '#/components/schemas/SchemaApmTransactionsResponsePixQr'
            pix-automatico: '#/components/schemas/SchemaApmTransactionsResponsePixAutomatico'
            przelewy24: '#/components/schemas/SchemaApmTransactionsResponsePrzelewy24'
            pse: '#/components/schemas/SchemaApmTransactionsResponsePse'
            sencillito: '#/components/schemas/SchemaApmTransactionsResponseSencillito'
            servipag: '#/components/schemas/SchemaApmTransactionsResponseServipag'
            upi: '#/components/schemas/SchemaApmTransactionsResponseUpi'
            webpay: '#/components/schemas/SchemaApmTransactionsResponseWebpay'
            wechatpay: '#/components/schemas/SchemaApmTransactionsResponseWechatpay'
    SchemaApmPaymentTypeDataResponseBoleto:
      title: Boleto
      type: object
      description: |-
        Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">alternative payment methods</a>.

        <blockquote>
          <p>This object is specifically for <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/" target="_blank">boleto</a> and <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">Pix QR</a> payments.</p>
        </blockquote>
      properties:
        amount:
          type: number
          description: |-
            Amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in the currency of the transaction.</p>
            </blockquote>
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
        expiration_date:
          type: string
          format: date
          description: Expiration date.
        image_url:
          type: string
          description: |-
            URL of the image representing the full <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/" target="_blank">boleto</a> method details.

            <blockquote>
              <p>This provides a visual reference for the user.</p>
            </blockquote>
        number:
          type: string
          description: |-
            Ticket number.

            <blockquote>
              <p>Long number customers enter in their bank app or website to complete the payment.</p>
            </blockquote>
        type:
          type: string
          description: |-
            Payment method type.

            <blockquote>
              <p>This specifies the category of the alternative payment method being used.</p>
            </blockquote>
    SchemaApmPaymentTypeDataResponseMultibanco:
      title: Multibanco
      type: object
      description: |-
        Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">alternative payment methods</a>.

        <blockquote>
          <p>This object is specifically for <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco" target="_blank">Multibanco</a> payments.</p>
        </blockquote>
      properties:
        type:
          type: string
          description: |-
            Payment method type.

            <blockquote>
              <p>This specifies the category of the alternative payment method being used.</p>
            </blockquote>
          enum:
            - multibanco
        entity:
          type: string
          description: |-
            Five-digit entity code identifying the merchant for Multibanco payments.

            <blockquote>
              <p>Customers use this code together with the payment reference at an ATM or home banking.</p>
            </blockquote>
          maxLength: 5
          minLength: 5
        reference:
          type: string
          description: |-
            Nine-digit payment reference number.

            <blockquote>
              <p>Customers enter this reference together with the entity code to complete the payment.</p>
            </blockquote>
          maxLength: 9
          minLength: 9
        reference_expiration:
          type: string
          format: date-time
          description: |-
            ISO 8601 datetime when the Multibanco payment reference expires.

            <blockquote>
              <p>The voucher is active for <code>24</code> hours from issuance.</p>
            </blockquote>
    SchemaApmPaymentTypeDataResponsePixQR:
      title: Pix QR
      type: object
      description: |-
        Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">alternative payment methods</a>.

        <blockquote>
          <p>This object is specifically for <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/" target="_blank">boleto</a> and <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">Pix QR</a> payments.</p>
        </blockquote>
      properties:
        qr_code_value:
          type: string
          description: Value used to render a QR code or for customers to copy and paste into a Pix app.
          maxLength: 255
        qr_code_expiration_date:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}( \d{2}:\d{2}:\d{2})?$
          description: Expiration date of the QR code.
    SchemaApmPaymentTypeDataResponsePixAutomatico:
      title: Pix Automático
      type: object
      description: |-
        QR payload for the customer to authorize a Pix Automático mandate on the <strong>initial</strong> charge.

        <blockquote>
          <p>The QR value is valid for one hour from issuance; if it expires, create a new init payment to obtain another code.</p>
          <p>After successful authorization, a token is issued for subsequent recurring charges in the same billing cycle. See the <a href="https://api-docs.solidgate.com/#tag/Alternative-payment-methods/operation/make-apm-recurring" target="_blank">recurring</a> operation.</p>
        </blockquote>
      properties:
        qr_code_value:
          type: string
          description: EMV payload for the customer to scan or copy into a Pix app.
          maxLength: 512
        qr_code_expiration_date:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          description: Expiration datetime of the QR code, usually within one hour after issuance.
    ResponseApmSuccess:
      title: Success
      type: object
      properties:
        order:
          $ref: '#/components/schemas/SchemaApmDiscriminatorResponseOrder'
        transactions:
          $ref: '#/components/schemas/SchemaApmDiscriminatorResponseTransactions'
        pay_form:
          type: object
          description: |-
            Payment form data.

            <blockquote>
              <p>Including fields necessary for processing the payment.</p>
            </blockquote>
          properties:
            return_url:
              type: string
              description: URL for browser redirect after a payment process.
              maxLength: 255
            script_url:
              type: string
              description: URL of the JavaScript file needed to display the <a href="https://docs.solidgate.com/payments/integrate/payment-form/apm-buttons/#method-specific-configuration" target="_blank">PayPal button</a> is required for integration, initialization, configuration.
              maxLength: 255
            token:
              type: string
              description: |-
                Secure payment token representing sensitive payment method information.

                <blockquote>
                  <p>Token received on the first payment, which should be used for subsequent payments.</p>
                </blockquote>
              deprecated: true
        payment_type_data:
          description: |-
            Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">alternative payment methods</a>.

            <blockquote>
              <p>This object is specifically for <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/" target="_blank">Boleto</a>, <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/multibanco" target="_blank">Multibanco</a> (<code>24</code>-hour reference validity), <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">Pix QR</a>, and <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">Pix Automático</a> initial mandate responses with QR payload and expiry.</p>
            </blockquote>
          oneOf:
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponseBoleto'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponseMultibanco'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponsePixQR'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponsePixAutomatico'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an object.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringPaypal:
      title: RequestApmRecurring
      type: object
      required:
        - payment_method
        - token
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal" target="_blank">method</a> name.
          enum:
            - paypal-vault
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For COP, CRC, HUF, LAK, RSD, and TWD, should pass the integer value of the amount with two zeros at the end (for example, XXXX00, which will be transferred as XXXX.00).</p>
            </blockquote>
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringAlipay:
      title: RequestApmRecurringAlipay
      type: object
      required:
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - customer_phone
        - ip_address
        - platform
        - payment_method
        - token
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay" target="_blank">method</a> name.
          enum:
            - alipay
        token:
          type: string
          description: |-
            Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.

            <blockquote>
              <p>This token must be obtained from a previous successful initial transaction with <code>future_usage</code> <code>payment_type</code> <code>unscheduled</code>.</p>
            </blockquote>
          maxLength: 255
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For CNY currency, the amount should be in cents (e.g., 8900 = 89.00 CNY).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          default: CNY
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>The field value is displayed in the customer's Alipay transaction history.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Client platform used to select the appropriate customer confirmation path during checkout.

            <blockquote>                
              <p>APP opens authorization in an app context, MOB continues in mobile web, WEB runs a desktop browser flow.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringBlik:
      title: RequestApmRecurringBlik
      type: object
      required:
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - token
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik" target="_blank">method</a> name.
          enum:
            - blik
        token:
          type: string
          description: |-
            Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.

            <blockquote><p>This token must be obtained from a previous successful initial transaction with <code>future_usage</code> <code>payment_type</code> <code>unscheduled</code>.</p></blockquote>
          maxLength: 255
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - PLN
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringGcash:
      title: RequestApmRecurring
      type: object
      required:
        - payment_method
        - token
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash" target="_blank">method</a> name.
          enum:
            - gcash
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          enum:
            - PHP
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringMbway:
      title: RequestApmRecurringMbway
      type: object
      required:
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - customer_phone
        - ip_address
        - platform
        - payment_method
        - token
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/mb-way" target="_blank">method</a> name.
          enum:
            - mbway
        token:
          type: string
          description: |-
            Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.

            <blockquote>
              <p>This token must be obtained from a previous successful initial transaction with <code>future_usage</code> <code>payment_type</code> <code>1-click</code>.</p>
            </blockquote>
          maxLength: 255
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For EUR currency, the amount should be in cents (e.g., 1020 = 10.20 EUR).</p>
            </blockquote>
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringMercadopago:
      title: RequestApmRecurring
      type: object
      required:
        - payment_method
        - token
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/mercado-pago" target="_blank">method</a> name.
          enum:
            - mercadopago
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
            - CLP
            - COP
            - MXN
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>               
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringPix:
      title: RequestApmRecurringSmartPix
      type: object
      required:
        - order_id
        - token
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
      properties:
        payment_method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix" target="_blank">method</a> name.

            <blockquote style="border-left: 4px solid #F2C4C4; ">                
              <p>Pix payments via redirect to the customer’s bank page.</p>
            </blockquote>
          enum:
            - pix
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringPixAutomatico:
      title: RequestApmRecurringPixAutomatico
      type: object
      required:
        - order_id
        - token
        - amount
        - currency
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> name.
          enum:
            - pix-automatico
        token:
          type: string
          description: Mandate or stored credential token from a completed Pix Automático init payment.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringUpi:
      title: RequestApmRecurring
      type: object
      required:
        - payment_method
        - token
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - ip_address
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi" target="_blank">method</a> name.
          enum:
            - upi
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - INR
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringWechatpay:
      title: RequestApmRecurringWechatpay
      type: object
      required:
        - amount
        - currency
        - order_id
        - order_description
        - customer_email
        - customer_phone
        - ip_address
        - payment_method
        - token
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay" target="_blank">method</a> name.
          enum:
            - wechatpay
        token:
          type: string
          description: |-
            Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.

            <blockquote>
              <p>This token must be obtained from a previous successful initial transaction with <code>future_usage</code> <code>payment_type</code> <code>unscheduled</code>.</p>
            </blockquote>
          maxLength: 255
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        amount:
          type: integer
          description: |-
            Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.

            <blockquote>                
              <p>For CNY currency, the amount should be in cents (e.g., 8900 = 89.00 CNY).</p>
            </blockquote>
          minimum: 1
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          default: CNY
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>The field value is displayed in the customer's WeChat Pay transaction history.</p>
            </blockquote>

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringDiscriminator:
      title: Payment
      type: object
      discriminator:
        propertyName: payment_method
        mapping:
          paypal-vault: '#/components/schemas/RequestApmRecurringPaypal'
          alipay: '#/components/schemas/RequestApmRecurringAlipay'
          blik: '#/components/schemas/RequestApmRecurringBlik'
          gcash: '#/components/schemas/RequestApmRecurringGcash'
          mbway: '#/components/schemas/RequestApmRecurringMbway'
          mercadopago: '#/components/schemas/RequestApmRecurringMercadopago'
          pix: '#/components/schemas/RequestApmRecurringPix'
          pix-automatico: '#/components/schemas/RequestApmRecurringPixAutomatico'
          upi: '#/components/schemas/RequestApmRecurringUpi'
          wechatpay: '#/components/schemas/RequestApmRecurringWechatpay'
    RequestApmRecurringOneTimeProductPaypal:
      title: RequestApmRecurringOneTimeProductPaypal
      type: object
      required:
        - payment_method
        - token
        - product_id
        - order_id
        - order_description
        - customer_account_id
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal" target="_blank">method</a> name.
          enum:
            - paypal-vault
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringOneTimeProductAlipay:
      title: RequestApmRecurringOneTimeProductAlipay
      type: object
      required:
        - payment_method
        - token
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - customer_phone
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay" target="_blank">method</a> name.
          enum:
            - alipay
        token:
          type: string
          description: |-
            Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.

            <blockquote>
              <p>This token must be obtained from a previous successful initial transaction with <code>future_usage</code> <code>payment_type</code> <code>unscheduled</code>.</p>
            </blockquote>
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          default: CNY
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Client platform used to select the appropriate customer confirmation path during checkout.

            <blockquote>                
              <p>APP opens authorization in an app context, MOB continues in mobile web, WEB runs a desktop browser flow.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringOneTimeProductBlik:
      title: RequestApmRecurringOneTimeProductBlik
      type: object
      required:
        - payment_method
        - token
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik" target="_blank">method</a> name.
          enum:
            - blik
        token:
          type: string
          description: |-
            Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.

            <blockquote><p>This token must be obtained from a previous successful initial transaction with <code>future_usage</code> <code>payment_type</code> <code>unscheduled</code>.</p></blockquote>
          maxLength: 255
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - PLN
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringOneTimeProductGcash:
      title: RequestApmRecurringOneTimeProductGcash
      type: object
      required:
        - payment_method
        - token
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash" target="_blank">method</a> name.
          enum:
            - gcash
        token:
          type: string
          description: Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          enum:
            - PHP
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringOneTimeProductMbway:
      title: RequestApmRecurringOneTimeProductMbway
      type: object
      required:
        - payment_method
        - token
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - customer_phone
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/mb-way" target="_blank">method</a> name.
          enum:
            - mbway
        token:
          type: string
          description: |-
            Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.

            <blockquote>
              <p>This token must be obtained from a previous successful initial transaction with <code>future_usage</code> <code>payment_type</code> <code>1-click</code>.</p>
            </blockquote>
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringOneTimeProductMercadopago:
      title: RequestApmRecurring
      type: object
      required:
        - payment_method
        - token
        - product_id
        - order_id
        - order_description
        - customer_account_id
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/mercado-pago" target="_blank">method</a> name.
          enum:
            - mercadopago
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil or VAT/PAIS in Argentina.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
            - CLP
            - COP
            - MXN
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringOneTimeProductPix:
      title: RequestApmSubscriptionRecurringSmartPix
      type: object
      required:
        - order_id
        - product_id
        - token
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - customer_account_id
      properties:
        payment_method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix" target="_blank">method</a> name.

            <blockquote>                
              <p>Pix payments via redirect to the customer’s bank page.</p>
            </blockquote>
          enum:
            - pix
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier of the <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscription</a>.

            <blockquote>                
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringOneTimeProductPixAutomatico:
      title: RequestApmRecurringOneTimeProductPixAutomatico
      type: object
      required:
        - order_id
        - product_id
        - token
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - customer_account_id
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> name.
          enum:
            - pix-automatico
        token:
          type: string
          description: Mandate or stored credential token from a completed Pix Automático init payment.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringOneTimeProductUpi:
      title: RequestApmRecurringOneTimeProductUpi
      type: object
      required:
        - payment_method
        - token
        - product_id
        - order_id
        - customer_account_id
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi" target="_blank">method</a> name.
          enum:
            - upi
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - INR
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringOneTimeProductWechatpay:
      title: RequestApmRecurringOneTimeProductWechatpay
      type: object
      required:
        - payment_method
        - token
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_phone
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay" target="_blank">method</a> name.
          enum:
            - wechatpay
        token:
          type: string
          description: |-
            Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.

            <blockquote>
              <p>This token must be obtained from a previous successful initial transaction with <code>future_usage</code> <code>payment_type</code> <code>unscheduled</code>.</p>
            </blockquote>
        order_id:
          type: string
          description: Unique order identifier defined by the merchant, which can be used to find the payment.
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          default: CNY
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Client platform used to determine how the payer authorization journey is started.

            <blockquote>                
              <p>APP starts authorization in an app context, MOB follows a mobile browser path, WEB uses a desktop browser path.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringOneTimeProductDiscriminator:
      title: Product-based payment
      type: object
      discriminator:
        propertyName: payment_method
        mapping:
          paypal-vault: '#/components/schemas/RequestApmRecurringOneTimeProductPaypal'
          alipay: '#/components/schemas/RequestApmRecurringOneTimeProductAlipay'
          blik: '#/components/schemas/RequestApmRecurringOneTimeProductBlik'
          gcash: '#/components/schemas/RequestApmRecurringOneTimeProductGcash'
          mbway: '#/components/schemas/RequestApmRecurringOneTimeProductMbway'
          mercadopago: '#/components/schemas/RequestApmRecurringOneTimeProductMercadopago'
          pix: '#/components/schemas/RequestApmRecurringOneTimeProductPix'
          pix-automatico: '#/components/schemas/RequestApmRecurringOneTimeProductPixAutomatico'
          upi: '#/components/schemas/RequestApmRecurringOneTimeProductUpi'
          wechatpay: '#/components/schemas/RequestApmRecurringOneTimeProductWechatpay'
    RequestApmRecurringSubscriptionPaypal:
      title: RequestApmRecurring
      type: object
      required:
        - payment_method
        - token
        - product_id
        - order_id
        - order_description
        - customer_account_id
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/paypal" target="_blank">method</a> name.
          enum:
            - paypal-vault
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringSubscriptionAlipay:
      title: RequestApmRecurring
      type: object
      required:
        - payment_method
        - token
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_phone
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/alipay" target="_blank">method</a> name.
          enum:
            - alipay
        token:
          type: string
          description: |-
            Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.

            <blockquote>
              <p>This token must be obtained from a previous successful initial transaction with <code>future_usage</code> <code>payment_type</code> <code>unscheduled</code>.</p>
            </blockquote>
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          default: CNY
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Client platform used to select the appropriate customer confirmation path during checkout.

            <blockquote>                
              <p>APP opens authorization in an app context, MOB continues in mobile web, WEB runs a desktop browser flow.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringSubscriptionBlik:
      title: RequestApmRecurringSubscriptionBlik
      type: object
      required:
        - payment_method
        - token
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/blik" target="_blank">method</a> name.
          enum:
            - blik
        token:
          type: string
          description: |-
            Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.

            <blockquote><p>This token must be obtained from a previous successful initial transaction with <code>future_usage</code> <code>payment_type</code> <code>unscheduled</code>.</p></blockquote>
          maxLength: 255
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - PLN
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringSubscriptionGcash:
      title: RequestApmRecurring
      type: object
      required:
        - payment_method
        - token
        - product_id
        - order_id
        - order_description
        - customer_account_id
        - customer_email
        - customer_first_name
        - customer_last_name
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/gcash" target="_blank">method</a> name.
          enum:
            - gcash
        token:
          type: string
          description: Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          enum:
            - PHP
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringSubscriptionMbway:
      title: RequestApmRecurringSubscriptionMbway
      type: object
      required:
        - payment_method
        - token
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_phone
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/mb-way" target="_blank">method</a> name.
          enum:
            - mbway
        token:
          type: string
          description: |-
            Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.

            <blockquote>
              <p>This token must be obtained from a previous successful initial transaction with <code>future_usage</code> <code>payment_type</code> <code>recurring</code>.</p>
            </blockquote>
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - EUR
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringSubscriptionMercadopago:
      title: RequestApmRecurring
      type: object
      required:
        - payment_method
        - token
        - product_id
        - order_id
        - order_description
        - customer_account_id
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/mercado-pago" target="_blank">method</a> name.
          enum:
            - mercadopago
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil or VAT/PAIS in Argentina.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
            - CLP
            - COP
            - MXN
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringSubscriptionPix:
      title: RequestApmSubscriptionRecurringSmartPix
      type: object
      required:
        - order_id
        - product_id
        - token
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - customer_account_id
      properties:
        payment_method:
          type: string
          description: |-
            Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix" target="_blank">method</a> name.

            <blockquote>                
              <p>Pix payments via redirect to the customer’s bank page.</p>
            </blockquote>
          enum:
            - pix
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Product identifier of the <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscription</a>.

            <blockquote>                
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringSubscriptionPixAutomatico:
      title: RequestApmSubscriptionRecurringPixAutomatico
      type: object
      required:
        - order_id
        - product_id
        - token
        - order_description
        - customer_email
        - ip_address
        - platform
        - payment_method
        - customer_account_id
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">method</a> name.
          enum:
            - pix-automatico
        token:
          type: string
          description: Mandate or stored credential token from a completed Pix Automático subscription init payment.
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Product identifier of the <a href="https://docs.solidgate.com/billing/subscription-overview/" target="_blank">subscription</a>.

            <blockquote>
              <p>Possible local <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/#latin-america" target="_blank">taxes</a>, such as IOF-FX in Brazil.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - BRL
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringSubscriptionUpi:
      title: RequestApmRecurring
      type: object
      required:
        - payment_method
        - token
        - product_id
        - order_id
        - customer_account_id
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/upi" target="_blank">method</a> name.
          enum:
            - upi
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          enum:
            - INR
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          maxLength: 50
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_first_name:
          type: string
          description: Customer's first name.
          maxLength: 100
        customer_last_name:
          type: string
          description: Customer's last name.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Device platform used by the customer at the time of payment.

            <blockquote>                
              <p>APP for application, WEB for desktop web, MOB for mobile web.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringSubscriptionWechatpay:
      title: RequestApmRecurring
      type: object
      required:
        - payment_method
        - token
        - order_id
        - product_id
        - order_description
        - customer_account_id
        - customer_phone
        - customer_email
        - ip_address
        - platform
      properties:
        payment_method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/wechat-pay" target="_blank">method</a> name.
          enum:
            - wechatpay
        token:
          type: string
          description: |-
            Token obtained from a previous transaction, used to authorize recurring payments without customer interaction.

            <blockquote>
              <p>This token must be obtained from a previous successful initial transaction with <code>future_usage</code> <code>payment_type</code> <code>unscheduled</code>.</p>
            </blockquote>
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        product_id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
          default: CNY
        order_description:
          type: string
          description: |-
            Brief order description.

            <blockquote>                
              <p>It is used in the <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-details" target="_blank">email receipt</a> sent to the customer.</p>
            </blockquote>
          maxLength: 100
        order_date:
          type: string
          description: Date of order creation defined by the merchant.
          maxLength: 18
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        customer_date_of_birth:
          type: string
          description: Customer's date of birth.
          format: date
          maxLength: 10
        customer_phone:
          type: string
          description: |-
            Customer's phone number.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> in international format <a href="https://www.itu.int/rec/T-REC-E.164" target="_blank">E.164</a>, starting with the plus <code>+</code> sign.</p>
            </blockquote>
          maxLength: 18
          pattern: ^\+[1-9]\d{1,14}$
        language:
          type: string
          description: |-
            Customer language settings.

            <blockquote>                
              <p>It is used to translate the email receipt to <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/#receipt-language" target="_blank">supported</a> languages. If no language is specified, the email receipt defaults to English.</p>
            </blockquote>
          default: en
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote>                
              <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        platform:
          type: string
          description: |-
            Client platform used to determine how the payer authorization journey is started.

            <blockquote>                
              <p>APP starts authorization in an app context, MOB follows a mobile browser path, WEB uses a desktop browser path.</p>
            </blockquote>
          enum:
            - APP
            - WEB
            - MOB
          default: WEB
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        fail_url:
          type: string
          description: URL for browser redirect after a failed payment.
          maxLength: 255
          deprecated: true
    RequestApmRecurringSubscriptionDiscriminator:
      title: Subscription payment
      type: object
      discriminator:
        propertyName: payment_method
        mapping:
          paypal-vault: '#/components/schemas/RequestApmRecurringSubscriptionPaypal'
          alipay: '#/components/schemas/RequestApmRecurringSubscriptionAlipay'
          blik: '#/components/schemas/RequestApmRecurringSubscriptionBlik'
          gcash: '#/components/schemas/RequestApmRecurringSubscriptionGcash'
          mbway: '#/components/schemas/RequestApmRecurringSubscriptionMbway'
          mercadopago: '#/components/schemas/RequestApmRecurringSubscriptionMercadopago'
          pix: '#/components/schemas/RequestApmRecurringSubscriptionPix'
          pix-automatico: '#/components/schemas/RequestApmRecurringSubscriptionPixAutomatico'
          upi: '#/components/schemas/RequestApmRecurringSubscriptionUpi'
          wechatpay: '#/components/schemas/RequestApmRecurringSubscriptionWechatpay'
    SchemaApmOrder:
      title: SchemaApmOrder
      type: object
      description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
      required:
        - amount
        - currency
        - order_id
        - status
        - method
        - customer_email
        - ip_address
        - order_description
        - created_at
        - updated_at
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        subscription_id:
          type: string
          description: Unique subscription identifier.
          format: uuid
          maxLength: 36
          minLength: 36
        token:
          type: string
          description: Token associated with a payment method that can be used for the subsequent payments.
        created_at:
          type: string
          description: Datetime when the order was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the order was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        order_description:
          type: string
          description: Brief order description.
          maxLength: 100
        descriptor:
          type: string
          description: |-
            Identifying text that appears on a customer’s statement.

            <blockquote>
              <p>It includes information about the transaction and helps the customer recognize the charge and provided only for <code>paypal-vault</code> method.</p>
            </blockquote>
          example: google.com
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
          enum:
            - created
            - processing
            - settle_pending
            - approved
            - declined
            - refunded
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
        ip_address:
          type: string
          description: |-
            Public IP address of the cardholder, both IPv4 and IPv6 are supported.

            <blockquote style="border-left: 4px solid #F2C4C4;">                
              <p><b>Required</b> for antifraud checks. For recurring payments, use the last session or registration IP.</p>
              <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
            </blockquote>
          maxLength: 50
        processing_amount:
          type: integer
          description: |-
            Amount of the payment in the smallest currency unit as it was processed by the payment service provider.

            <blockquote>
              <p>This amount may differ from the original order amount due to currency conversion or other processing factors.</p>
            </blockquote>
          deprecated: true
        processing_currency:
          type: string
          description: |-
            Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the payment when it was processed by payment service provider. 

            <blockquote>
              <p>In some cases, it is different from the original currency.</p>
            </blockquote>
          minLength: 3
          maxLength: 3
          deprecated: true
    SchemaApmProviderData:
      title: SchemaApmProviderData
      type: object
      description: |-
        Additional data from the payment provider. 

        <blockquote>                
          <p>Parameters in this object are only available for transactions with <code>paypal-vault</code> method.</p>
        </blockquote>
      properties:
        billing_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardBillingAddress'
        shipping_address:
          allOf:
            - $ref: '#/components/schemas/SchemaApmCardShippingAddress'
        payer:
          description: |-
            Details of the payer for transactions conducted via <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

            <blockquote>
              <p>It provides key information such as the payer's email, first name, and last name, crucial for identifying the payer in the transaction process.</p>
            </blockquote>
          type: object
          properties:
            account_id:
              type: string
              description: |-
                Payer or their wallet identifier in the payment provider's system.

                <blockquote>
                  <p>Used to uniquely identify the payer.</p>
                </blockquote>
            first_name:
              type: string
              description: Payer's first name, used to identify the individual within the transaction.
            last_name:
              type: string
              description: Payer's last name, used to verify the payer's identity.
            phone:
              type: string
              description: |-
                Phone number of the payer.

                <blockquote>
                  <p>Used for communication and identification purposes in the transaction.</p>
                </blockquote>
            email:
              type: string
              description: |-
                Email address of the payer.

                <blockquote>
                  <p>Used for communication and identification purposes in the transaction.</p>
                </blockquote>
        merchant:
          type: object
          description: |-
            Information about the merchant involved in the transaction, useful for identifying the specific PayPal account used for the payment.

            <blockquote>
              <p>This object provides identifiers for merchants, essential for accurate tracking and processing of transactions.</p>
            </blockquote>
          properties:
            account_id:
              type: string
              description: |-
                Unique merchant PayPal account identifier used in the transaction.

                <blockquote>
                  <p>Identifier is critical for associating the transaction with the correct merchant's PayPal account, enabling accurate processing and order reporting.</p>
                </blockquote>
    SchemaApmTransaction:
      title: SchemaApmTransaction
      type: object
      required:
        - status
        - method
        - amount
        - currency
        - type
        - created_at
      properties:
        method:
          type: string
          description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the transaction.
        id:
          type: string
          description: Unique identifier associated with a transaction.
          maxLength: 100
        created_at:
          type: string
          description: Datetime when the transaction was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        amount:
          type: integer
          description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          minLength: 3
          maxLength: 3
        status:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
          enum:
            - created
            - processing
            - settle_pending
            - success
            - fail
        type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
          enum:
            - pay
            - recurring
            - refund
        refund_reason:
          type: string
          description: Text description of the refund reason.
        refund_reason_code:
          type: string
          description: |-
            Refund reason <a href="https://docs.solidgate.com/payments/payments-insights/refund-reasons/" target="_blank">code</a>.

            <blockquote>
              <p>This field is actively validated against the current list of reason codes. Deprecated codes will not be accepted.</p>
            </blockquote>
          minLength: 4
          maxLength: 4
        payer_details:
          description: |-
            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

            <blockquote>
              <p>It provides essential information such as the payer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
            </blockquote>
          type: object
          deprecated: true
          properties:
            invoice_id:
              type: string
              description: |-
                Unique invoice identifier provided by PayPal.

                <blockquote style="border-left: 4px solid #D1E6DF;">
                  <p><b>Should be provided</b> only for the transactions with <code>paypal-vault</code> method.</p>
                </blockquote>
              format: uuid
              maxLength: 36
              minLength: 36
              deprecated: true
            payer_email:
              type: string
              description: |-
                Payer's email.

                <blockquote style="border-left: 4px solid #D1E6DF;">
                  <p><b>Should be provided</b> only for the transactions with <code>paypal-vault</code> method.</p>
                </blockquote>
              deprecated: true
    SchemaApmPayForm:
      title: SchemaApmPayForm
      type: object
      description: |-
        Payment form data.

        <blockquote>
          <p>Including fields necessary for processing the payment.</p>
        </blockquote>
      properties:
        return_url:
          type: string
          description: URL for browser redirect after a payment process.
        script_url:
          type: string
          description: URL of the JavaScript file needed to display the <a href="https://docs.solidgate.com/payments/integrate/payment-form/apm-buttons/#method-specific-configuration" target="_blank">PayPal button</a> is required for integration, initialization, configuration.
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
          deprecated: true
    ResponseApmRecurring:
      title: Success
      type: object
      description: |-
        Confirmed recurring charge: updated order, transaction line items, and any provider-specific payload.

        <blockquote>
          <p><code>transactions[].type</code> is <code>recurring</code> for token-based follow-up charges. Method-specific fields may appear under <code>payment_type_data</code> or <code>order.provider_data</code> when the provider returns them.</p>
        </blockquote>
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/SchemaApmOrder'
            - type: object
              properties:
                provider_data:
                  $ref: '#/components/schemas/SchemaApmProviderData'
        transactions:
          type: array
          description: Details of a transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.
          items:
            allOf:
              - $ref: '#/components/schemas/SchemaApmTransaction'
        pay_form:
          allOf:
            - $ref: '#/components/schemas/SchemaApmPayForm'
        payment_type_data:
          description: |-
            Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">alternative payment methods</a>.

            <blockquote>
              <p>This object is specifically for <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/" target="_blank">Boleto</a>, <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">Pix QR</a>, and <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">Pix Automático</a> initial mandate responses with QR payload and expiry.</p>
            </blockquote>
          oneOf:
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponseBoleto'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponsePixQR'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponsePixAutomatico'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an object.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmRecurringTokenCancellation:
      title: RequestApmRecurringTokenCancellation
      type: object
      required:
        - token
      properties:
        token:
          type: string
          description: Recurring token to cancel.
          example: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
    ResponseApmRecurringTokenCancellation:
      title: Success
      type: object
      required:
        - status
      properties:
        status:
          type: string
          description: Cancellation status.
          enum:
            - processing
          example: processing
    SchemaApmErrorRevokeToken:
      title: SchemaApmErrorRecurringTokenCancellation
      type: object
      properties:
        code:
          type: string
          description: <a href="https://docs.solidgate.com/payments/payments-insights/error-codes" target="_blank">Code</a> representing the specific error or status condition.
          enum:
            - '2.01'
          example: '2.01'
        messages:
          type: object
          description: Object with string keys and array of strings as values.
          additionalProperties:
            type: array
            items:
              type: string
          example:
            general:
              - recurring token was not found
      required:
        - code
        - messages
    SchemaApmError:
      title: SchemaApmError
      type: object
      properties:
        code:
          type: string
          description: <a href="https://docs.solidgate.com/payments/payments-insights/error-codes" target="_blank">Code</a> representing the specific error or status condition.
          enum:
            - X.XX
          example: X.XX
        messages:
          type: array
          description: |-
            Array containing either strings or objects that provide details about the error or status.

            <blockquote>
              <p>When it is an array of strings, each string describes a separate issue. When it is an object, the object will contain key-value pairs explaining the issue in more detail.</p>
            </blockquote>
          items:
            oneOf:
              - type: string
              - type: object
        recommended_message_for_user:
          type: string
          description: Message with recommended next steps or additional information.
          example: Invalid card token.
      required:
        - code
        - messages
    SchemaApmDiscriminatorRevokeTokenError:
      description: Error object.
      properties:
        code:
          type: string
          description: Gateway <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">error code</a> for the declined payment.
      discriminator:
        propertyName: code
        mapping:
          '2.01': '#/components/schemas/SchemaApmErrorRevokeToken'
          X.XX: '#/components/schemas/SchemaApmError'
    ResponseApmRecurringTokenCancellationError:
      title: Error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/SchemaApmDiscriminatorRevokeTokenError'
      required:
        - error
    RequestApmRefund:
      title: RequestApmRefund
      type: object
      properties:
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        amount:
          type: integer
          description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
          exclusiveMinimum: true
          minimum: 0
        refund_reason_code:
          type: string
          description: |-
            Refund reason <a href="https://docs.solidgate.com/payments/payments-insights/refund-reasons/" target="_blank">code</a>.

              <blockquote>
                <p>This field is actively validated against the current list of reason codes. Deprecated codes will not be accepted.</p>
              </blockquote>
          minLength: 4
          maxLength: 4
      required:
        - order_id
        - amount
    ResponseApmRefund:
      title: Success
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/SchemaApmOrder'
            - type: object
              properties:
                provider_data:
                  $ref: '#/components/schemas/SchemaApmProviderData'
        transactions:
          type: array
          description: Details of a transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.
          items:
            allOf:
              - $ref: '#/components/schemas/SchemaApmTransaction'
        pay_form:
          allOf:
            - $ref: '#/components/schemas/SchemaApmPayForm'
        payment_type_data:
          description: |-
            Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">alternative payment methods</a>.

            <blockquote>
              <p>This object is specifically for <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/" target="_blank">Boleto</a>, <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">Pix QR</a>, and <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">Pix Automático</a> initial mandate responses with QR payload and expiry.</p>
            </blockquote>
          oneOf:
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponseBoleto'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponsePixQR'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponsePixAutomatico'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an object.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    RequestApmCheckOrderStatus:
      title: RequestApmCheckOrderStatus
      type: object
      required:
        - order_id
      properties:
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
             <p>For the first payment, the identifier is defined by the merchant.</p>
             <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
          example: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
    SchemaApmErrorInvalidCardToken:
      title: SchemaMainErrorDoNotHonor
      type: object
      properties:
        code:
          type: string
          description: |-
            <a href="https://docs.solidgate.com/payments/payments-insights/error-codes" target="_blank">Code</a> indicating the reason for the payment decline.

            <blockquote>
              <p>These errors often indicate that an invalid or nonexistent card token was received during the transaction.</p>
            </blockquote>
          enum:
            - '5.02'
          example: '5.02'
        messages:
          type: array
          description: Array containing messages that specify why the payment was declined due to validation errors.
          items:
            type: string
            example: Invalid card token
        recommended_message_for_user:
          type: string
          description: |-
            Recommended message to be displayed to the user for further action or information.

            <blockquote>
              <p>Ask the customer to retry the transaction or use a different card. Ensure that the card token generation and handling processes are correctly implemented.</p>
            </blockquote>
      required:
        - code
        - messages
    SchemaApmDiscriminatorErrorSuccess:
      description: Error object.
      properties:
        code:
          type: string
          description: Gateway <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">error code</a> for the declined payment.
      discriminator:
        propertyName: code
        mapping:
          5.02 Invalid card token: '#/components/schemas/SchemaApmErrorInvalidCardToken'
          X.XX: '#/components/schemas/SchemaApmError'
    ResponseApmCheckOrderStatus:
      title: Success
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/SchemaApmOrder'
            - type: object
              properties:
                provider_data:
                  $ref: '#/components/schemas/SchemaApmProviderData'
        error:
          description: |-
            <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">Error</a> object.

            <blockquote>
              <p>Returned only in cases of <code>declined</code> statuses at the order, and <code>fail</code> status at transaction.</p>
            </blockquote>
          allOf:
            - $ref: '#/components/schemas/SchemaApmDiscriminatorErrorSuccess'
        transactions:
          type: array
          description: Details of a transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.
          items:
            allOf:
              - $ref: '#/components/schemas/SchemaApmTransaction'
        pay_form:
          allOf:
            - $ref: '#/components/schemas/SchemaApmPayForm'
        payment_type_data:
          description: |-
            Additional data required to make payments with the specific <a href="https://docs.solidgate.com/payments/payments-insights/countries-specifics/" target="_blank">alternative payment methods</a>.

            <blockquote>
              <p>This object is specifically for <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/boleto/" target="_blank">Boleto</a>, <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">Pix QR</a>, and <a href="https://docs.solidgate.com/payments/alternative-payments/apms-overview/pix/" target="_blank">Pix Automático</a> initial mandate responses with QR payload and expiry.</p>
            </blockquote>
          oneOf:
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponseBoleto'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponsePixQR'
            - $ref: '#/components/schemas/SchemaApmPaymentTypeDataResponsePixAutomatico'
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an object.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
    SchemaApmDiscriminatorError:
      description: Error object.
      properties:
        code:
          type: string
          description: Gateway <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">error code</a> for the declined payment.
      discriminator:
        propertyName: code
        mapping:
          2.01 Order not found: '#/components/schemas/SchemaMainErrorOrderNotFound'
          X.XX: '#/components/schemas/SchemaApmError'
    ResponseApmError:
      title: Error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/SchemaApmDiscriminatorError'
      required:
        - error
    ResponseBillingProductCreateListOneTime:
      title: Product-based payment
      type: object
      properties:
        data:
          type: array
          description: Contains an array of product data, each representing a specific price configuration.
          items:
            description: Product data.
            type: object
            properties:
              id:
                type: string
                description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
                format: uuid
                example: cb43b415-5522-4373-b026-a365462f9114
              name:
                type: string
                description: Product name.
                minLength: 1
                maxLength: 500
                example: Luxury product
              type:
                type: string
                description: Specifies whether the <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> is a one-time purchase or a subscription product.
                enum:
                  - one-time
                example: one-time
              description:
                type: string
                description: Product description.
                minLength: 1
                maxLength: 500
                example: This product is the best product all over the world
              public_description:
                type: string
                description: Product description for customers.
                minLength: 1
                maxLength: 100
                example: That cool product that you have bought
              status:
                type: string
                description: |-
                  Product status.

                  <blockquote>
                    <p>Cannot be changed if a subscription exists for the product.</p>
                  </blockquote>
                enum:
                  - active
                  - disabled
                  - archived
                example: active
              created_at:
                type: string
                description: Datetime of the product creation.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                example: '2025-05-31 12:53:12'
              updated_at:
                type: string
                description: Datetime of the product update.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                example: '2025-05-31 12:53:13'
              payment_action:
                type: string
                description: Payment processing flow applied to the transaction.
                enum:
                  - auth_settle
                example: auth_settle
              settle_interval:
                type: integer
                description: |-
                  Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.

                  <blockquote>
                    <ul>
                      <li>If the product has a trial, this field does not affect the first payments but influences recurring ones processed with <code>auth_settle</code>.</li>
                      <li>If there is no trial, this field defines the interval for the first <code>auth_settle</code> payment.</li>
                    </ul>
                  </blockquote>
                minimum: 0
                maximum: 168
                example: 48
              tax:
                type: object
                description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
                required:
                  - category_id
                properties:
                  category_id:
                    type: string
                    description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
                    minLength: 1
                    maxLength: 50
                    example: taxc_01JJVD231C879QBHVTVCWJ1K2A
                  behavior:
                    type: string
                    description: |-
                      Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                      <blockquote>
                        <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                      </blockquote>
                    enum:
                      - location_preset
                      - included
                      - excluded
                    example: included
              metadata:
                type: object
                description: |-
                  Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

                  <blockquote>
                    <p>Supports up to 50 key-value pairs:</p>
                    <ul>
                      <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                      <li>Values can be up to 500 characters</li>
                    </ul>
                  </blockquote>
                additionalProperties:
                  type: string
                  maxLength: 500
                maxProperties: 50
                example:
                  access_duration: 30d
                  plan_tier: premium
            required:
              - id
              - name
              - type
              - description
              - status
              - created_at
              - updated_at
              - payment_action
        pagination:
          type: object
          description: Contains information about the pagination of the results.
          properties:
            offset:
              type: integer
              description: Starting index of the returned results.
              example: 20
            limit:
              type: integer
              description: Maximum number of items to return.
              example: 10
              maxLength: 100
            total_count:
              type: integer
              description: Total count of the products available.
              example: 150
          required:
            - offset
            - limit
            - total_count
    ResponseBillingProductCreateListSubscription:
      title: Subscription payment
      type: object
      properties:
        data:
          type: array
          description: Contains an array of product data, each representing a specific price configuration.
          items:
            description: Product data.
            type: object
            properties:
              id:
                type: string
                description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
                format: uuid
                example: cb43b415-5522-4373-b026-a365462f9114
              name:
                type: string
                description: Product name.
                minLength: 1
                maxLength: 500
                example: Luxury product
              type:
                type: string
                description: Specifies whether the <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> is a one-time purchase or a subscription product.
                enum:
                  - recurring
                example: recurring
              description:
                type: string
                description: Product description.
                minLength: 1
                maxLength: 500
                example: This product is the best product all over the world
              public_description:
                type: string
                description: Product description for customers.
                minLength: 1
                maxLength: 100
                example: That cool product that you have bought
              status:
                type: string
                description: |-
                  Product status.

                  <blockquote>
                    <p>Cannot be changed if a subscription exists for the product.</p>
                  </blockquote>
                enum:
                  - active
                  - disabled
                  - archived
                example: active
              created_at:
                type: string
                description: Datetime of the product creation.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                example: '2025-05-31 12:53:12'
              updated_at:
                type: string
                description: Datetime of the product update.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                example: '2025-05-31 12:53:13'
              term_length:
                type: integer
                description: |-
                  Maximum number of billing cycles before subscription expiration and automatic cancellation with error code <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired" target="_blank">8.08</a>.

                  <blockquote>
                    <p>Cannot be changed if a subscription exists for the product.</p>
                  </blockquote>
                example: 20
              payment_action:
                type: string
                description: Payment processing flow applied to the transaction.
                enum:
                  - auth_settle
                example: auth_settle
              settle_interval:
                type: integer
                description: |-
                  Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.

                  <blockquote>
                    <ul>
                      <li>If the product has a trial, this field does not affect the first payments but influences recurring ones processed with <code>auth_settle</code>.</li>
                      <li>If there is no trial, this field defines the interval for the first <code>auth_settle</code> payment.</li>
                    </ul>
                  </blockquote>
                minimum: 0
                maximum: 168
                example: 48
              billing_period:
                type: object
                description: <a href="https://docs.solidgate.com/billing/subscription-overview/#billing-period" target="_blank">Billing period</a> in time units.
                required:
                  - unit
                  - value
                properties:
                  unit:
                    type: string
                    description: Unit of the billing period.
                    enum:
                      - day
                      - week
                      - month
                      - year
                    example: day
                  value:
                    type: integer
                    description: Value of the billing period as an integer.
                    minimum: 1
                    maximum: 730
                    example: 10
              trial:
                type: object
                description: |-
                  Trial settings. 

                  <blockquote style="border-left: 4px solid #F2C4C4;">
                    <p><strong>Required</strong> if the trial type is free or paid. Must not be sent if the type is absent.</p>
                    <p>Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed.</p>
                  </blockquote>
                required:
                  - billing_period
                  - payment_action
                properties:
                  billing_period:
                    type: object
                    description: Trial billing period in time units.
                    required:
                      - unit
                      - value
                    properties:
                      unit:
                        type: string
                        description: Unit of the trial billing period.
                        enum:
                          - day
                          - week
                          - month
                          - year
                        example: day
                      value:
                        type: integer
                        description: Value of the trial billing period as an integer.
                        minimum: 1
                        maximum: 730
                        example: 10
                  payment_action:
                    type: string
                    description: |-
                      Specifies a <a href="https://docs.solidgate.com/payments/payments-overview/" target="_blank">payment flow</a> applied to the first transaction, with or without the next money return, for:
                      - **free trial** - the payment actions are `auth_0_amount` and `auth_void`, with the last indicating that the funds will be refunded to the customer
                      - **paid trial** - the payment action is `auth_settle`, indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account
                    enum:
                      - auth_0_amount
                      - auth_void
                      - auth_settle
                    example: auth_settle
                  settle_interval:
                    type: integer
                    description: |-
                      Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours used in the `auth_settle` payment flow.

                      <blockquote style="border-left: 4px solid #F2C4C4;">
                        <p><strong>Required</strong> if trial <code>payment_action</code> <code>auth_settle</code> and must not be used for other <code>payment_action</code> types.</p>
                      </blockquote>
                    minimum: 0
                    maximum: 168
                    example: 48
              retry_mode:
                type: string
                description: <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/" target="_blank">Retry mode</a> to recover the failed subscription payments.
                enum:
                  - smart
                  - static
                example: static
              retry_strategy_id:
                type: string
                description: Unique <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a> identifier.
                format: uuid
                example: db43b415-5522-4373-b026-a365462f9439
              tax:
                type: object
                description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
                required:
                  - category_id
                properties:
                  category_id:
                    type: string
                    description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
                    minLength: 1
                    maxLength: 50
                    example: taxc_01JJVD231C879QBHVTVCWJ1K2A
                  behavior:
                    type: string
                    description: |-
                      Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                      <blockquote>
                        <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                      </blockquote>
                    enum:
                      - location_preset
                      - included
                      - excluded
                    example: included
              metadata:
                type: object
                description: |-
                  Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

                  <blockquote>
                    <p>Supports up to 50 key-value pairs:</p>
                    <ul>
                      <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                      <li>Values can be up to 500 characters</li>
                    </ul>
                  </blockquote>
                additionalProperties:
                  type: string
                  maxLength: 500
                maxProperties: 50
                example:
                  access_duration: 30d
                  plan_tier: premium
            required:
              - id
              - name
              - type
              - description
              - status
              - created_at
              - updated_at
              - payment_action
              - billing_period
        pagination:
          type: object
          description: Contains information about the pagination of the results.
          properties:
            offset:
              type: integer
              description: Starting index of the returned results.
              example: 20
            limit:
              type: integer
              description: Maximum number of items to return.
              example: 10
              maxLength: 100
            total_count:
              type: integer
              description: Total count of the products available.
              example: 150
          required:
            - offset
            - limit
            - total_count
    ResponseBillingBadRequest:
      type: object
      properties:
        error:
          required:
            - code
            - message
          type: object
          description: Error object.
          properties:
            code:
              type: string
              description: Error code.
              example: '2.01'
            message:
              type: string
              description: Error message.
              example: Validation error
            constraints:
              type: object
              description: Map of constraints.
              additionalProperties:
                type: array
                description: Dynamic map where keys represent the field names that failed validation, and values are arrays of objects detailing the constraint violations.
                items:
                  properties:
                    code:
                      type: string
                      description: Error code.
                      example: NotNull
                    message:
                      type: string
                      description: Error message.
                      example: must not be null
      required:
        - error
    ResponseBillingUnauthorized:
      type: object
      properties:
        error:
          required:
            - code
            - message
          type: object
          description: Error object.
          properties:
            code:
              type: string
              example: '1.01'
              description: Error code indicating the specific authorization failure.
            message:
              type: string
              example: Authorization failed
              description: Descriptive message providing more details about the authorization failure.
      required:
        - error
    ResponseMainAccessDenied:
      title: Access denied
      type: object
      properties:
        error:
          type: object
          description: Error object.
          properties:
            code:
              type: string
              description: Error code indicating that access to the service is denied.
              example: '1.02'
            message:
              type: string
              description: Message informing that the service is not allowed for the account.
              example: Access denied
          required:
            - code
            - message
      required:
        - error
    RequestBillingProductCreateOneTime:
      title: Product-based payment
      description: Product data.
      type: object
      properties:
        name:
          type: string
          description: Product name.
          minLength: 1
          maxLength: 500
          example: Luxury product
        type:
          type: string
          description: |-
            Specifies whether the <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> is a one-time purchase or a subscription product.

            <blockquote>
              <p>Once a product is created, its type cannot be changed.</p>
            </blockquote>
          enum:
            - one-time
          default: recurring
          example: one-time
        description:
          type: string
          description: Product description.
          minLength: 1
          maxLength: 500
          example: This product is the best product all over the world
        public_description:
          type: string
          description: |-
            Product description for customers.

            <blockquote style="border-left: 4px solid #F2E7C4;">
              <p><strong>Highly recommended</strong> to provide as it is sent to banks, shown in customer bank statements, and included in Solidgate <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/" target="_blank">email receipts</a>, helping customers identify who charged them and for what.</p>
            </blockquote>
          minLength: 1
          maxLength: 100
          example: That cool product which you have bought
        status:
          type: string
          description: Product status.
          enum:
            - disabled
            - active
          example: active
        payment_action:
          type: string
          description: Payment processing flow applied to the transaction.
          enum:
            - auth_settle
          example: auth_settle
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
          minimum: 0
          maximum: 168
          example: 48
        tax:
          type: object
          description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
          required:
            - category_id
          properties:
            category_id:
              type: string
              description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
              minLength: 1
              maxLength: 50
              example: taxc_01JJVD231C879QBHVTVCWJ1K2A
            behavior:
              type: string
              description: |-
                Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                <blockquote>
                  <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                </blockquote>
              enum:
                - location_preset
                - included
                - excluded
              example: included
        metadata:
          type: object
          description: |-
            Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

            <blockquote>
              <p>Supports up to 50 key-value pairs:</p>
              <ul>
                <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                <li>Values can be up to 500 characters</li>
              </ul>
            </blockquote>
          additionalProperties:
            type: string
            maxLength: 500
          maxProperties: 50
          example:
            access_duration: 30d
            plan_tier: premium
      required:
        - name
        - description
        - status
        - payment_action
    RequestBillingProductCreateSubscription:
      title: Subscription payment
      description: Product data.
      type: object
      properties:
        name:
          type: string
          description: Product name.
          minLength: 1
          maxLength: 500
          example: Luxury product
        type:
          type: string
          description: |-
            Specifies whether the <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> is a one-time purchase or a subscription product.

            <blockquote>
              <p>Once a product is created, its type cannot be changed.</p>
            </blockquote>
          enum:
            - recurring
          default: recurring
          example: recurring
        description:
          type: string
          description: Product description.
          minLength: 1
          maxLength: 500
          example: This product is the best product all over the world
        public_description:
          type: string
          description: |-
            Product description for customers.

            <blockquote style="border-left: 4px solid #F2E7C4;">
              <p><strong>Highly recommended</strong> to provide as it is sent to banks, shown in customer bank statements, and included in Solidgate <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/" target="_blank">email receipts</a>, helping customers identify who charged them and for what.</p>
            </blockquote>
          minLength: 1
          maxLength: 100
          example: That cool product which you have bought
        status:
          type: string
          description: |-
            Product status.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          enum:
            - disabled
            - active
          example: active
        term_length:
          type: integer
          description: |-
            Maximum number of billing cycles before subscription expiration and automatic cancellation with error code <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired" target="_blank">8.08</a>.

              <blockquote>
                <p>Cannot be changed if a subscription exists for the product.</p>
              </blockquote>
          example: 20
        payment_action:
          type: string
          description: Payment processing flow applied to the transaction.
          enum:
            - auth_settle
          example: auth_settle
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.

            <blockquote>
              <ul>
                <li>If the product has a trial, this field does not affect the first payments but influences recurring ones processed with <code>auth_settle</code>.</li>
                <li>If there is no trial, this field defines the interval for the first <code>auth_settle</code> payment.</li>
              </ul>
            </blockquote>
          minimum: 0
          maximum: 168
          example: 48
        billing_period:
          type: object
          description: |-
            <a href="https://docs.solidgate.com/billing/subscription-overview/#billing-period" target="_blank">Billing period</a> in time units, with a maximum value equivalent to 2 years.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Unit of the billing period.
              enum:
                - day
                - week
                - month
                - year
              example: day
            value:
              type: integer
              description: |-
                Value of the billing period as an integer.

                <blockquote>
                  <p>Maximum value must not exceed 730 days, 104 weeks, 24 months, or 2 years.</p>
                </blockquote>
              minimum: 1
              maximum: 730
              example: 10
        trial:
          type: object
          description: |-
            Trial period settings, applicable for products offering free or paid trials.

            <blockquote>
              <p>Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed.</p>
            </blockquote>
          required:
            - billing_period
            - payment_action
          properties:
            billing_period:
              type: object
              description: Trial billing period in time units, with a maximum value equivalent to 2 years.
              required:
                - unit
                - value
              properties:
                unit:
                  type: string
                  description: Unit of the trial billing period.
                  enum:
                    - day
                    - week
                    - month
                    - year
                  example: day
                value:
                  type: integer
                  description: |-
                    Value of the trial billing period as an integer.

                    <blockquote>
                      <p>Maximum value must not exceed 730 days, 104 weeks, 24 months, or 2 years.</p>
                    </blockquote>
                  minimum: 1
                  maximum: 730
                  example: 10
            payment_action:
              type: string
              description: |-
                Specifies a <a href="https://docs.solidgate.com/payments/payments-overview/" target="_blank">payment flow</a> applied to the first transaction, with or without the next money return, for:
                - **free trial** - the payment actions are `auth_0_amount` and `auth_void`, with the last indicating that the funds will be refunded to the customer
                - **paid trial** - the payment action is `auth_settle`, indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account
              enum:
                - auth_0_amount
                - auth_void
                - auth_settle
              example: auth_settle
            settle_interval:
              type: integer
              description: |-
                Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours used in the `auth_settle` payment flow.

                <blockquote style="border-left: 4px solid #F2C4C4;">
                  <p><strong>Required</strong> if trial <code>payment_action</code> <code>auth_settle</code> and must not be used for other <code>payment_action</code> types.</p>
                </blockquote>
              minimum: 0
              maximum: 168
              example: 48
        retry_mode:
          type: string
          description: <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/" target="_blank">Retry mode</a> to recover the failed subscription payments.
          enum:
            - smart
            - static
          example: static
        retry_strategy_id:
          type: string
          description: |-
            Unique <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a> identifier.

            <blockquote>
              <p>Pass it for the <code>static</code> retry mode.</p>
            </blockquote>
          format: uuid
          example: db43b415-5522-4373-b026-a365462f9439
        tax:
          type: object
          description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
          required:
            - category_id
          properties:
            category_id:
              type: string
              description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
              minLength: 1
              maxLength: 50
              example: taxc_01JJVD231C879QBHVTVCWJ1K2A
            behavior:
              type: string
              description: |-
                Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                <blockquote>
                  <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                </blockquote>
              enum:
                - location_preset
                - included
                - excluded
              example: included
        metadata:
          type: object
          description: |-
            Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

            <blockquote>
              <p>Supports up to 50 key-value pairs:</p>
              <ul>
                <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                <li>Values can be up to 500 characters</li>
              </ul>
            </blockquote>
          additionalProperties:
            type: string
            maxLength: 500
          maxProperties: 50
          example:
            access_duration: 30d
            plan_tier: premium
      required:
        - name
        - description
        - status
        - billing_period
        - payment_action
    ResponseBillingProductCreateOneTime:
      title: Product-based payment
      description: Product data.
      type: object
      properties:
        id:
          type: string
          description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
          format: uuid
          maxLength: 36
          minLength: 36
          example: ac43b415-5522-4373-b026-a365462f9657
        name:
          type: string
          description: Product name.
          minLength: 1
          maxLength: 500
          example: Luxury product
        type:
          type: string
          description: Specifies whether the <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> is a one-time purchase or a subscription product.
          enum:
            - one-time
          example: one-time
        description:
          type: string
          description: Product description.
          minLength: 1
          maxLength: 500
          example: This product is the best product all over the world
        public_description:
          type: string
          description: Product description for customers.
          minLength: 1
          maxLength: 100
          example: That cool product that you have bought
        status:
          type: string
          description: |-
            Product status.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          enum:
            - disabled
            - active
          example: active
        created_at:
          type: string
          description: Datetime of the product creation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:12'
        updated_at:
          type: string
          description: Datetime of the product update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:13'
        payment_action:
          type: string
          description: Payment processing flow applied to the transaction.
          enum:
            - auth_settle
          example: auth_settle
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.

            <blockquote>
              <ul>
                <li>If the product has a trial, this field does not affect the first payments but influences recurring ones processed with <code>auth_settle</code>.</li>
                <li>If there is no trial, this field defines the interval for the first <code>auth_settle</code> payment.</li>
              </ul>
            </blockquote>
          minimum: 0
          maximum: 168
          example: 48
        tax:
          type: object
          description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
          required:
            - category_id
          properties:
            category_id:
              type: string
              description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
              minLength: 1
              maxLength: 50
              example: taxc_01JJVD231C879QBHVTVCWJ1K2A
            behavior:
              type: string
              description: |-
                Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                <blockquote>
                  <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                </blockquote>
              enum:
                - location_preset
                - included
                - excluded
              example: included
        metadata:
          type: object
          description: |-
            Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

            <blockquote>
              <p>Supports up to 50 key-value pairs:</p>
              <ul>
                <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                <li>Values can be up to 500 characters</li>
              </ul>
            </blockquote>
          additionalProperties:
            type: string
            maxLength: 500
          maxProperties: 50
          example:
            access_duration: 30d
            plan_tier: premium
      required:
        - id
        - name
        - type
        - description
        - status
        - created_at
        - updated_at
        - payment_action
    ResponseBillingProductCreateSubscription:
      title: Subscription payment
      description: Product data.
      type: object
      properties:
        id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
          example: ac43b415-5522-4373-b026-a365462f9657
        name:
          type: string
          description: Product name.
          minLength: 1
          maxLength: 500
          example: Luxury product
        type:
          type: string
          description: Specifies whether the <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> is a one-time purchase or a subscription product.
          enum:
            - recurring
          example: recurring
        description:
          type: string
          description: Product description.
          minLength: 1
          maxLength: 500
          example: This product is the best product all over the world
        public_description:
          type: string
          description: Product description for customers.
          minLength: 1
          maxLength: 100
          example: That cool product that you have bought
        status:
          type: string
          description: |-
            Product status.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          enum:
            - disabled
            - active
          example: active
        created_at:
          type: string
          description: Datetime of the product creation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:12'
        updated_at:
          type: string
          description: Datetime of the product update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:13'
        term_length:
          type: integer
          description: |-
            Maximum number of billing cycles before subscription expiration and automatic cancellation with error code <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired" target="_blank">8.08</a>.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          example: 20
        payment_action:
          type: string
          description: Payment processing flow applied to the transaction.
          enum:
            - auth_settle
          example: auth_settle
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.

            <blockquote>
              <ul>
                <li>If the product has a trial, this field does not affect the first payments but influences recurring ones processed with <code>auth_settle</code>.</li>
                <li>If there is no trial, this field defines the interval for the first <code>auth_settle</code> payment.</li>
              </ul>
            </blockquote>
          minimum: 0
          maximum: 168
          example: 48
        billing_period:
          type: object
          description: <a href="https://docs.solidgate.com/billing/subscription-overview/#billing-period" target="_blank">Billing period</a> in time units.
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Unit of the billing period.
              enum:
                - day
                - week
                - month
                - year
              example: day
            value:
              type: integer
              description: Value of the billing period as an integer.
              minimum: 1
              maximum: 730
              example: 10
        trial:
          type: object
          description: |-
            Trial settings. 

            <blockquote style="border-left: 4px solid #F2C4C4;">
              <p><strong>Required</strong> if the trial type is free or paid. Must not be sent if the type is absent.</p>
              <p>Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed.</p>
            </blockquote>
          required:
            - billing_period
            - payment_action
          properties:
            billing_period:
              type: object
              description: Trial billing period in time units.
              required:
                - unit
                - value
              properties:
                unit:
                  type: string
                  description: Unit of the trial billing period.
                  enum:
                    - day
                    - week
                    - month
                    - year
                  example: day
                value:
                  type: integer
                  description: Value of the trial billing period as an integer.
                  minimum: 1
                  maximum: 730
                  example: 10
            payment_action:
              type: string
              description: |-
                Specifies a <a href="https://docs.solidgate.com/payments/payments-overview/" target="_blank">payment flow</a> applied to the first transaction, with or without the next money return, for:
                - **free trial** - the payment actions are `auth_0_amount` and `auth_void`, with the last indicating that the funds will be refunded to the customer
                - **paid trial** - the payment action is `auth_settle`, indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account
              enum:
                - auth_0_amount
                - auth_void
                - auth_settle
              example: auth_settle
            settle_interval:
              type: integer
              description: |-
                Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours used in the `auth_settle` payment flow.

                <blockquote style="border-left: 4px solid #F2C4C4;">
                  <p><strong>Required</strong> if trial <code>payment_action</code> <code>auth_settle</code> and must not be used for other <code>payment_action</code> types.</p>
                </blockquote>
              minimum: 0
              maximum: 168
              example: 48
        retry_mode:
          type: string
          description: <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/" target="_blank">Retry mode</a> to recover the failed subscription payments.
          enum:
            - smart
            - static
          example: static
        retry_strategy_id:
          type: string
          description: Unique <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a> identifier.
          format: uuid
          example: db43b415-5522-4373-b026-a365462f9439
        tax:
          type: object
          description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
          required:
            - category_id
          properties:
            category_id:
              type: string
              description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
              minLength: 1
              maxLength: 50
              example: taxc_01JJVD231C879QBHVTVCWJ1K2A
            behavior:
              type: string
              description: |-
                Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                <blockquote>
                  <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                </blockquote>
              enum:
                - location_preset
                - included
                - excluded
              example: included
        metadata:
          type: object
          description: |-
            Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

            <blockquote>
              <p>Supports up to 50 key-value pairs:</p>
              <ul>
                <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                <li>Values can be up to 500 characters</li>
              </ul>
            </blockquote>
          additionalProperties:
            type: string
            maxLength: 500
          maxProperties: 50
          example:
            access_duration: 30d
            plan_tier: premium
      required:
        - id
        - name
        - type
        - description
        - status
        - created_at
        - updated_at
        - payment_action
        - billing_period
    ResponseBillingUnprocessableEntityError:
      type: object
      properties:
        error:
          required:
            - code
            - message
          type: object
          description: Error object.
          properties:
            code:
              type: string
              description: Error code indicating that while the request is well-formed, it cannot be processed due to conflicting or incorrect data.
              example: '2.01'
            message:
              type: string
              description: Descriptive message providing more details about the processing failure.
              example: Unprocessable entity
      required:
        - error
    ResponseBillingProductGetByIdOneTime:
      title: Product-based payment
      description: Product data.
      type: object
      properties:
        id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
          example: ac43b415-5522-4373-b026-a365462f9657
        name:
          type: string
          description: Product name.
          minLength: 1
          maxLength: 500
          example: Luxury product
        type:
          type: string
          description: Specifies whether the <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> is a one-time purchase or a subscription product.
          enum:
            - one-time
          example: one-time
        description:
          type: string
          description: Product description.
          minLength: 1
          maxLength: 500
          example: This product is the best product all over the world
        public_description:
          type: string
          description: Product description for customers.
          minLength: 1
          maxLength: 100
          example: That cool product that you have bought
        status:
          type: string
          description: |-
            Product status.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          enum:
            - active
            - disabled
            - archived
          example: active
        created_at:
          type: string
          description: Datetime of the product creation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:12'
        updated_at:
          type: string
          description: Datetime of the product update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:13'
        payment_action:
          type: string
          description: Payment processing flow applied to the transaction.
          enum:
            - auth_settle
          example: auth_settle
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.

            <blockquote>
              <ul>
                <li>If the product has a trial, this field does not affect the first payments but influences recurring ones processed with <code>auth_settle</code>.</li>
                <li>If there is no trial, this field defines the interval for the first <code>auth_settle</code> payment.</li>
              </ul>
            </blockquote>
          minimum: 0
          maximum: 168
          example: 48
        tax:
          type: object
          description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
          required:
            - category_id
          properties:
            category_id:
              type: string
              description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
              minLength: 1
              maxLength: 50
              example: taxc_01JJVD231C879QBHVTVCWJ1K2A
            behavior:
              type: string
              description: |-
                Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                <blockquote>
                  <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                </blockquote>
              enum:
                - location_preset
                - included
                - excluded
              example: included
        metadata:
          type: object
          description: |-
            Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

            <blockquote>
              <p>Supports up to 50 key-value pairs:</p>
              <ul>
                <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                <li>Values can be up to 500 characters</li>
              </ul>
            </blockquote>
          additionalProperties:
            type: string
            maxLength: 500
          maxProperties: 50
          example:
            access_duration: 30d
            plan_tier: premium
      required:
        - id
        - name
        - type
        - description
        - status
        - created_at
        - updated_at
        - payment_action
    ResponseBillingProductGetByIdSubscription:
      title: Subscription payment
      description: Product data.
      type: object
      properties:
        id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
          example: ac43b415-5522-4373-b026-a365462f9657
        name:
          type: string
          description: Product name.
          minLength: 1
          maxLength: 500
          example: Luxury product
        type:
          type: string
          description: Specifies whether the <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> is a one-time purchase or a subscription product.
          enum:
            - recurring
          example: recurring
        description:
          type: string
          description: Product description.
          minLength: 1
          maxLength: 500
          example: This product is the best product all over the world
        public_description:
          type: string
          description: Product description for customers.
          minLength: 1
          maxLength: 100
          example: That cool product that you have bought
        status:
          type: string
          description: |-
            Product status.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          enum:
            - active
            - disabled
            - archived
          example: active
        created_at:
          type: string
          description: Datetime of the product creation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:12'
        updated_at:
          type: string
          description: Datetime of the product update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:13'
        term_length:
          type: integer
          description: |-
            Maximum number of billing cycles before subscription expiration and automatic cancellation with error code <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired" target="_blank">8.08</a>.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          example: 20
        payment_action:
          type: string
          description: Payment processing flow applied to the transaction.
          enum:
            - auth_settle
          example: auth_settle
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.

            <blockquote>
              <ul>
                <li>If the product has a trial, this field does not affect the first payments but influences recurring ones processed with <code>auth_settle</code>.</li>
                <li>If there is no trial, this field defines the interval for the first <code>auth_settle</code> payment.</li>
              </ul>
            </blockquote>
          minimum: 0
          maximum: 168
          example: 48
        billing_period:
          type: object
          description: <a href="https://docs.solidgate.com/billing/subscription-overview/#billing-period" target="_blank">Billing period</a> in time units.
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Unit of the billing period.
              enum:
                - day
                - week
                - month
                - year
              example: day
            value:
              type: integer
              description: Value of the billing period as an integer.
              minimum: 1
              maximum: 730
              example: 10
        trial:
          type: object
          description: |-
            Trial settings. 

            <blockquote style="border-left: 4px solid #F2C4C4;">
              <p><strong>Required</strong> if the trial type is free or paid. Must not be sent if the type is absent.</p>
              <p>Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed.</p>
            </blockquote>
          required:
            - billing_period
            - payment_action
          properties:
            billing_period:
              type: object
              description: Trial billing period in time units.
              required:
                - unit
                - value
              properties:
                unit:
                  type: string
                  description: Unit of the trial billing period.
                  enum:
                    - day
                    - week
                    - month
                    - year
                  example: day
                value:
                  type: integer
                  description: Value of the trial billing period as an integer.
                  minimum: 1
                  maximum: 730
                  example: 10
            payment_action:
              type: string
              description: |-
                Specifies a <a href="https://docs.solidgate.com/payments/payments-overview/" target="_blank">payment flow</a> applied to the first transaction, with or without the next money return, for:
                - **free trial** - the payment actions are `auth_0_amount` and `auth_void`, with the last indicating that the funds will be refunded to the customer
                - **paid trial** - the payment action is `auth_settle`, indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account
              enum:
                - auth_0_amount
                - auth_void
                - auth_settle
              example: auth_settle
            settle_interval:
              type: integer
              description: |-
                Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours used in the `auth_settle` payment flow.

                <blockquote style="border-left: 4px solid #F2C4C4;">
                  <p><strong>Required</strong> if trial <code>payment_action</code> <code>auth_settle</code> and must not be used for other <code>payment_action</code> types.</p>
                </blockquote>
              minimum: 0
              maximum: 168
              example: 48
        retry_mode:
          type: string
          description: <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/" target="_blank">Retry mode</a> to recover the failed subscription payments.
          enum:
            - smart
            - static
          example: static
        retry_strategy_id:
          type: string
          description: Unique <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a> identifier.
          format: uuid
          example: db43b415-5522-4373-b026-a365462f9439
        tax:
          type: object
          description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
          required:
            - category_id
          properties:
            category_id:
              type: string
              description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
              minLength: 1
              maxLength: 50
              example: taxc_01JJVD231C879QBHVTVCWJ1K2A
            behavior:
              type: string
              description: |-
                Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                <blockquote>
                  <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                </blockquote>
              enum:
                - location_preset
                - included
                - excluded
              example: included
        metadata:
          type: object
          description: |-
            Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

            <blockquote>
              <p>Supports up to 50 key-value pairs:</p>
              <ul>
                <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                <li>Values can be up to 500 characters</li>
              </ul>
            </blockquote>
          additionalProperties:
            type: string
            maxLength: 500
          maxProperties: 50
          example:
            access_duration: 30d
            plan_tier: premium
      required:
        - id
        - name
        - type
        - description
        - status
        - created_at
        - updated_at
        - payment_action
        - billing_period
    ResponseBillingEntityNotFound:
      title: Entity not found
      type: object
      properties:
        error:
          type: object
          description: Error object.
          properties:
            code:
              type: string
              description: Error code.
              example: '2.01'
            message:
              type: string
              description: Error message.
              example: '{entityName} not found with id: {entityId}'
          required:
            - code
            - message
      required:
        - error
    RequestBillingProductUpdateOneTime:
      title: Product-based payment
      description: Product data.
      type: object
      properties:
        name:
          type: string
          description: Product name.
          minLength: 1
          maxLength: 500
          example: Luxury product
        description:
          type: string
          description: Product description.
          minLength: 1
          maxLength: 500
          example: This product is the best product all over the world
        public_description:
          type: string
          description: |-
            Product description for customers.

            <blockquote style="border-left: 4px solid #F2E7C4;">
              <p><strong>Highly recommended</strong> to provide as it is sent to banks, shown in customer bank statements, and included in Solidgate <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/" target="_blank">email receipts</a>, helping customers identify who charged them and for what.</p>
            </blockquote>
            <blockquote>
              <p>To remove the existing public description, send <code>null</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 100
          example: That cool product which you have bought
        status:
          type: string
          description: Product status.
          enum:
            - disabled
            - active
          example: active
        payment_action:
          type: string
          description: Payment processing flow applied to the transaction.
          enum:
            - auth_settle
          example: auth_settle
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.

            <blockquote style="border-left: 4px solid #F2E7C4; ">
              <p><b>Highly recommended</b> to check validation for <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">PSP limits</a>.</p>
            </blockquote>
          minimum: 0
          maximum: 168
          example: 48
        tax:
          type: object
          description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
          required:
            - category_id
          properties:
            category_id:
              type: string
              description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
              minLength: 1
              maxLength: 50
              example: taxc_01JJVD231C879QBHVTVCWJ1K2A
            behavior:
              type: string
              description: |-
                Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                <blockquote>
                  <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                </blockquote>
              enum:
                - location_preset
                - included
                - excluded
              example: included
        metadata:
          type: object
          nullable: true
          description: |-
            Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

            <blockquote>
              <p>Supports up to 50 key-value pairs:</p>
              <ul>
                <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                <li>Values can be up to 500 characters</li>
              </ul>
            </blockquote>
            <blockquote>
              <p>To remove all existing metadata, send <code>null</code>.</p>
            </blockquote>
          additionalProperties:
            type: string
            maxLength: 500
          maxProperties: 50
          example:
            access_duration: 30d
            plan_tier: premium
    RequestBillingProductUpdateSubscription:
      title: Subscription payment
      description: Product data.
      type: object
      properties:
        name:
          type: string
          description: Product name.
          minLength: 1
          maxLength: 500
          example: Luxury product
        description:
          type: string
          description: Product description.
          minLength: 1
          maxLength: 500
          example: This product is the best product all over the world
        public_description:
          type: string
          description: |-
            Product description for customers.

            <blockquote style="border-left: 4px solid #F2E7C4;">
              <p><strong>Highly recommended</strong> to provide as it is sent to banks, shown in customer bank statements, and included in Solidgate <a href="https://docs.solidgate.com/payments/payments-insights/email-receipts/" target="_blank">email receipts</a>, helping customers identify who charged them and for what.</p>
            </blockquote>
            <blockquote>
              <p>To remove the existing public description, send <code>null</code>.</p>
            </blockquote>
          minLength: 1
          maxLength: 100
          example: That cool product which you have bought
        status:
          type: string
          description: |-
            Product status.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          enum:
            - disabled
            - active
          example: active
        term_length:
          type: integer
          description: |-
            Maximum number of billing cycles before subscription expiration and automatic cancellation with error code <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired" target="_blank">8.08</a>.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          example: 20
        payment_action:
          type: string
          description: Payment processing flow applied to the transaction.
          enum:
            - auth_settle
          example: auth_settle
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.

            <blockquote>
              <ul>
                <li>If the product has a trial, this field does not affect the first payments but influences recurring ones processed with <code>auth_settle</code>.</li>
                <li>If there is no trial, this field defines the interval for the first <code>auth_settle</code> payment.</li>
              </ul>
            </blockquote>
          minimum: 0
          maximum: 168
          example: 48
        billing_period:
          type: object
          description: |-
            <a href="https://docs.solidgate.com/billing/subscription-overview/#billing-period" target="_blank">Billing period</a> in time units, with a maximum value equivalent to 2 years.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Unit of the billing period.
              enum:
                - day
                - week
                - month
                - year
              example: day
            value:
              type: integer
              description: |-
                Value of the billing period as an integer.

                <blockquote>
                  <p>Maximum value must not exceed 730 days, 104 weeks, 24 months, or 2 years.</p>
                </blockquote>
              minimum: 1
              maximum: 730
              example: 10
        trial:
          type: object
          description: |-
            Trial period settings, applicable for products offering free or paid trials.

            <blockquote>
              <p>Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed.</p>
            </blockquote>
          required:
            - billing_period
            - payment_action
          properties:
            billing_period:
              type: object
              description: Trial billing period in time units, with a maximum value equivalent to 2 years.
              required:
                - unit
                - value
              properties:
                unit:
                  type: string
                  description: Unit of the trial billing period.
                  enum:
                    - day
                    - week
                    - month
                    - year
                  example: day
                value:
                  type: integer
                  description: |-
                    Value of the trial billing period as an integer.

                    <blockquote>
                      <p>Maximum value must not exceed 730 days, 104 weeks, 24 months, or 2 years.</p>
                    </blockquote>
                  minimum: 1
                  maximum: 730
                  example: 10
            payment_action:
              type: string
              description: |-
                Specifies a <a href="https://docs.solidgate.com/payments/payments-overview/" target="_blank">payment flow</a> applied to the first transaction, with or without the next money return, for:
                - **free trial** - the payment actions are `auth_0_amount` and `auth_void`, with the last indicating that the funds will be refunded to the customer
                - **paid trial** - the payment action is `auth_settle`, indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account
              enum:
                - auth_0_amount
                - auth_void
                - auth_settle
              example: auth_settle
            settle_interval:
              type: integer
              description: |-
                Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours used in the `auth_settle` payment flow.

                <blockquote style="border-left: 4px solid #F2C4C4;">
                  <p><strong>Required</strong> if trial <code>payment_action</code> <code>auth_settle</code> and must not be used for other <code>payment_action</code> types.</p>
                </blockquote>
              minimum: 0
              maximum: 168
              example: 48
        retry_mode:
          type: string
          description: <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/" target="_blank">Retry mode</a> to recover the failed subscription payments.
          enum:
            - smart
            - static
          example: static
        retry_strategy_id:
          type: string
          description: |-
            Unique <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a> identifier.

            <blockquote>
              <p>Pass it for the <code>static</code> retry mode.</p>
            </blockquote>
          format: uuid
          example: db43b415-5522-4373-b026-a365462f9439
        tax:
          type: object
          description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
          required:
            - category_id
          properties:
            category_id:
              type: string
              description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
              minLength: 1
              maxLength: 50
              example: taxc_01JJVD231C879QBHVTVCWJ1K2A
            behavior:
              type: string
              description: |-
                Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                <blockquote>
                  <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                </blockquote>
              enum:
                - location_preset
                - included
                - excluded
              example: included
        metadata:
          type: object
          nullable: true
          description: |-
            Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

            <blockquote>
              <p>Supports up to 50 key-value pairs:</p>
              <ul>
                <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                <li>Values can be up to 500 characters</li>
              </ul>
            </blockquote>
            <blockquote>
              <p>To remove all existing metadata, send <code>null</code>.</p>
            </blockquote>
          additionalProperties:
            type: string
            maxLength: 500
          maxProperties: 50
          example:
            access_duration: 30d
            plan_tier: premium
    ResponseBillingProductUpdateOneTime:
      title: Product-based payment
      description: Product data.
      type: object
      properties:
        id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for one-time purchases, such as upsells or single-use services.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
          example: ac43b415-5522-4373-b026-a365462f9657
        name:
          type: string
          description: Product name.
          minLength: 1
          maxLength: 500
          example: Luxury product
        type:
          type: string
          description: Specifies whether the <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> is a one-time purchase or a subscription product.
          enum:
            - one-time
          example: one-time
        description:
          type: string
          description: Product description.
          minLength: 1
          maxLength: 500
          example: This product is the best product all over the world
        public_description:
          type: string
          description: Product description for customers.
          minLength: 1
          maxLength: 100
          example: That cool product that you have bought
        status:
          type: string
          description: |-
            Product status.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          enum:
            - disabled
            - active
          example: active
        created_at:
          type: string
          description: Datetime of the product creation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:12'
        updated_at:
          type: string
          description: Datetime of the product update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:13'
        payment_action:
          type: string
          description: Payment processing flow applied to the transaction.
          enum:
            - auth_settle
          example: auth_settle
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.

            <blockquote>
              <ul>
                <li>If the product has a trial, this field does not affect the first payments but influences recurring ones processed with <code>auth_settle</code>.</li>
                <li>If there is no trial, this field defines the interval for the first <code>auth_settle</code> payment.</li>
              </ul>
            </blockquote>
          minimum: 0
          maximum: 168
          example: 48
        tax:
          type: object
          description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
          required:
            - category_id
          properties:
            category_id:
              type: string
              description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
              minLength: 1
              maxLength: 50
              example: taxc_01JJVD231C879QBHVTVCWJ1K2A
            behavior:
              type: string
              description: |-
                Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                <blockquote>
                  <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                </blockquote>
              enum:
                - location_preset
                - included
                - excluded
              example: included
        metadata:
          type: object
          description: |-
            Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

            <blockquote>
              <p>Supports up to 50 key-value pairs:</p>
              <ul>
                <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                <li>Values can be up to 500 characters</li>
              </ul>
            </blockquote>
          additionalProperties:
            type: string
            maxLength: 500
          maxProperties: 50
          example:
            access_duration: 30d
            plan_tier: premium
      required:
        - id
        - name
        - type
        - description
        - status
        - created_at
        - updated_at
        - payment_action
    ResponseBillingProductUpdateSubscription:
      title: Subscription payment
      description: Product data.
      type: object
      properties:
        id:
          type: string
          description: |-
            Unique product identifier.

            <blockquote>
              <p><a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> used for recurring purchases, such as services with ongoing access or a subscription-based model.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
          example: ac43b415-5522-4373-b026-a365462f9657
        name:
          type: string
          description: Product name.
          minLength: 1
          maxLength: 500
          example: Luxury product
        type:
          type: string
          description: Specifies whether the <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> is a one-time purchase or a subscription product.
          enum:
            - recurring
          example: recurring
        description:
          type: string
          description: Product description.
          minLength: 1
          maxLength: 500
          example: This product is the best product all over the world
        public_description:
          type: string
          description: Product description for customers.
          minLength: 1
          maxLength: 100
          example: That cool product that you have bought
        status:
          type: string
          description: |-
            Product status.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          enum:
            - disabled
            - active
          example: active
        created_at:
          type: string
          description: Datetime of the product creation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:12'
        updated_at:
          type: string
          description: Datetime of the product update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:13'
        term_length:
          type: integer
          description: |-
            Maximum number of billing cycles before subscription expiration and automatic cancellation with error code <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired" target="_blank">8.08</a>.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          example: 20
        payment_action:
          type: string
          description: Payment processing flow applied to the transaction.
          enum:
            - auth_settle
          example: auth_settle
        settle_interval:
          type: integer
          description: |-
            Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.

            <blockquote>
              <ul>
                <li>If the product has a trial, this field does not affect the first payments but influences recurring ones processed with <code>auth_settle</code>.</li>
                <li>If there is no trial, this field defines the interval for the first <code>auth_settle</code> payment.</li>
              </ul>
            </blockquote>
          minimum: 0
          maximum: 168
          example: 48
        billing_period:
          type: object
          description: <a href="https://docs.solidgate.com/billing/subscription-overview/#billing-period" target="_blank">Billing period</a> in time units.
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Unit of the billing period.
              enum:
                - day
                - week
                - month
                - year
              example: day
            value:
              type: integer
              description: Value of the billing period as an integer.
              minimum: 1
              maximum: 730
              example: 10
        trial:
          type: object
          description: |-
            Trial settings. 

            <blockquote style="border-left: 4px solid #F2C4C4;">
              <p><strong>Required</strong> if the trial type is free or paid. Must not be sent if the type is absent.</p>
              <p>Once the product subscription is active, trial settings can be modified, but the trial itself cannot be added or removed.</p>
            </blockquote>
          required:
            - billing_period
            - payment_action
          properties:
            billing_period:
              type: object
              description: Trial billing period in time units.
              required:
                - unit
                - value
              properties:
                unit:
                  type: string
                  description: Unit of the trial billing period.
                  enum:
                    - day
                    - week
                    - month
                    - year
                  example: day
                value:
                  type: integer
                  description: Value of the trial billing period as an integer.
                  minimum: 1
                  maximum: 730
                  example: 10
            payment_action:
              type: string
              description: |-
                Specifies a <a href="https://docs.solidgate.com/payments/payments-overview/" target="_blank">payment flow</a> applied to the first transaction, with or without the next money return, for:
                - **free trial** - the payment actions are `auth_0_amount` and `auth_void`, with the last indicating that the funds will be refunded to the customer
                - **paid trial** - the payment action is `auth_settle`, indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account
              enum:
                - auth_0_amount
                - auth_void
                - auth_settle
              example: auth_settle
            settle_interval:
              type: integer
              description: |-
                Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours used in the `auth_settle` payment flow.

                <blockquote style="border-left: 4px solid #F2C4C4;">
                  <p><strong>Required</strong> if trial <code>payment_action</code> <code>auth_settle</code> and must not be used for other <code>payment_action</code> types.</p>
                </blockquote>
              minimum: 0
              maximum: 168
              example: 48
        retry_mode:
          type: string
          description: <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/" target="_blank">Retry mode</a> to recover the failed subscription payments.
          enum:
            - smart
            - static
          example: static
        retry_strategy_id:
          type: string
          description: Unique <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a> identifier.
          format: uuid
          example: db43b415-5522-4373-b026-a365462f9439
        tax:
          type: object
          description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
          required:
            - category_id
          properties:
            category_id:
              type: string
              description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
              minLength: 1
              maxLength: 50
              example: taxc_01JJVD231C879QBHVTVCWJ1K2A
            behavior:
              type: string
              description: |-
                Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                <blockquote>
                  <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                </blockquote>
              enum:
                - location_preset
                - included
                - excluded
              example: included
        metadata:
          type: object
          description: |-
            Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

            <blockquote>
              <p>Supports up to 50 key-value pairs:</p>
              <ul>
                <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                <li>Values can be up to 500 characters</li>
              </ul>
            </blockquote>
          additionalProperties:
            type: string
            maxLength: 500
          maxProperties: 50
          example:
            access_duration: 30d
            plan_tier: premium
      required:
        - id
        - name
        - type
        - description
        - status
        - created_at
        - updated_at
        - payment_action
        - billing_period
    ResponseBillingProductArchiveOneTime:
      title: Product-based payment
      description: Product data.
      type: object
      properties:
        id:
          type: string
          description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
          format: uuid
          maxLength: 36
          minLength: 36
          example: ac43b415-5522-4373-b026-a365462f9657
        name:
          type: string
          description: Product name.
          minLength: 1
          maxLength: 500
          example: Luxury product
        type:
          type: string
          description: Specifies whether the <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> is a one-time purchase or a subscription product.
          enum:
            - one-time
          example: one-time
        description:
          type: string
          description: Product description.
          minLength: 1
          maxLength: 500
          example: This product is the best product all over the world
        public_description:
          type: string
          description: Product description for customers.
          minLength: 1
          maxLength: 100
          example: That cool product that you have bought
        status:
          type: string
          description: Product status.
          enum:
            - archived
          example: archived
        created_at:
          type: string
          description: Datetime of the product creation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:12'
        updated_at:
          type: string
          description: Datetime of the product update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:13'
        payment_action:
          type: string
          description: Payment processing flow applied to the transaction.
          enum:
            - auth_settle
          example: auth_settle
        settle_interval:
          type: integer
          description: Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
          minimum: 0
          maximum: 168
          example: 48
        tax:
          type: object
          description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
          required:
            - category_id
          properties:
            category_id:
              type: string
              description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
              minLength: 1
              maxLength: 50
              example: taxc_01JJVD231C879QBHVTVCWJ1K2A
            behavior:
              type: string
              description: |-
                Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                <blockquote>
                  <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                </blockquote>
              enum:
                - location_preset
                - included
                - excluded
              example: included
        metadata:
          type: object
          description: |-
            Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

            <blockquote>
              <p>Supports up to 50 key-value pairs:</p>
              <ul>
                <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                <li>Values can be up to 500 characters</li>
              </ul>
            </blockquote>
          additionalProperties:
            type: string
            maxLength: 500
          maxProperties: 50
          example:
            access_duration: 30d
            plan_tier: premium
      required:
        - id
        - name
        - type
        - description
        - status
        - created_at
        - updated_at
        - payment_action
    ResponseBillingProductArchiveSubscription:
      title: Subscription payment
      description: Product data.
      type: object
      properties:
        id:
          type: string
          description: Unique product identifier.
          format: uuid
          maxLength: 36
          minLength: 36
          example: ac43b415-5522-4373-b026-a365462f9657
        name:
          type: string
          description: Product name.
          minLength: 1
          maxLength: 500
          example: Luxury product
        type:
          type: string
          description: Specifies whether the <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> is a one-time purchase or a subscription product.
          enum:
            - recurring
          example: recurring
        description:
          type: string
          description: Product description.
          minLength: 1
          maxLength: 500
          example: This product is the best product all over the world
        public_description:
          type: string
          description: Product description for customers.
          minLength: 1
          maxLength: 100
          example: That cool product that you have bought
        status:
          type: string
          description: Product status.
          enum:
            - archived
          example: archived
        created_at:
          type: string
          description: Datetime of the product creation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:12'
        updated_at:
          type: string
          description: Datetime of the product update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:13'
        term_length:
          type: integer
          description: Maximum number of billing cycles before subscription expiration and automatic cancellation with error code <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/#808-subscription-has-expired" target="_blank">8.08</a>.
          example: 20
        payment_action:
          type: string
          description: Payment processing flow applied to the transaction.
          enum:
            - auth_settle
          example: auth_settle
        settle_interval:
          type: integer
          description: Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours.
          minimum: 0
          maximum: 168
          example: 48
        billing_period:
          type: object
          description: <a href="https://docs.solidgate.com/billing/subscription-overview/#billing-period" target="_blank">Billing period</a> in time units.
          required:
            - unit
            - value
          properties:
            unit:
              type: string
              description: Unit of the billing period.
              enum:
                - day
                - week
                - month
                - year
              example: day
            value:
              type: integer
              description: Value of the billing period as an integer.
              minimum: 1
              maximum: 730
              example: 10
        trial:
          type: object
          description: Trial settings.
          required:
            - billing_period
            - payment_action
          properties:
            billing_period:
              type: object
              description: Trial billing period in time units.
              required:
                - unit
                - value
              properties:
                unit:
                  type: string
                  description: Unit of the trial billing period.
                  enum:
                    - day
                    - week
                    - month
                    - year
                  example: day
                value:
                  type: integer
                  description: Value of the trial billing period as an integer.
                  minimum: 1
                  maximum: 730
                  example: 10
            payment_action:
              type: string
              description: |-
                Specifies a <a href="https://docs.solidgate.com/payments/payments-overview/" target="_blank">payment flow</a> applied to the first transaction, with or without the next money return, for:
                - **free trial** - the payment actions are `auth_0_amount` and `auth_void`, with the last indicating that the funds will be refunded to the customer
                - **paid trial** - the payment action is `auth_settle`, indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account
              enum:
                - auth_0_amount
                - auth_void
                - auth_settle
              example: auth_settle
            settle_interval:
              type: integer
              description: Delay before automatic transaction <a href="https://docs.solidgate.com/payments/card-payments/auto-settle/#settlement-terms" target="_blank">settlement</a> in hours used in the `auth_settle` payment flow.
              minimum: 0
              maximum: 168
              example: 48
        retry_mode:
          type: string
          description: <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/" target="_blank">Retry mode</a> to recover the failed subscription payments.
          enum:
            - smart
            - static
          example: static
        retry_strategy_id:
          type: string
          description: Unique <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a> identifier.
          format: uuid
          example: db43b415-5522-4373-b026-a365462f9439
        tax:
          type: object
          description: Contains product <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/" target="_blank">tax</a> details.
          required:
            - category_id
          properties:
            category_id:
              type: string
              description: Unique tax <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#product-tax-categories" target="_blank">category</a> identifier.
              minLength: 1
              maxLength: 50
              example: taxc_01JJVD231C879QBHVTVCWJ1K2A
            behavior:
              type: string
              description: |-
                Defines how taxes are <a href="https://docs.solidgate.com/billing/taxes/manage-taxes/#configure-taxes" target="_blank">applied</a> to product prices and shown to customers.

                <blockquote>
                  <p><code>included</code> or <code>excluded</code> tax behavior takes priority over tax rules configured for locations.</p>
                </blockquote>
              enum:
                - location_preset
                - included
                - excluded
              example: included
        metadata:
          type: object
          description: |-
            Metadata for storing additional, structured information about the product, such as access duration, plan tier, or feature flags.

            <blockquote>
              <p>Supports up to 50 key-value pairs:</p>
              <ul>
                <li>Keys can be up to 40 characters (letters, digits, hyphens, and underscores)</li>
                <li>Values can be up to 500 characters</li>
              </ul>
            </blockquote>
          additionalProperties:
            type: string
            maxLength: 500
          maxProperties: 50
          example:
            access_duration: 30d
            plan_tier: premium
      required:
        - id
        - name
        - type
        - description
        - status
        - created_at
        - updated_at
        - payment_action
        - billing_period
    SchemaBillingPriceData:
      description: Contains price data items, each representing a specific price configuration.
      required:
        - id
        - default
        - status
        - created_at
        - updated_at
        - product_price
        - currency
      type: object
      properties:
        id:
          type: string
          description: Unique product price identifier.
          format: uuid
          example: cb43b415-5522-4373-b026-a365462f9114
        default:
          type: boolean
          description: Indicates whether the price is the default for the product.
          example: false
        status:
          type: string
          description: |-
            Product price status.

            <blockquote>
              <p>Cannot be changed if a subscription exists for the product.</p>
            </blockquote>
          enum:
            - active
            - disabled
          example: active
        created_at:
          type: string
          description: Datetime of the product price creation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:12'
        updated_at:
          type: string
          description: Datetime of the product price update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:13'
        product_price:
          type: integer
          description: Product price.
          minimum: 1
          maximum: 999999999
          example: 1000
        trial_price:
          type: integer
          description: Trial price.
          minimum: 1
          maximum: 999999999
          example: 500
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the product price currency.
          minLength: 3
          maxLength: 3
          example: USD
        country:
          type: string
          description: |-
            Country <a href="https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes" target="_blank">code</a>.

            <blockquote>
              <p>Not returned or expected for default prices.</p>
            </blockquote>
          format: iso_code_a3
          example: USA
          maxLength: 3
          minLength: 3
    ResponseBillingProductPriceCreateList:
      type: object
      properties:
        data:
          type: array
          description: Contains price data items, each representing a specific price configuration.
          items:
            $ref: '#/components/schemas/SchemaBillingPriceData'
        pagination:
          type: object
          description: Contains information about the pagination of the results.
          required:
            - offset
            - limit
            - total_count
          properties:
            offset:
              type: integer
              description: Starting index of the returned results.
              example: 20
            limit:
              type: integer
              description: Maximum number of items to return.
              example: 10
              maxLength: 100
            total_count:
              type: integer
              description: Total count of the products available.
              example: 150
    RequestBillingProductPriceCreate:
      description: Data for creating product price.
      properties:
        default:
          type: boolean
          description: Indicates whether the price is the default for the product.
          example: false
        status:
          type: string
          description: Product price status.
          enum:
            - disabled
            - active
          example: active
        product_price:
          type: integer
          description: Product price.
          minimum: 1
          maximum: 999999999
          example: 1000
        trial_price:
          type: integer
          description: Trial price.
          minimum: 1
          maximum: 999999999
          example: 500
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the product price currency.
          minLength: 3
          maxLength: 3
          example: USD
        country:
          type: string
          description: |-
            Country <a href="https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes" target="_blank">code</a>.

            <blockquote>
              <p>Not returned or expected for default prices.</p>
            </blockquote>
          format: iso_code_a3
          example: USA
          maxLength: 3
          minLength: 3
      required:
        - status
        - product_price
        - currency
        - default
    ResponseBillingProductPriceCreate:
      description: Data for creating product price.
      type: object
      properties:
        id:
          type: string
          description: Unique product price identifier.
          format: uuid
          example: cb43b415-5522-4373-b026-a365462f9114
        default:
          type: boolean
          description: Indicates whether the price is the default for the product.
          example: false
        status:
          type: string
          description: Product price status.
          enum:
            - disabled
            - active
          example: active
        created_at:
          type: string
          description: Datetime of the product price creation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:12'
        updated_at:
          type: string
          description: Datetime of the product price update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:13'
        product_price:
          type: integer
          description: Product price.
          minimum: 1
          maximum: 999999999
          example: 1000
        trial_price:
          type: integer
          description: Trial price.
          minimum: 1
          maximum: 999999999
          example: 500
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the product price currency.
          minLength: 3
          maxLength: 3
          example: USD
        country:
          type: string
          description: |-
            Country <a href="https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes" target="_blank">code</a>.

            <blockquote>
              <p>Not returned or expected for default prices.</p>
            </blockquote>
          format: iso_code_a3
          example: USA
          maxLength: 3
          minLength: 3
      required:
        - id
        - default
        - status
        - created_at
        - updated_at
        - product_price
        - currency
    RequestBillingRetrievePrices:
      type: object
      properties:
        filters:
          type: object
          description: Filter criteria for retrieving prices.
          properties:
            default:
              type: object
              description: Specify if to retrieve default prices.
              properties:
                operator:
                  type: string
                  enum:
                    - eq
                  description: Specify operator for filtering default prices.
                  example: eq
                value:
                  type: string
                  description: Set to true to retrieve default prices.
                  enum:
                    - 'true'
                    - 'false'
                  example: 'true'
            updated_at:
              type: object
              description: Filter by update timestamp for incremental synchronization.
              properties:
                operator:
                  type: string
                  enum:
                    - gte
                  description: Comparison operator for the timestamp.
                  example: gte
                value:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Timestamp to filter prices.
                  example: '2025-12-15 10:40:25'
        pagination:
          type: object
          description: Pagination settings for retrieving prices.
          properties:
            page_size:
              type: integer
              description: Page size based on the set or default value.
              minimum: 1
              maximum: 100
              default: 10
              example: 100
            next_page_token:
              type: string
              description: Token for retrieving the next page of results. Obtained from the previous response. Omit this parameter for the first request.
              minLength: 1
              example: eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9
    ResponseBillingRetrievePrices:
      type: object
      properties:
        items:
          type: array
          description: Contains price data items, each representing a specific price configuration.
          items:
            $ref: '#/components/schemas/SchemaBillingPriceData'
        pagination:
          type: object
          description: Contains information about the pagination of the results.
          required:
            - page_size
          properties:
            page_size:
              type: integer
              description: Page size based on the set or default value.
              example: 100
            next_page_token:
              type: string
              description: Token to retrieve the next page of results. Use this value in the next request. Empty or null if no more pages are available.
              example: eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9
    RequestBillingProductPriceUpdate:
      type: object
      description: Data for updating product price.
      properties:
        status:
          type: string
          description: Product price status.
          enum:
            - disabled
            - active
          example: active
        product_price:
          type: integer
          description: Product price.
          minimum: 1
          maximum: 999999999
          example: 1000
        trial_price:
          type: integer
          description: Trial price.
          minimum: 1
          maximum: 999999999
          example: 500
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the product price currency.
          minLength: 3
          maxLength: 3
          example: USD
        country:
          type: string
          description: |-
            Country <a href="https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes" target="_blank">code</a>.

            <blockquote>
              <p>Not returned or expected for default prices.</p>
            </blockquote>
          format: iso_code_a3
          example: USA
          maxLength: 3
          minLength: 3
    ResponseBillingProductPriceUpdate:
      description: Data for creating product price.
      type: object
      properties:
        id:
          type: string
          description: Unique product price identifier.
          format: uuid
          example: cb43b415-5522-4373-b026-a365462f9114
        default:
          type: boolean
          description: Indicates whether the price is the default for the product.
          example: false
        status:
          type: string
          description: Product price status.
          enum:
            - disabled
            - active
          example: active
        created_at:
          type: string
          description: Datetime of the product price creation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:12'
        updated_at:
          type: string
          description: Datetime of the product price update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-05-31 12:53:13'
        product_price:
          type: integer
          description: Product price.
          minimum: 1
          maximum: 999999999
          example: 1000
        trial_price:
          type: integer
          description: Trial price.
          minimum: 1
          maximum: 999999999
          example: 500
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the product price currency.
          minLength: 3
          maxLength: 3
          example: USD
        country:
          type: string
          description: |-
            Country <a href="https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes" target="_blank">code</a>.

            <blockquote>
              <p>Not returned or expected for default prices.</p>
            </blockquote>
          format: iso_code_a3
          example: USA
          maxLength: 3
          minLength: 3
      required:
        - id
        - default
        - status
        - created_at
        - updated_at
        - product_price
        - currency
    ResponseBillingReportTaxTransactional:
      title: Success
      type: object
      properties:
        report_url:
          type: string
          description: URL for the report stored on Amazon S3, which needs to be downloaded.
          example: https://reports.solidgate.com/api/v1/tax/transactional/report/tax_transactional_250702_140728/download
    ResponseBillingReportTaxSummary:
      title: Success
      type: object
      properties:
        report_url:
          type: string
          description: URL for the report stored on Amazon S3, which needs to be downloaded.
          example: https://reports.solidgate.com/api/v1/tax/summary/report/tax_summary_250702_140728/download
    SchemaBillingProductPriceCalculateCountry:
      title: country
      properties:
        country:
          type: string
          description: Cardholder's <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> country code.
          format: iso_code_a3
          maxLength: 3
          minLength: 3
          example: USA
      required:
        - country
    SchemaBillingProductPriceCalculateIP:
      title: ip_address
      properties:
        ip_address:
          type: string
          description: Public IP address of the cardholder, both IPv4 and IPv6 are supported.
          format: ip
          maxLength: 50
          example: 127.0.0.1
      required:
        - ip_address
    RequestBillingProductPriceCalculate:
      title: RequestSubscriptionsProductPriceCalculate
      type: object
      properties:
        product_id:
          type: string
          description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
          format: uuid
          maxLength: 36
          minLength: 36
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the product price currency.
          minLength: 3
          maxLength: 3
          example: USD
        location:
          type: object
          description: Information about the cardholder's location, specified as either a country code or an IP address.
          oneOf:
            - $ref: '#/components/schemas/SchemaBillingProductPriceCalculateCountry'
            - $ref: '#/components/schemas/SchemaBillingProductPriceCalculateIP'
      required:
        - product_id
        - location
    ResponseBillingProductPriceCalculate:
      description: Result of the price calculation
      type: object
      properties:
        product_id:
          type: string
          description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
          minLength: 36
          maxLength: 36
          format: uuid
        price_id:
          type: string
          description: Unique product price identifier.
          maxLength: 36
          format: uuid
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the product price currency.
          minLength: 3
          maxLength: 3
        total_amount:
          type: integer
          description: Payment total amount.
        tax:
          type: object
          description: Information related to the tax calculation.
          properties:
            tax_amount:
              type: integer
              description: Amount of the tax calculated.
            taxable_amount:
              type: integer
              description: Taxable amount of the transaction before tax.
            location:
              type: string
              format: iso_code_a3
              description: Country code where the tax applies, specified using an <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> code.
            profile_id:
              type: string
              description: Tax profile identifier.
            rate_id:
              type: string
              description: Tax rate identifier.
            rate:
              type: number
              format: decimal
              description: Tax rate.
              multipleOf: 0.01
              maximum: 99.99
              minimum: 0.01
            is_included:
              type: boolean
              description: |-
                Indicates the tax type:

                - `true` - tax included
                - `false` - tax excluded
          required:
            - tax_amount
            - taxable_amount
            - location
            - profile_id
            - rate_id
            - rate
            - is_included
        recurring:
          type: object
          description: |-
            Recurring price breakdown.

            <blockquote style="border-left: 4px solid #F2C4C4;">
              <p><b>Required</b> for the <code>recurring</code> product type. It is not returned when the product type is <code>one_time</code>.</p>
            </blockquote>
          properties:
            total_amount:
              type: integer
              description: Payment total amount.
            tax:
              type: object
              description: Information related to the tax calculation.
              properties:
                tax_amount:
                  type: integer
                  description: Amount of the tax calculated.
                taxable_amount:
                  type: integer
                  description: Taxable amount of the transaction before tax.
                location:
                  type: string
                  format: iso_code_a3
                  description: Country code where the tax applies, specified using an <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> code.
                rate:
                  type: number
                  format: decimal
                  description: Tax rate.
                  multipleOf: 0.01
                  maximum: 99.99
                  minimum: 0.01
                is_included:
                  type: boolean
                  description: |-
                    Indicates the tax type:

                    - `true` - tax included
                    - `false` - tax excluded
              required:
                - tax_amount
                - taxable_amount
                - location
                - rate
                - is_included
          required:
            - total_amount
      required:
        - price_id
        - product_id
        - currency
        - total_amount
    RequestBillingSubscriptionUpdate:
      title: RequestSubscriptionUpdate
      type: object
      properties:
        id:
          type: string
          description: Unique subscription identifier.
          format: uuid
          maxLength: 36
          minLength: 36
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        product_id:
          type: string
          description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier to apply to the specified subscription.
          format: uuid
          maxLength: 36
          minLength: 36
          example: ac43b415-5522-4373-b026-a365462f9657
        trial_ended_at:
          type: object
          description: Datetime to end the subscription trial.
          required:
            - type
          properties:
            type:
              type: string
              enum:
                - specific_date
                - immediate
              description: |-
                Indicates how the trial should end.        
                - <code>immediate</code> - end trial immediately
                - <code>specific_date</code> - end trial at specific date
              example: immediate
            date:
              type: string
              description: |-
                Indicates the specific date when the trial should end.

                <blockquote style="border-left: 4px solid #F2C4C4;">
                  <p><strong>Required</strong> if the <code>type</code> is <code>specific_date</code>.</p>
                </blockquote>
                <blockquote>
                  <p>Trial end date must be within 1 year from the current date.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2026-07-20 13:20:00'
        discount:
          type: object
          description: |-
            Discount details to manage subscription pricing.

            <blockquote>
              <p>To remove an existing discount, send <code>null</code> for <code>discount</code>.</p>
            </blockquote>
          oneOf:
            - type: object
              title: coupon_id
              required:
                - coupon_id
              properties:
                coupon_id:
                  type: string
                  format: uuid
                  minLength: 36
                  maxLength: 36
                  description: Unique coupon identifier.
                  example: 379bd8d9-7f2a-44eb-be35-b741985e1b08
            - type: object
              title: coupon_code
              required:
                - coupon_code
              properties:
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code for customers to redeem.
                  example: PRIME50
        coupon_id:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
          description: |-
            Unique coupon identifier.

            <blockquote>
              <p>Pass either <code>coupon_id</code> or <code>coupon_code</code>, not both.</p>
            </blockquote>
          example: 379bd8d9-7f2a-44eb-be35-b741985e1b08
          deprecated: true
        coupon_code:
          type: string
          minLength: 2
          maxLength: 25
          description: |-
            Coupon code.

            <blockquote>
              <p>Pass either <code>coupon_id</code> or <code>coupon_code</code>, not both.</p>
            </blockquote>
          example: PRIME50
          deprecated: true
      required:
        - id
    SchemaBillingSubscriptionStatusPending:
      title: SubscriptionStatusPending
      type: object
      properties:
        id:
          type: string
          description: Unique subscription identifier.
          maxLength: 36
          format: uuid
          example: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
        status:
          type: string
          description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
          example: pending
        started_at:
          type: string
          description: Datetime of the subscription start.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:24'
        updated_at:
          type: string
          description: Datetime of the subscription update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:25'
        expired_at:
          type: string
          description: Datetime of the subscription expiration.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 12:37:24'
        payment_type:
          type: string
          description: Customer payment method used to pay for a subscription.
          enum:
            - card
            - paypal-vault
            - mercadopago
            - upi
            - pix
            - gcash
            - alipay
            - mbway
            - wechatpay
          example: card
        discount:
          type: object
          description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
          required:
            - created_at
            - coupon
          properties:
            created_at:
              type: string
              description: Datetime of the discount creation.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-05-31 12:53:12'
            coupon_code:
              type: string
              minLength: 2
              maxLength: 25
              description: Coupon code.
              example: SUMMER25OFF
            coupon:
              type: object
              description: Coupon details.
              required:
                - name
                - type
                - value
              properties:
                name:
                  type: string
                  description: Coupon name.
                  example: Summer 25% OFF
                description:
                  type: string
                  description: Coupon description.
                  example: 25% off for 3 months
                type:
                  type: string
                  description: Discount type indicating percentage or fixed amount off the price.
                  enum:
                    - percentage
                    - amount
                  example: percentage
                value:
                  type: integer
                  description: |-
                    Discount value.

                    <blockquote>
                      <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                    </blockquote>
                  example: 25
        trial:
          type: boolean
          description: Indicates whether the subscription has a trial.
          example: false
        trial_started_at:
          type: string
          description: Datetime of the subscription trial start.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:24'
        trial_ended_at:
          type: string
          description: Datetime of the subscription trial expiration.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:25'
        cancelled_at:
          type: string
          description: Datetime of subscription cancellation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 19:37:24'
        cancellation_requested_at:
          type: string
          description: Datetime of subscription cancellation request.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-11 19:37:24'
        cancel_code:
          type: string
          description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
          enum:
            - '8.01'
            - '8.02'
            - '8.03'
            - '8.04'
            - '8.05'
            - '8.06'
            - '8.07'
            - '8.08'
            - '8.09'
            - '8.10'
            - '8.11'
            - '8.12'
            - '8.13'
            - '8.14'
            - '8.15'
          example: '8.09'
        cancel_message:
          type: string
          description: Cancellation reason brief description.
          example: Cancellation after redemption period
        pause:
          type: object
          description: Pause schedule parameters.
          properties:
            from_date:
              type: string
              description: |-
                Datetime of the pause start.

                <blockquote>
                   <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-12-27 11:26:08'
            to_date:
              type: string
              description: |-
                Datetime of the pause end.

                <blockquote>
                  <p>It is absent when the subscription is planned to pause infinitely.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-12-27 11:26:08'
          required:
            - from_date
      required:
        - id
        - status
        - updated_at
        - trial
    SchemaBillingSubscriptionStatusActive:
      title: SubscriptionStatusActive
      type: object
      properties:
        id:
          type: string
          description: Unique subscription identifier.
          maxLength: 36
          format: uuid
          example: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
        status:
          type: string
          description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
          example: active
        started_at:
          type: string
          description: Datetime of the subscription start.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:24'
        updated_at:
          type: string
          description: Datetime of the subscription update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:25'
        expired_at:
          type: string
          description: Datetime of the subscription expiration.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 12:37:24'
        next_charge_at:
          type: string
          description: |-
            Datetime of the subsequent charge.

            <blockquote>
              <p>It is absent when the subscription is planned to pause infinitely.</p>
            </blockquote>
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 14:37:24'
        payment_type:
          type: string
          description: Customer payment method used to pay for a subscription.
          enum:
            - card
            - paypal-vault
            - mercadopago
            - upi
            - pix
            - gcash
            - alipay
            - mbway
            - wechatpay
          example: card
        discount:
          type: object
          description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
          required:
            - created_at
            - coupon
          properties:
            created_at:
              type: string
              description: Datetime of the discount creation.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-05-31 12:53:12'
            coupon_code:
              type: string
              minLength: 2
              maxLength: 25
              description: Coupon code.
              example: SUMMER25OFF
            coupon:
              type: object
              description: Coupon details.
              required:
                - name
                - type
                - value
              properties:
                name:
                  type: string
                  description: Coupon name.
                  example: Summer 25% OFF
                description:
                  type: string
                  description: Coupon description.
                  example: 25% off for 3 months
                type:
                  type: string
                  description: Discount type indicating percentage or fixed amount off the price.
                  enum:
                    - percentage
                    - amount
                  example: percentage
                value:
                  type: integer
                  description: |-
                    Discount value.

                    <blockquote>
                      <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                    </blockquote>
                  example: 25
        trial:
          type: boolean
          description: Indicates whether the subscription has a trial.
          example: false
        trial_started_at:
          type: string
          description: Datetime of the subscription trial start.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:24'
        trial_ended_at:
          type: string
          description: Datetime of the subscription trial expiration.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:25'
        cancelled_at:
          type: string
          description: Datetime of subscription cancellation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 19:37:24'
        cancellation_requested_at:
          type: string
          description: Datetime of subscription cancellation request.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-11 19:37:24'
        cancel_code:
          type: string
          description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
          enum:
            - '8.01'
            - '8.02'
            - '8.03'
            - '8.04'
            - '8.05'
            - '8.06'
            - '8.07'
            - '8.08'
            - '8.09'
            - '8.10'
            - '8.11'
            - '8.12'
            - '8.13'
            - '8.14'
            - '8.15'
          example: '8.09'
        cancel_message:
          type: string
          description: Cancellation reason brief description.
          example: Cancellation after redemption period
        pause:
          type: object
          description: Pause schedule parameters.
          properties:
            from_date:
              type: string
              description: |-
                Datetime of the pause start.

                <blockquote>
                   <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-27 11:26:08'
            to_date:
              type: string
              description: |-
                Datetime of the pause end.

                <blockquote>
                  <p>It is absent when the subscription is planned to pause infinitely.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-27 11:26:08'
          required:
            - from_date
      required:
        - id
        - updated_at
        - started_at
        - trial
        - payment_type
        - status
    SchemaBillingSubscriptionStatusCancelled:
      title: SubscriptionStatusCancelled
      type: object
      properties:
        id:
          type: string
          description: Unique subscription identifier.
          maxLength: 36
          format: uuid
          example: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
        status:
          type: string
          description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
          example: cancelled
        started_at:
          type: string
          description: Datetime of the subscription start.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:24'
        updated_at:
          type: string
          description: Datetime of the subscription update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:25'
        expired_at:
          type: string
          description: Datetime of the subscription expiration.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 12:37:24'
        payment_type:
          type: string
          description: Customer payment method used to pay for a subscription.
          enum:
            - card
            - paypal-vault
            - mercadopago
            - upi
            - pix
            - gcash
            - alipay
            - mbway
            - wechatpay
          example: card
        discount:
          type: object
          description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
          required:
            - created_at
            - coupon
          properties:
            created_at:
              type: string
              description: Datetime of the discount creation.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-05-31 12:53:12'
            coupon_code:
              type: string
              minLength: 2
              maxLength: 25
              description: Coupon code.
              example: SUMMER25OFF
            coupon:
              type: object
              description: Coupon details.
              required:
                - name
                - type
                - value
              properties:
                name:
                  type: string
                  description: Coupon name.
                  example: Summer 25% OFF
                description:
                  type: string
                  description: Coupon description.
                  example: 25% off for 3 months
                type:
                  type: string
                  description: Discount type indicating percentage or fixed amount off the price.
                  enum:
                    - percentage
                    - amount
                  example: percentage
                value:
                  type: integer
                  description: |-
                    Discount value.

                    <blockquote>
                      <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                    </blockquote>
                  example: 25
        trial:
          type: boolean
          description: Indicates whether the subscription has a trial.
          example: false
        trial_started_at:
          type: string
          description: Datetime of the subscription trial start.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:24'
        trial_ended_at:
          type: string
          description: Datetime of the subscription trial expiration.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:25'
        cancelled_at:
          type: string
          description: Datetime of subscription cancellation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 19:37:24'
        cancellation_requested_at:
          type: string
          description: Datetime of subscription cancellation request.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-11 19:37:24'
        cancel_code:
          type: string
          description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
          enum:
            - '8.01'
            - '8.02'
            - '8.03'
            - '8.04'
            - '8.05'
            - '8.06'
            - '8.07'
            - '8.08'
            - '8.09'
            - '8.10'
            - '8.11'
            - '8.12'
            - '8.13'
            - '8.14'
            - '8.15'
          example: '8.09'
        cancel_message:
          type: string
          description: Cancellation reason brief description.
          example: Cancellation after redemption period
        pause:
          type: object
          description: Pause schedule parameters.
          properties:
            from_date:
              type: string
              description: |-
                Datetime of the pause start.

                <blockquote>
                   <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-27 11:26:08'
            to_date:
              type: string
              description: |-
                Datetime of the pause end.

                <blockquote>
                  <p>It is absent when the subscription is planned to pause infinitely.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-27 11:26:08'
          required:
            - from_date
      required:
        - id
        - updated_at
        - started_at
        - trial
        - payment_type
        - status
    SchemaBillingSubscriptionStatusRedemption:
      title: SubscriptionStatusRedemption
      type: object
      properties:
        id:
          type: string
          description: Unique subscription identifier.
          maxLength: 36
          format: uuid
          example: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
        status:
          type: string
          description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
          example: redemption
        started_at:
          type: string
          description: Datetime of the subscription start.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:24'
        updated_at:
          type: string
          description: Datetime of the subscription update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:25'
        expired_at:
          type: string
          description: Datetime of the subscription expiration.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 12:37:24'
        next_charge_at:
          type: string
          description: |-
            Datetime of the subsequent charge.

            <blockquote>
              <p>It is absent when the subscription is planned to pause infinitely.</p>
            </blockquote>
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 14:37:24'
        payment_type:
          type: string
          description: Customer payment method used to pay for a subscription.
          enum:
            - card
            - paypal-vault
            - mercadopago
            - upi
            - pix
            - gcash
            - alipay
            - mbway
            - wechatpay
          example: card
        discount:
          type: object
          description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
          required:
            - created_at
            - coupon
          properties:
            created_at:
              type: string
              description: Datetime of the discount creation.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-05-31 12:53:12'
            coupon_code:
              type: string
              minLength: 2
              maxLength: 25
              description: Coupon code.
              example: SUMMER25OFF
            coupon:
              type: object
              description: Coupon details.
              required:
                - name
                - type
                - value
              properties:
                name:
                  type: string
                  description: Coupon name.
                  example: Summer 25% OFF
                description:
                  type: string
                  description: Coupon description.
                  example: 25% off for 3 months
                type:
                  type: string
                  description: Discount type indicating percentage or fixed amount off the price.
                  enum:
                    - percentage
                    - amount
                  example: percentage
                value:
                  type: integer
                  description: |-
                    Discount value.

                    <blockquote>
                      <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                    </blockquote>
                  example: 25
        trial:
          type: boolean
          description: Indicates whether the subscription has a trial.
          example: false
        trial_started_at:
          type: string
          description: Datetime of the subscription trial start.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:24'
        trial_ended_at:
          type: string
          description: Datetime of the subscription trial expiration.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:25'
        cancel_code:
          type: string
          description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
          enum:
            - '8.01'
            - '8.02'
            - '8.03'
            - '8.04'
            - '8.05'
            - '8.06'
            - '8.07'
            - '8.08'
            - '8.09'
            - '8.10'
            - '8.11'
            - '8.12'
            - '8.13'
            - '8.14'
            - '8.15'
          example: '8.09'
        cancel_message:
          type: string
          description: Cancellation reason brief description.
          example: Cancellation after redemption period
        pause:
          type: object
          description: Pause schedule parameters.
          properties:
            from_date:
              type: string
              description: |-
                Datetime of the pause start.

                <blockquote>
                   <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-27 11:26:08'
            to_date:
              type: string
              description: |-
                Datetime of the pause end.

                <blockquote>
                  <p>It is absent when the subscription is planned to pause infinitely.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-27 11:26:08'
          required:
            - from_date
      required:
        - id
        - updated_at
        - started_at
        - trial
        - payment_type
        - status
    SchemaBillingSubscriptionStatusPaused:
      title: SubscriptionStatusPaused
      type: object
      properties:
        id:
          type: string
          description: Unique subscription identifier.
          maxLength: 36
          format: uuid
          example: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
        status:
          type: string
          description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
          example: paused
        started_at:
          type: string
          description: Datetime of the subscription start.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:24'
        updated_at:
          type: string
          description: Datetime of the subscription update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:25'
        expired_at:
          type: string
          description: Datetime of the subscription expiration.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 12:37:24'
        next_charge_at:
          type: string
          description: |-
            Datetime of the subsequent charge.

            <blockquote>
              <p>It is absent when the subscription is planned to pause infinitely.</p>
            </blockquote>
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 14:37:24'
        payment_type:
          type: string
          description: Customer payment method used to pay for a subscription.
          enum:
            - card
            - paypal-vault
            - mercadopago
            - upi
            - pix
            - gcash
            - alipay
            - mbway
            - wechatpay
          example: card
        discount:
          type: object
          description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
          required:
            - created_at
            - coupon
          properties:
            created_at:
              type: string
              description: Datetime of the discount creation.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-05-31 12:53:12'
            coupon_code:
              type: string
              minLength: 2
              maxLength: 25
              description: Coupon code.
              example: SUMMER25OFF
            coupon:
              type: object
              description: Coupon details.
              required:
                - name
                - type
                - value
              properties:
                name:
                  type: string
                  description: Coupon name.
                  example: Summer 25% OFF
                description:
                  type: string
                  description: Coupon description.
                  example: 25% off for 3 months
                type:
                  type: string
                  description: Discount type indicating percentage or fixed amount off the price.
                  enum:
                    - percentage
                    - amount
                  example: percentage
                value:
                  type: integer
                  description: |-
                    Discount value.

                    <blockquote>
                      <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                    </blockquote>
                  example: 25
        trial:
          type: boolean
          description: Indicates whether the subscription has a trial.
          example: false
        trial_started_at:
          type: string
          description: Datetime of the subscription trial start.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:24'
        trial_ended_at:
          type: string
          description: Datetime of the subscription trial expiration.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:25'
        cancel_code:
          type: string
          description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
          enum:
            - '8.01'
            - '8.02'
            - '8.03'
            - '8.04'
            - '8.05'
            - '8.06'
            - '8.07'
            - '8.08'
            - '8.09'
            - '8.10'
            - '8.11'
            - '8.12'
            - '8.13'
            - '8.14'
            - '8.15'
          example: '8.09'
        cancel_message:
          type: string
          description: Cancellation reason brief description.
          example: Cancellation after redemption period
        pause:
          type: object
          description: Pause schedule parameters.
          properties:
            from_date:
              type: string
              description: |-
                Datetime of the pause start.

                <blockquote>
                   <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-27 11:26:08'
            to_date:
              type: string
              description: |-
                Datetime of the pause end.

                <blockquote>
                  <p>It is absent when the subscription is planned to pause infinitely.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-27 11:26:08'
          required:
            - from_date
      required:
        - id
        - updated_at
        - started_at
        - trial
        - payment_type
        - status
    SchemaBillingSubscriptionStatusExpired:
      title: SubscriptionStatusExpired
      type: object
      properties:
        id:
          type: string
          description: Unique subscription identifier.
          maxLength: 36
          format: uuid
          example: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
        status:
          type: string
          description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
          example: expired
        started_at:
          type: string
          description: Datetime of the subscription start.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:24'
        updated_at:
          type: string
          description: Datetime of the subscription update.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:25'
        expired_at:
          type: string
          description: Datetime of the subscription expiration.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 12:37:24'
        payment_type:
          type: string
          description: Customer payment method used to pay for a subscription.
          enum:
            - card
            - paypal-vault
            - mercadopago
            - upi
            - pix
            - gcash
            - alipay
            - mbway
            - wechatpay
          example: card
        discount:
          type: object
          description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
          required:
            - created_at
            - coupon
          properties:
            created_at:
              type: string
              description: Datetime of the discount creation.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-05-31 12:53:12'
            coupon_code:
              type: string
              minLength: 2
              maxLength: 25
              description: Coupon code.
              example: SUMMER25OFF
            coupon:
              type: object
              description: Coupon details.
              required:
                - name
                - type
                - value
              properties:
                name:
                  type: string
                  description: Coupon name.
                  example: Summer 25% OFF
                description:
                  type: string
                  description: Coupon description.
                  example: 25% off for 3 months
                type:
                  type: string
                  description: Discount type indicating percentage or fixed amount off the price.
                  enum:
                    - percentage
                    - amount
                  example: percentage
                value:
                  type: integer
                  description: |-
                    Discount value.

                    <blockquote>
                      <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                    </blockquote>
                  example: 25
        trial:
          type: boolean
          description: Indicates whether the subscription has a trial.
          example: false
        trial_started_at:
          type: string
          description: Datetime of the subscription trial start.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:24'
        trial_ended_at:
          type: string
          description: Datetime of the subscription trial expiration.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-08 12:37:25'
        cancelled_at:
          type: string
          description: Datetime of subscription cancellation.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-12 19:37:24'
        cancellation_requested_at:
          type: string
          description: Datetime of subscription cancellation request.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-12-11 19:37:24'
        cancel_code:
          type: string
          description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
          enum:
            - '8.01'
            - '8.02'
            - '8.03'
            - '8.04'
            - '8.05'
            - '8.06'
            - '8.07'
            - '8.08'
            - '8.09'
            - '8.10'
            - '8.11'
            - '8.12'
            - '8.13'
            - '8.14'
            - '8.15'
          example: '8.09'
        cancel_message:
          type: string
          description: Cancellation reason brief description.
          example: Cancellation after redemption period
        pause:
          type: object
          description: Pause schedule parameters.
          properties:
            from_date:
              type: string
              description: |-
                Datetime of the pause start.

                <blockquote>
                   <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-12-27 11:26:08'
            to_date:
              type: string
              description: |-
                Datetime of the pause end.

                <blockquote>
                  <p>It is absent when the subscription is planned to pause infinitely.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-12-27 11:26:08'
          required:
            - from_date
      required:
        - id
        - status
        - updated_at
        - trial
    ResponseBillingSubscriptionUpdate:
      title: ResponseSubscriptionUpdate
      type: object
      discriminator:
        propertyName: status
        mapping:
          pending: '#/components/schemas/SchemaBillingSubscriptionStatusPending'
          active: '#/components/schemas/SchemaBillingSubscriptionStatusActive'
          cancelled: '#/components/schemas/SchemaBillingSubscriptionStatusCancelled'
          redemption: '#/components/schemas/SchemaBillingSubscriptionStatusRedemption'
          paused: '#/components/schemas/SchemaBillingSubscriptionStatusPaused'
          expired: '#/components/schemas/SchemaBillingSubscriptionStatusExpired'
      example:
        id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
        status: active
        started_at: '2025-12-08 12:37:24'
        updated_at: '2025-12-08 12:37:25'
        expired_at: '2025-12-12 12:37:24'
        next_charge_at: '2025-12-12 14:37:24'
        payment_type: card
        trial: false
        trial_started_at: '2025-12-08 12:37:24'
        trial_ended_at: '2025-12-08 12:37:25'
        cancelled_at: '2025-12-12 19:37:24'
        cancellation_requested_at: '2025-12-11 19:37:24'
        cancel_code: '8.09'
        cancel_message: Cancellation after redemption period
        pause:
          from_date: '2025-03-27 11:26:08'
          to_date: '2025-03-27 11:26:08'
    RequestBillingSubscriptionProductSwitch:
      title: SubRequestSwitchProduct
      type: object
      properties:
        subscription_id:
          type: string
          description: Unique subscription identifier.
          format: uuid
          maxLength: 36
          minLength: 36
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        new_product_id:
          type: string
          description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier to apply to the specified subscription.
          format: uuid
          maxLength: 36
          minLength: 36
          example: ac43b415-5522-4373-b026-a365462f9657
      required:
        - subscription_id
        - new_product_id
    ResponseBillingValidationError:
      title: Error
      type: object
      properties:
        error:
          type: object
          description: Error object.
          properties:
            code:
              type: string
              description: |-
                Error code that identifies the validation failure.

                <blockquote>
                  <p>This code is returned when the input data does not meet the expected criteria.</p>
                </blockquote>
              enum:
                - '2.01'
              example: '2.01'
            messages:
              type: object
              description: |-
                Contains field-specific error messages.

                <blockquote>
                  <p>Each key is a field name. Each value is an array of strings that describe validation issues.</p>
                </blockquote>
              additionalProperties:
                type: array
                items:
                  type: string
              example:
                subscription:
                  - Validation error
          required:
            - code
            - messages
    RequestBillingSubscriptionStatus:
      title: SubRequestSubId
      type: object
      properties:
        subscription_id:
          type: string
          description: Unique subscription identifier.
          format: uuid
          maxLength: 36
          minLength: 36
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
      required:
        - subscription_id
    SchemaBillingSubscriptionDiscriminator:
      description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
      properties:
        status:
          type: string
          description: Subscription status.
      example:
        id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
        status: active
        started_at: '2025-12-08 12:37:24'
        updated_at: '2025-12-08 12:37:25'
        expired_at: '2025-12-12 12:37:24'
        next_charge_at: '2025-12-12 14:37:24'
        payment_type: card
        trial: false
        discount:
          created_at: '2025-05-31 12:53:12'
          coupon_code: SUMMER25OFF
          coupon:
            name: Summer 25% OFF
            description: 25% off for 3 months
            type: percentage
            value: 25
        trial_started_at: '2025-12-08 12:37:24'
        trial_ended_at: '2025-12-08 12:37:25'
        cancelled_at: '2025-12-12 19:37:24'
        cancellation_requested_at: '2025-12-11 19:37:24'
        cancel_code: '8.09'
        cancel_message: Cancellation after redemption period
        pause:
          from_date: '2025-03-27 11:26:08'
          to_date: '2025-03-27 11:26:08'
      discriminator:
        propertyName: status
        mapping:
          pending: '#/components/schemas/SchemaBillingSubscriptionStatusPending'
          active: '#/components/schemas/SchemaBillingSubscriptionStatusActive'
          cancelled: '#/components/schemas/SchemaBillingSubscriptionStatusCancelled'
          redemption: '#/components/schemas/SchemaBillingSubscriptionStatusRedemption'
          paused: '#/components/schemas/SchemaBillingSubscriptionStatusPaused'
          expired: '#/components/schemas/SchemaBillingSubscriptionStatusExpired'
    ResponseBillingSubscriptionStatus:
      title: Success
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/SchemaBillingSubscriptionDiscriminator'
        product:
          description: |-
            Subscription product details, including name, pricing logic, amount, currency, trial settings, and other related attributes.

            <blockquote>
              <p>The list of fields within the object differs from the field set during the <a href="https://api-docs.solidgate.com/#tag/Products-and-prices/operation/create-product" target="_blank">creation of the product</a> request.</p>
            </blockquote>
          type: object
          properties:
            id:
              type: string
              description: |-
                Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.

                <blockquote>
                  <p>It corresponds to the <code>product_id</code> parameter.</p>
                </blockquote>
              maxLength: 36
              format: uuid
              example: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
            name:
              type: string
              description: Product name.
              example: Platinum Audiobook Set
            payment_action:
              type: string
              description: Specifies a <a href="https://docs.solidgate.com/payments/payments-overview/" target="_blank">payment flow</a> applied to the first transaction.
              example: auth_void
            price_id:
              type: string
              description: Unique product price identifier.
              maxLength: 36
              format: uuid
              example: 61b7f690-242a-498c-99a1-eb191f93f08c
            amount:
              description: Product price.
              type: integer
              example: 100
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the product price currency.
              maxLength: 3
              minLength: 3
              example: USD
            trial:
              type: boolean
              description: Indicates whether the product has a trial.
              example: true
            trial_period:
              type: integer
              description: Indicates the trial period in minutes.
              example: 1
            trial_amount:
              type: integer
              description: Trial price.
              example: 99
            trial_currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the trial price currency.
              maxLength: 3
              minLength: 3
              example: USD
          required:
            - id
            - name
            - price_id
            - amount
            - currency
            - trial
        customer:
          description: Customer details related to the subscription, including key information such as the customer's email address.
          type: object
          properties:
            customer_account_id:
              type: string
              description: Unique customer identifier defined by the merchant.
              maxLength: 100
              example: 93a1c659-288d-4d62-929d-10e241078faa
            customer_email:
              type: string
              description: Customer's email address.
              maxLength: 100
              example: example@example.com
          required:
            - customer_account_id
            - customer_email
        invoices:
          type: object
          required:
            - <invoice_id_value_#1>
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Single invoice, where `<invoice_id_value_#1>` is a dynamically generated unique invoice identifier.
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                  example: 4022a203-ace8-415f-9ae7-730014fceb25
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - processing
                    - retry
                    - success
                    - fail
                  example: success
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                  example: '2025-12-27 11:45:30'
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-12-28 11:45:30'
                amount:
                  type: integer
                  description: Current subscription price.
                  example: 100
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - description
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 2025
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                  example: '2025-12-29 11:45:30'
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                  example: '2025-12-30 11:45:30'
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                  example: 1
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                          example: 1672066481283AlexKho
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                          example: processing
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                          example: '2025-12-27 11:45:30'
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                          example: '2025-12-28 11:45:30'
                        amount:
                          type: integer
                          description: Original order amount.
                          example: 100
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                              format: uuid
                              maxLength: 36
                              minLength: 36
                              example: 4022a203-ace8-415f-9ae7-730014fceb25
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                              example: example@example.com
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                          example: 1
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                      required:
                        - id
                        - status
                        - amount
                        - created_at
              required:
                - id
                - amount
                - status
                - created_at
                - updated_at
      required:
        - subscription
        - product
        - customer
        - invoices
    RequestBillingSubscriptionRetrieveCustomer:
      title: SubRequestRetrieveByCustomer
      type: object
      properties:
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          example: 93a1c659-288d-4d62-929d-10e241078faa
          maxLength: 100
      required:
        - customer_account_id
    ResponseBillingSubscriptionRetrieveCustomer:
      title: Success
      type: object
      properties:
        <subscription_id_value_#1>:
          description: Details of a subscription, including payment and customer information.
          type: object
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
              example: 64e1c283-17bf-45a7-90ea-2cb938081b2f
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - pending
                - active
                - cancelled
                - redemption
                - paused
                - expired
              example: cancelled
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-06-10 15:42:24'
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-06-10 15:42:25'
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-09-10 16:42:24'
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-11-26 11:43:52'
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              example: paypal-vault
            trial:
              type: boolean
              description: Indicates whether the subscription has a trial.
              example: true
            cancelled_at:
              type: string
              description: Datetime of subscription cancellation.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-06-26 06:43:58'
            cancellation_requested_at:
              type: string
              description: Datetime of subscription cancellation request.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-06-25 06:43:58'
            cancel_code:
              type: string
              description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
              enum:
                - '8.01'
                - '8.02'
                - '8.03'
                - '8.04'
                - '8.05'
                - '8.06'
                - '8.07'
                - '8.08'
                - '8.09'
                - '8.10'
                - '8.11'
                - '8.12'
                - '8.13'
                - '8.14'
                - '8.15'
              example: '8.01'
            cancel_message:
              type: string
              description: Cancellation reason brief description.
              example: Card brand is not supported
            customer:
              description: Customer details related to the subscription, including key information such as the customer's email address.
              type: object
              properties:
                customer_account_id:
                  type: string
                  description: Unique customer identifier defined by the merchant.
                  maxLength: 100
                  example: 93a1c659-288d-4d62-929d-10e241078faa
                customer_email:
                  type: string
                  description: Customer's email address.
                  maxLength: 100
                  example: example@example.com
              required:
                - customer_account_id
                - customer_email
            pause:
              type: object
              description: Pause schedule parameters.
              properties:
                from_date:
                  type: string
                  description: Pause start date.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-03-27 11:26:08'
                to_date:
                  type: string
                  description: Pause end date.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-03-27 11:26:08'
              required:
                - from_date
          required:
            - id
            - updated_at
            - started_at
            - trial
            - payment_type
            - status
            - customer
        <subscription_id_value_#2>:
          description: Details of a subscription, including payment and customer information.
          type: object
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
              example: 64e1c283-17bf-45a7-90ea-2cb938081b2f
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - pending
                - active
                - cancelled
                - redemption
                - paused
                - expired
              example: cancelled
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-06-10 15:42:24'
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-06-10 15:42:25'
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-09-10 16:42:24'
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-11-26 11:43:52'
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              example: paypal-vault
            trial:
              type: boolean
              description: Indicates whether the subscription has a trial.
              example: true
            cancelled_at:
              type: string
              description: Datetime of subscription cancellation.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-06-26 06:43:58'
            cancellation_requested_at:
              type: string
              description: Datetime of subscription cancellation.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-06-25 06:43:58'
            cancel_code:
              type: string
              description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
              enum:
                - '8.01'
                - '8.02'
                - '8.03'
                - '8.04'
                - '8.05'
                - '8.06'
                - '8.07'
                - '8.08'
                - '8.09'
                - '8.10'
                - '8.11'
                - '8.12'
                - '8.13'
                - '8.14'
                - '8.15'
              example: '8.01'
            cancel_message:
              type: string
              description: Cancellation reason brief description.
              example: Card brand is not supported
            customer:
              description: Customer details related to the subscription, including key information such as the customer's email address.
              type: object
              properties:
                customer_account_id:
                  type: string
                  description: Unique customer identifier defined by the merchant.
                  maxLength: 100
                  example: 93a1c659-288d-4d62-929d-10e241078faa
                customer_email:
                  type: string
                  description: Customer's email address.
                  maxLength: 100
                  example: example@example.com
              required:
                - customer_account_id
                - customer_email
            pause:
              type: object
              description: Pause schedule parameters.
              properties:
                from_date:
                  type: string
                  description: Pause start date.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-03-27 11:26:08'
                to_date:
                  type: string
                  description: Pause end date.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-03-27 11:26:08'
              required:
                - from_date
          required:
            - id
            - updated_at
            - started_at
            - trial
            - payment_type
            - status
            - customer
    RequestBillingSubscriptionInvoiceListBySubscriptionID:
      title: SubRequestListInvoiceSubId
      type: object
      properties:
        subscription_id:
          type: string
          description: Unique subscription identifier.
          format: uuid
          maxLength: 36
          minLength: 36
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        pagination:
          type: object
          description: |-
            Contains information about the pagination of the results.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><strong>Should be provided</strong> together if either of the key-value pairs, <code>offset</code> or <code>limit</code>, is included in the object. For the key-value pair that is not needed, specify its default value.</p>
            </blockquote>
          properties:
            offset:
              type: integer
              description: Starting index of the results to return.
              example: 20
              default: 0
              minimum: 0
              maximum: 99999
            limit:
              type: integer
              description: Maximum number of items to return.
              example: 10
              default: 10
              minimum: 1
              maximum: 100
          required:
            - offset
            - limit
      required:
        - subscription_id
    ResponseBillingSubscriptionInvoiceListBySubscriptionID:
      title: Success
      type: object
      properties:
        data:
          type: array
          description: List of invoices, each representing a billing event for a subscription.
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique invoice identifier.
                maxLength: 36
                format: uuid
                example: 4022a203-ace8-415f-9ae7-730014fceb25
              status:
                type: string
                description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                example: fail
                enum:
                  - processing
                  - retry
                  - success
                  - fail
              created_at:
                type: string
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                description: Datetime of the invoice creation.
                example: '2025-12-27 11:45:30'
              updated_at:
                type: string
                description: Datetime of the invoice update.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                example: '2025-12-28 11:45:30'
              amount:
                type: integer
                description: Current subscription price.
                example: 100
                minimum: 0
              price_product_id:
                type: string
                description: |-
                  Unique price identifier applied to the invoice. Use it to distinguish
                  prices configured for different currencies and locations within the
                  same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                  target="_blank">product and price management</a>.

                  <blockquote>
                    <p><code>null</code> is returned if the product has no prices configured for
                    other currencies and locations.</p>
                  </blockquote>
                maxLength: 36
                format: uuid
                example: 61b7f690-242a-498c-99a1-eb191f93f08c
              billing_period_started_at:
                type: string
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                description: |-
                  Start datetime of the period for which the invoice was paid.

                  <blockquote>
                    <p>Filled if invoice is in the <code>success</code> status.</p>
                  </blockquote>
                example: '2025-12-29 11:45:30'
              billing_period_ended_at:
                type: string
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                description: |-
                  End datetime of the period for which the invoice was paid.

                  <blockquote>
                    <p>Filled if invoice is in the <code>success</code> status.</p>
                  </blockquote>
                example: '2025-12-30 11:45:30'
              subscription_term_number:
                type: integer
                description: |-
                  Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.
                    
                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                example: 1
            required:
              - id
              - amount
              - status
              - created_at
              - updated_at
        pagination:
          type: object
          description: Contains information about the pagination of the results.
          properties:
            offset:
              type: integer
              description: Starting index of the returned results.
              example: 20
            limit:
              type: integer
              description: Maximum number of items to return.
              example: 10
            total_count:
              type: integer
              description: Total count of the subscription invoices.
              example: 150
          required:
            - offset
            - limit
            - total_count
      required:
        - data
        - pagination
    RequestBillingSubscriptionOrderListByInvoiceID:
      title: SubRequestListOrderInvoiceId
      type: object
      properties:
        invoice_id:
          type: string
          description: Unique invoice identifier associated with a specific subscription.
          format: uuid
          maxLength: 36
          minLength: 36
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        pagination:
          type: object
          description: |-
            Contains information about the pagination of the results.

            <blockquote style="border-left: 4px solid #D1E6DF;">
              <p><strong>Should be provided</strong> together if either of the key-value pairs, <code>offset</code> or <code>limit</code>, is included in the object. For the key-value pair that is not needed, specify its default value.</p>
            </blockquote>
          properties:
            offset:
              type: integer
              description: Starting index of the results to return.
              example: 20
              default: 0
              minimum: 0
              maximum: 99999
            limit:
              type: integer
              description: Maximum number of items to return.
              example: 10
              default: 10
              minimum: 1
              maximum: 100
          required:
            - offset
            - limit
      required:
        - invoice_id
    ResponseBillingSubscriptionOrderListByInvoiceID:
      title: Success
      type: object
      properties:
        data:
          type: array
          description: List of orders, each containing attributes like order identifier, status, type, amount, currency, and timestamps for creation and updates.
          items:
            type: object
            properties:
              id:
                type: string
                description: |-
                  Unique order identifier, which can be used to find the payment.

                  <blockquote>
                    <p>For the first payment, the identifier is defined by the merchant.</p>
                    <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                  </blockquote>
                maxLength: 255
                example: 1672066481283AlexKho
              status:
                type: string
                description: |-
                  Status of the requested order.

                  <blockquote>
                    <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                    <br><br>
                    <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                  </blockquote>
                enum:
                  - created
                  - processing
                  - 3ds_verify
                  - auth_ok
                  - auth_failed
                  - void_ok
                  - settle_ok
                  - refunded
                  - approved
                  - declined
                example: processing
              created_at:
                type: string
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                description: Datetime of the order creation.
                example: '2025-12-27 11:45:30'
              updated_at:
                type: string
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                description: Datetime of the order update.
                example: '2025-12-27 11:46:30'
              processed_at:
                type: string
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                description: |-
                  Datetime when the order was processed.

                  <blockquote>
                    <p>It is empty for orders in processing.</p>
                  </blockquote>
                example: '2025-12-28 11:45:30'
              amount:
                type: integer
                description: Original order amount.
                minimum: 0
                example: 100
              payment_details:
                description: |-
                  Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                  <blockquote>
                    <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                  </blockquote>
                type: object
                properties:
                  invoice_id:
                    type: string
                    description: |-
                      Unique invoice identifier provided by PayPal.

                      <blockquote>
                        <p>It is provided only for transactions with <code>paypal-vault</code> method.</p>
                      </blockquote>
                    example: '123443334'
                  payer_email:
                    type: string
                    description: |-
                      Customer's email.

                      <blockquote>
                        <p>It is provided only for transactions with <code>paypal-vault</code> method.</p>
                      </blockquote>
                    example: example@example.com
              retry_attempt:
                type: integer
                description: |-
                  Indicates the number of retry attempts for the invoice.

                  <blockquote>
                    <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                  </blockquote>
              operation:
                type: string
                description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                enum:
                  - pay
                  - recurring
                  - recurring-auth
                  - refund
                  - resign
                  - resign-auth
                  - auth
                  - settle
                  - void
                  - apple-pay
                  - google-pay
                deprecated: true
            required:
              - id
              - status
              - amount
              - created_at
              - updated_at
        pagination:
          type: object
          description: Contains information about the pagination of the results.
          properties:
            offset:
              type: integer
              description: Starting index of the returned results.
              example: 20
            limit:
              type: integer
              description: Maximum number of items to return.
              example: 10
            total_count:
              type: integer
              description: Total count of the subscription invoices.
              example: 150
          required:
            - offset
            - limit
            - total_count
      required:
        - data
        - pagination
    RequestBillingSubscriptionUpdateToken:
      title: SubRequestUpdateToken
      type: object
      properties:
        subscription_id:
          type: string
          description: Unique subscription identifier.
          format: uuid
          minLength: 36
          maxLength: 36
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        token:
          type: string
          description: Secure payment token representing sensitive payment method information.
          minLength: 100
          maxLength: 100
          example: uPrZ4lx6OFxDOC5wVeA0w5E2dBtDgCdGINo5jWPtxwQbsENzrFUIAUFT9rk7J0xWkpKj0NjVlEoa1ufu8fBIexEdyHFSNaPYQC7F
      required:
        - subscription_id
        - token
    RequestBillingSubscriptionPauseCreate:
      title: RequestSubscriptionsPauseCreate
      type: object
      properties:
        start_point:
          type: object
          description: |-
            Defines the initial timestamp of the subscription pause period.

            Depending on the `type` parameter, it may represent a specific date.
          required:
            - type
          properties:
            type:
              type: string
              description: Indicates the method of defining the pause <a href="https://docs.solidgate.com/billing/manage-subscription/pause-subscription/#manage-subscription-pause" target="_blank">period</a> start.
              enum:
                - immediate
                - specific_date
              example: specific_date
            date:
              type: string
              description: |-
                Indicates when the pause should start.

                <blockquote style="border-left: 4px solid #F2C4C4;">
                  <p><strong>Required</strong> if the <code>type</code> is <code>specific_date</code>.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-09 12:53:12'
        stop_point:
          type: object
          description: |-
            Defines the concluding timestamp of the subscription pause period.

            Depending on the `type` parameter, it may represent a specific date.
          required:
            - type
          properties:
            type:
              type: string
              description: Indicates the method of defining the pause <a href="https://docs.solidgate.com/billing/manage-subscription/pause-subscription/#manage-subscription-pause" target="_blank">period</a> end.
              enum:
                - infinite
                - specific_date
              example: specific_date
            date:
              type: string
              description: |-
                Indicates when the pause should end.

                <blockquote style="border-left: 4px solid #F2C4C4;">
                   <p><strong>Required</strong> if the <code>type</code> is <code>specific_date</code>.</p>
                   <p>The minimum pause period between <code>start_point: date</code> and <code>stop_point: date</code> is <strong>1 day</strong> and the maximum period is <strong>60 years</strong> for the <code>specific_date</code> pause type.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-23 08:13:46'
      required:
        - start_point
        - stop_point
    ResponseBillingSubscriptionPauseCreateUpdate:
      type: object
      properties:
        id:
          type: string
          description: Unique subscription identifier.
          format: uuid
          example: bd43b415-4321-6275-c137-b365462f9645
        status:
          type: string
          description: |-
            Current subscription status. 

            - `active` - the subscription is currently ongoing and charges are recurring
            - `paused` - the subscription is temporarily on hold and there are no charges
          enum:
            - active
            - paused
          example: active
        pause:
          type: object
          description: Contains the details of the subscription pause.
          required:
            - from_date
          properties:
            from_date:
              type: string
              description: Start datetime of the subscription pause.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-09 12:53:12'
            to_date:
              description: Planned end datetime of the subscription pause.
              type: string
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-23 08:13:46'
      required:
        - pause
        - id
        - status
    ResponseBillingSubscriptionPauseRemove:
      type: object
      properties:
        id:
          type: string
          description: Unique subscription identifier.
          format: uuid
          example: bd43b415-4321-6275-c137-b365462f9645
        status:
          type: string
          description: |-
            Current subscription status. 

            - `active` - the subscription is currently ongoing and charges are recurring
            - `paused` - the subscription is temporarily on hold and there are no charges
          enum:
            - active
            - paused
          example: active
      required:
        - id
        - status
    RequestBillingSubscriptionPauseUpdate:
      title: RequestSubscriptionsPauseUpdate
      type: object
      properties:
        start_point:
          type: object
          description: |-
            Defines the initial timestamp of the subscription pause period.

            Depending on the `type` parameter,  it may represent a specific date.
          required:
            - type
          properties:
            type:
              type: string
              description: Indicates the method of defining the pause <a href="https://docs.solidgate.com/billing/manage-subscription/pause-subscription/#manage-subscription-pause" target="_blank">period</a> start.
              enum:
                - immediate
                - specific_date
              example: specific_date
            date:
              type: string
              description: |-
                Indicates when the pause should start.

                <blockquote style="border-left: 4px solid #F2C4C4;">
                  <p><strong>Required</strong> if the <code>type</code> is <code>specific_date</code>.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-09 12:53:12'
        stop_point:
          type: object
          description: |-
            Defines the concluding timestamp of the subscription pause period.

            Depending on the `type` parameter,  it may represent a specific date.
          required:
            - type
          properties:
            type:
              type: string
              description: Indicates the method of defining the pause <a href="https://docs.solidgate.com/billing/manage-subscription/pause-subscription/#manage-subscription-pause" target="_blank">period</a> end.
              enum:
                - infinite
                - specific_date
              example: specific_date
            date:
              type: string
              description: |-
                Indicates when the pause should end.

                <blockquote style="border-left: 4px solid #F2C4C4;">
                   <p><strong>Required</strong> if the <code>type</code> is <code>specific_date</code>.</p>
                   <p>The minimum pause period between <code>start_point: date</code> and <code>stop_point: date</code> is <strong>1 day</strong> and the maximum period is <strong>60 years</strong> for the <code>specific_date</code> pause type.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              example: '2025-03-23 08:13:46'
    RequestBillingSubscriptionCancel:
      title: RequestSubscriptionsCancel
      type: object
      properties:
        subscription_id:
          type: string
          format: uuid
          maxLength: 36
          minLength: 36
          description: Unique subscription identifier.
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        force:
          type: boolean
          description: |-
            Sets the timing of subscription cancellation.

            - `true` - cancels the subscription immediately
            - `false` - cancels at the end of the billing period
          default: false
        cancel_code:
          type: string
          description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
          enum:
            - '8.01'
            - '8.02'
            - '8.03'
            - '8.04'
            - '8.05'
            - '8.06'
            - '8.07'
            - '8.08'
            - '8.09'
            - '8.10'
            - '8.11'
            - '8.12'
            - '8.13'
            - '8.14'
            - '8.15'
          example: '8.01'
      required:
        - subscription_id
    RequestBillingSubscriptionCancelCustomer:
      title: RequestSubscriptionsCancelCustomer
      type: object
      properties:
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          example: 93a1c659-288d-4d62-929d-10e241078faa
          maxLength: 100
        force:
          type: boolean
          description: |-
            Sets the timing of subscription cancellation.

            - `true` - cancels the subscription immediately
            - `false` - cancels at the end of the billing period
          default: false
        cancel_code:
          type: string
          description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
          enum:
            - '8.01'
            - '8.02'
            - '8.03'
            - '8.04'
            - '8.05'
            - '8.06'
            - '8.07'
            - '8.08'
            - '8.09'
            - '8.10'
            - '8.11'
            - '8.12'
            - '8.13'
            - '8.14'
            - '8.15'
          example: '8.01'
      required:
        - customer_account_id
    RequestBillingSubscriptionRestore:
      title: SubRequestRestore
      type: object
      properties:
        subscription_id:
          type: string
          description: Unique subscription identifier.
          format: uuid
          maxLength: 36
          minLength: 36
          example: 83b19018-cbc4-45f0-899a-dda84fd2705e
        expired_at:
          type: string
          description: |-
            Datetime of the subscription expiration.

            <blockquote>
              <p>Dates in the past are automatically updated to the current date to prevent unwanted charges.</p>
            </blockquote>
          example: '2025-12-25 00:00:00'
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        coupon_id:
          type: string
          format: uuid
          description: |-
            Unique coupon identifier.

            <blockquote>
              <p>Pass either <code>coupon_id</code> or <code>coupon_code</code>, not both.</p>
            </blockquote>
          example: 379bd8d9-7f2a-44eb-be35-b741985e1b08
        coupon_code:
          type: string
          description: |-
            Coupon code.
            <blockquote>
              <p>Pass either <code>coupon_id</code> or <code>coupon_code</code>, not both.</p>
            </blockquote>
          example: PRIME50
      required:
        - subscription_id
    RequestReportsGeneral:
      title: ReconRequestModel
      type: object
      required:
        - date_from
        - date_to
      properties:
        filter:
          type: string
          description: Filtering criteria for the report data.
          enum:
            - updated_at
            - created_at
          example: created_at
        date_from:
          type: string
          description: Start datetime for the report stated in UTC+0.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-08-15 11:00:00'
        date_to:
          type: string
          description: End datetime for the report stated in UTC+0.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-08-18 11:00:00'
        limit:
          type: integer
          description: Limit value indicates the maximum number of items to be returned.
          default: 2000
          minimum: 1
          maximum: 2000
          example: 2000
        next_page_iterator:
          type: string
          example: eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9
          description: |-
            Pagination helps in managing large datasets by dividing them into smaller, manageable chunks.

            <blockquote>
              <p>If this value is <code>null</code>, it indicates that all available data has been successfully retrieved by the merchant.</p>
            </blockquote>
    ResponseReportsCardOrders:
      title: Success
      type: object
      required:
        - orders
        - metadata
      properties:
        orders:
          type: array
          description: List of orders, each containing attributes like order identifier, status, type, amount, currency, and timestamps for creation and updates.
          items:
            type: object
            required:
              - order_id
              - status
              - type
              - amount
              - currency
              - order_description
              - is_secured
              - created_at
              - updated_at
              - transactions
              - customer_email
            properties:
              order_id:
                type: string
                description: Unique order identifier defined by the merchant.
                maxLength: 255
              order_description:
                type: string
                description: Description of the order.
                maxLength: 255
              psp_order_id:
                type: string
                description: PSP identifier generated by Solidgate.
              provider_payment_id:
                type: string
                description: |-
                  PSP identifier generated by the PSP.

                  <blockquote>
                    <p>It is available if the integration passed the data.</p>
                  </blockquote>
              created_at:
                type: string
                description: Datetime when the order was created.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              updated_at:
                type: string
                description: Datetime when the order was updated.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              amount:
                type: integer
                description: |-
                  Original order amount.

                  <blockquote>
                    <p>This is the intended initial authorization amount.</p>
                  </blockquote>
              currency:
                type: string
                description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the order.
                maxLength: 3
                minLength: 3
              processing_amount:
                type: integer
                description: |-
                  Amount of the payment in the smallest currency unit as it was processed by the payment service provider.

                  <blockquote>
                    <p>This amount may differ from the original order amount due to currency conversion or other processing factors.</p>
                  </blockquote>
              processing_currency:
                type: string
                description: |-
                  Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the payment when it was processed by payment service provider.

                  <blockquote>
                    <p>In some cases, it is different from the original currency.</p>
                  </blockquote>
                minLength: 3
                maxLength: 3
              status:
                type: string
                description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
                enum:
                  - processing
                  - 3ds_verify
                  - refunded
                  - auth_ok
                  - auth_failed
                  - settle_ok
                  - partial_settled
                  - void_ok
              payment_type:
                type: string
                description: Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided.
                enum:
                  - 1-click
                  - recurring
                  - retry
                  - installment
                  - rebill
                  - moto
              payment_method:
                type: string
                description: Payment method used for the transaction.
                enum:
                  - card
                  - network-token
                  - token
                  - apple-pay
                  - google-pay
              type:
                type: string
                description: |-
                  <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.

                  <blockquote>
                    <p>The <code>type</code> from the initialized transaction.</p>
                  </blockquote>
                enum:
                  - pay
                  - recurring
                  - recurring-auth
                  - refund
                  - resign
                  - resign-auth
                  - auth
                  - settle
                  - void
                  - apple-pay
                  - google-pay
              is_secured:
                type: boolean
                description: Indicates whether this was a <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a> payment.
              routing:
                type: object
                description: |-
                  Payment routing information.

                  <blockquote>
                    <p>The availability of this object depends on whether routing is <a href="https://docs.solidgate.com/orchestration/routing/#configure-routing" target="_blank">configured</a> for your account.</p>
                  </blockquote>
                properties:
                  cascade_steps:
                    type: array
                    description: Details of the attempts made to process the payment.
                    items:
                      type: object
                      properties:
                        mid:
                          type: string
                          description: Merchant identifier in Solidgate.
                        mid_descriptor:
                          type: string
                          description: Identifying text that appears on a customer's credit or debit card statement.
                        route_id:
                          type: string
                          description: Route identifier configured in Solidgate.
                        cascade_number:
                          type: integer
                          description: |-
                            Sequential number of the processing attempt in the routing cascade, fallback step number.

                            <blockquote>
                              <p>Indicates which attempt in the fallback sequence was used to process the payment.</p>
                            </blockquote>
                        segment_id:
                          type: string
                          description: |-
                            Identifier of the segment used for this processing attempt in the routing configuration.

                            <blockquote>
                              <p>Each segment represents a specific processing configuration within a route.</p>
                            </blockquote>
              customer_account_id:
                type: string
                description: Unique customer identifier defined by the merchant.
                maxLength: 100
              customer_email:
                type: string
                description: Customer's email address.
                maxLength: 100
              customer_first_name:
                type: string
                description: Customer's first name.
              customer_last_name:
                type: string
                description: Customer's last name.
              ip_address:
                type: string
                description: |-
                  Public IP address of the cardholder, both IPv4 and IPv6 are supported.

                  <blockquote style="border-left: 4px solid #F2C4C4; ">  
                    <p><b>Required</b> for antifraud checks.</p>
                    <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
                  </blockquote>
                maxLength: 50
              mid:
                type: string
                description: Merchant identifier in Solidgate.
              traffic_source:
                type: string
                description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
                maxLength: 255
              platform:
                type: string
                description: |-
                  Device platform used by the customer at the time of payment.

                  <blockquote>                
                    <p><strong>APP</strong> for application, <strong>WEB</strong> for desktop web, and <strong>MOB</strong> for mobile web.</p>
                  </blockquote>
                enum:
                  - APP
                  - WEB
                  - MOB
              geo_country:
                type: string
                description: Country where the customer account is registered on the merchant platform.
                format: iso_code_a3
                maxLength: 3
                minLength: 3
              error_code:
                type: string
                description: Gateway <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">error code</a> for the declined payment.
              transactions:
                type: array
                description: List of transactions, each containing detailed attributes such as transaction identifier, status, type, method, amount, currency, and timestamps for creation and updates.
                items:
                  type: object
                  required:
                    - id
                    - operation
                    - status
                    - amount
                    - currency
                    - created_at
                    - updated_at
                    - card
                  properties:
                    id:
                      type: string
                      description: Unique transaction identifier.
                      maxLength: 100
                    created_at:
                      type: string
                      description: Datetime when the transaction was created.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                    updated_at:
                      type: string
                      description: Datetime when the transaction was updated.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                    amount:
                      type: integer
                      description: Transaction amount.
                    currency:
                      type: string
                      description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the transaction.
                    operation:
                      type: string
                      description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                      enum:
                        - pay
                        - recurring
                        - recurring-auth
                        - refund
                        - resign
                        - resign-auth
                        - auth
                        - settle
                        - void
                        - apple-pay
                        - google-pay
                    status:
                      type: string
                      description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
                      enum:
                        - processing
                        - success
                        - fail
                        - verify
                    authorization_type:
                      type: string
                      enum:
                        - final
                        - estimated
                        - incremental
                      description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
                    descriptor:
                      type: string
                      description: |-
                        Identifying text that appears on a customer’s bank statement.

                        <blockquote>
                          <p>It includes information about the transaction and helps the cardholder recognize the charge.</p>
                        </blockquote>
                    refund_reason:
                      type: string
                      description: Text description of the refund reason.
                    refund_reason_code:
                      type: string
                      description: |-
                        Indicates the <a href="https://docs.solidgate.com/payments/payments-insights/refund-reasons/" target="_blank">reason code</a> for the refund provided.

                        <blockquote>
                          <p>This code is used to identify the reason for <code>void</code> and <code>refund</code> transaction operations.</p>
                        </blockquote>
                      minLength: 4
                      maxLength: 4
                    card:
                      type: object
                      description: |-
                        Information related to the card used in the transaction.

                        <blockquote>
                          <p>Object, especially in refunds, may contain <code>null</code> values.</p>
                        </blockquote>
                      properties:
                        bank:
                          type: string
                          description: Card issuer name.
                        bin:
                          type: string
                          description: Card issuer Bank Identification Number (BIN).
                        brand:
                          type: string
                          description: Card brand.
                        card_exp_month:
                          type: string
                          description: Expiry month of the card.
                        card_exp_year:
                          type: integer
                          description: Expiry year of the card.
                        card_holder:
                          type: string
                          description: |-
                            Cardholder's name.

                            <blockquote style="border-left: 4px solid #D1E6DF; ">
                              <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
                            </blockquote>
                          minLength: 2
                          maxLength: 52
                          pattern: ^\w.{0,50}[\w.]$
                        card_type:
                          type: string
                          description: Card type.
                          enum:
                            - CREDIT
                            - CREDIT/DEBIT
                            - DEBIT
                            - PREPAID
                            - CHARGE CARD
                            - DEFERRED DEBIT
                        card_id:
                          type: string
                          description: Unique identifier of the card used for the transaction.
                          format: uuid
                          example: 22733af4-f6c6-4368-b7d0-98aeb0253a57
                        country:
                          type: string
                          description: Card issuer's country.
                          format: iso_code_a3
                          maxLength: 3
                          minLength: 3
                        number:
                          type: string
                          maxLength: 19
                          description: Masked card number.
              order_metadata:
                type: object
                description: Metadata is useful for storing additional, structured information about an object.
                additionalProperties:
                  type: string
                  maxLength: 380
                maxProperties: 10
              fraudulent:
                type: boolean
                description: Whether the merchant system has flagged this customer as suspicious.
                deprecated: true
        metadata:
          type: object
          description: Metadata object containing pagination and count information.
          required:
            - next_page_iterator
            - count
          properties:
            next_page_iterator:
              type: string
              description: |-
                Pagination helps in managing large datasets by dividing them into smaller, manageable chunks.

                <blockquote>
                  <p>If this value is <code>null</code>, it indicates that all available data has been successfully retrieved by the merchant.</p>
                </blockquote>
            count:
              type: integer
              description: Number of orders on the page.
    ResponseReportsApmOrders:
      title: Success
      type: object
      required:
        - orders
        - metadata
      properties:
        orders:
          type: array
          description: List of orders, each containing attributes like order identifier, status, type, amount, currency, and timestamps for creation and updates.
          items:
            type: object
            required:
              - order_id
              - status
              - amount
              - currency
              - order_description
              - customer_email
              - ip_address
              - method
              - created_at
              - updated_at
              - transactions
            properties:
              order_id:
                type: string
                description: Unique order identifier defined by the merchant.
                maxLength: 255
              order_description:
                type: string
                description: Order description.
                maxLength: 255
              created_at:
                type: string
                description: Datetime when the order was created.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              updated_at:
                type: string
                description: Datetime when the order was updated.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              method:
                type: string
                description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> used to process the order.
              amount:
                type: integer
                description: Original order amount.
              currency:
                type: string
                description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the order.
                maxLength: 3
                minLength: 3
              processing_amount:
                type: integer
                description: |-
                  Amount of the payment in the smallest currency unit as it was processed by the payment service provider.

                  <blockquote>
                    <p>This amount may differ from the original order amount due to currency conversion or other processing factors.</p>
                  </blockquote>
              processing_currency:
                type: string
                description: |-
                  Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the payment when it was processed by payment service provider.

                  <blockquote>
                    <p>In some cases, it is different from the original currency.</p>
                  </blockquote>
                maxLength: 3
                minLength: 3
              status:
                type: string
                description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
                enum:
                  - created
                  - processing
                  - settle_pending
                  - approved
                  - declined
                  - refunded
              customer_account_id:
                type: string
                description: Unique customer identifier defined by the merchant.
                maxLength: 100
              customer_email:
                type: string
                description: Customer's email address.
                maxLength: 100
              ip_address:
                type: string
                description: |-
                  Public IP address of the cardholder, both IPv4 and IPv6 are supported.

                  <blockquote style="border-left: 4px solid #F2C4C4; ">
                    <p><b>Required</b> for antifraud checks.</p>
                    <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
                  </blockquote>
                maxLength: 50
              geo_country:
                type: string
                description: Country where the customer account is registered on the merchant platform.
                format: iso_code_a3
                maxLength: 3
                minLength: 3
              error_code:
                type: string
                description: Gateway <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">error code</a> for the declined payment.
              transactions:
                type: array
                description: List of transactions, each containing detailed attributes such as transaction identifier, status, type, method, amount, currency, and timestamps for creation and updates.
                items:
                  type: object
                  required:
                    - status
                    - id
                    - type
                    - method
                    - amount
                    - currency
                    - created_at
                    - updated_at
                  properties:
                    id:
                      type: string
                      description: Unique transaction identifier.
                      maxLength: 100
                    psp_transaction_id:
                      type: string
                      description: |-
                        PSP saves the encrypted payment data and responds with a unique identifier for this transaction.

                        <blockquote>                
                          <p>PSP uses the <code>psp_transaction_id</code> to locate the encrypted payment data for this transaction. This is the identifier generated by the provider (in our case PayPal). Only for transactions with <code>orders:method:paypal-vault</code>.</p>
                        </blockquote>
                      maxLength: 100
                    created_at:
                      type: string
                      description: Datetime when the transaction was created.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                    updated_at:
                      type: string
                      description: Datetime when the transaction was updated.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                    method:
                      type: string
                      description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> used to process the transaction.
                    amount:
                      type: integer
                      description: Transaction amount.
                    currency:
                      type: string
                      description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the transaction.
                      maxLength: 3
                      minLength: 3
                    status:
                      type: string
                      description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
                      enum:
                        - created
                        - processing
                        - settle_pending
                        - success
                        - fail
                    type:
                      type: string
                      description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                      enum:
                        - pay
                        - recurring
                        - refund
              order_metadata:
                type: object
                description: Metadata is useful for storing additional, structured information about an object.
                additionalProperties:
                  type: string
                  maxLength: 380
                maxProperties: 10
        metadata:
          type: object
          description: Metadata object containing pagination and count information.
          properties:
            next_page_iterator:
              type: string
              description: |-
                Pagination helps in managing large datasets by dividing them into smaller, manageable chunks.

                <blockquote>
                  <p>If this value is <code>null</code>, it indicates that all available data has been successfully retrieved by the merchant.</p>
                </blockquote>
            count:
              type: integer
              description: Number of orders on the page.
          required:
            - next_page_iterator
            - count
    ResponseReportsSubscriptions:
      title: Success
      type: object
      properties:
        subscriptions:
          type: object
          description: Map of subscriptions, including detailed information such as status, payment details, cancellation info, associated customer and product data, invoice history, and pause schedule parameters.
          properties:
            <subscription_id_value_#1>:
              title: SubSubscriptionModel
              description: Details of a subscription, including payment and customer information.
              type: object
              properties:
                id:
                  type: string
                  description: Unique subscription identifier.
                  maxLength: 36
                status:
                  type: string
                  description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
                  enum:
                    - active
                    - cancelled
                    - redemption
                    - paused
                started_at:
                  type: string
                  description: Datetime of the subscription start.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                updated_at:
                  type: string
                  description: Datetime of the subscription update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                expired_at:
                  type: string
                  description: Datetime of the subscription expiration.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                next_charge_at:
                  type: string
                  description: Datetime for the subsequent charge.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                payment_type:
                  type: string
                  description: Customer's payment method used for the subscription payment.
                  enum:
                    - card
                    - paypal-vault
                    - alipay
                    - gcash
                    - mbway
                    - mercadopago
                    - upi
                    - wechatpay
                    - pix
                trial:
                  type: boolean
                  description: Indicates whether the subscription has a trial.
                cancelled_at:
                  type: string
                  description: Datetime of subscription cancellation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                cancel_code:
                  type: string
                  description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> used to cancel the subscription.
                  enum:
                    - '8.01'
                    - '8.02'
                    - '8.03'
                    - '8.04'
                    - '8.05'
                    - '8.06'
                    - '8.07'
                    - '8.08'
                    - '8.09'
                    - '8.10'
                    - '8.11'
                    - '8.12'
                    - '8.13'
                    - '8.14'
                    - '8.15'
                cancel_message:
                  type: string
                  description: Cancellation reason brief description.
                customer:
                  description: Customer details related to the subscription, including key information such as the customer's email address.
                  type: object
                  properties:
                    customer_account_id:
                      type: string
                      description: Unique customer identifier defined by the merchant.
                      maxLength: 100
                    customer_email:
                      type: string
                      description: Customer's email address.
                      maxLength: 100
                  required:
                    - customer_account_id
                    - customer_email
                product:
                  type: object
                  description: |-
                    Subscription product details, including name, pricing logic, amount, currency, trial settings, and other related attributes.

                    <blockquote>
                      <p>The list of fields within the object differs from the fields of the <a href="https://api-docs.solidgate.com/#tag/Products-and-prices/operation/create-product" target="_blank">product creation</a> request.</p>
                    </blockquote>
                  properties:
                    id:
                      type: string
                      description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
                      maxLength: 36
                    name:
                      type: string
                      description: Product name.
                    payment_action:
                      type: string
                      description: Specifies a <a href="https://docs.solidgate.com/payments/payments-overview/" target="_blank">payment flow</a> applied to the first transaction.
                    amount:
                      description: Product price.
                      type: integer
                    currency:
                      type: string
                      description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the product price currency.
                      maxLength: 3
                      minLength: 3
                    trial:
                      type: boolean
                      description: Indicates whether the product has a trial.
                    trial_period:
                      type: integer
                      description: Indicates the trial period in minutes.
                  required:
                    - id
                    - name
                    - amount
                    - currency
                    - trial
                invoices:
                  type: object
                  required:
                    - <invoice_id_value_#1>
                  description: Map of invoices, containing details such as a subscription's billing overview, current state, financial information, and associated order history.
                  properties:
                    <invoice_id_value_#1>:
                      type: object
                      description: Single invoice, where `<invoice_id_value_#1>` is a dynamically generated unique invoice identifier.
                      properties:
                        id:
                          type: string
                          description: Unique invoice identifier associated with a specific subscription.
                          maxLength: 36
                          format: uuid
                        status:
                          type: string
                          description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                          enum:
                            - processing
                            - retry
                            - success
                            - fail
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the invoice creation.
                        updated_at:
                          type: string
                          description: Datetime of the invoice update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        amount:
                          type: integer
                          description: Current subscription price.
                        billing_period_started_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Start datetime of the period covered by the invoice.

                            <blockquote>
                              <p>Filled if invoice is in the <code>success</code> status.</p>
                            </blockquote>
                        billing_period_ended_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            End datetime of the period covered by the invoice.

                            <blockquote>
                              <p>Filled if invoice is in the <code>success</code> status.</p>
                            </blockquote>
                        subscription_term_number:
                          type: integer
                          description: |-
                            Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                            <blockquote>
                              <p>Filled if invoice is created:</p>
                              <ul>
                                <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                                <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                              </ul>
                            </blockquote>
                        orders:
                          type: object
                          description: Map of orders, including data such as status, creation and processing timestamps, and other transaction details.
                          properties:
                            <order_id_value_#1>:
                              type: object
                              description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                              properties:
                                id:
                                  type: string
                                  description: Unique order identifier defined by the merchant, which can be used to find the payment.
                                  maxLength: 100
                                status:
                                  type: string
                                  description: |-
                                    Status of the requested order.

                                    <blockquote>
                                      <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                                      <br><br>
                                      <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                                    </blockquote>
                                  enum:
                                    - created
                                    - processing
                                    - 3ds_verify
                                    - auth_ok
                                    - auth_failed
                                    - void_ok
                                    - settle_ok
                                    - refunded
                                    - approved
                                    - declined
                                created_at:
                                  type: string
                                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                                  description: Datetime of the order creation.
                                processed_at:
                                  type: string
                                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                                  description: Datetime when the order was processed.
                                amount:
                                  type: integer
                                  description: Original order amount.
                                payment_details:
                                  title: APMPayerDetails
                                  description: |-
                                    Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                                    <blockquote>
                                      <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                                    </blockquote>
                                  type: object
                                  properties:
                                    invoice_id:
                                      type: string
                                      description: |-
                                        Unique invoice identifier provided by PayPal.

                                        <blockquote>
                                          <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                        </blockquote>
                                      format: uuid
                                      maxLength: 36
                                      minLength: 36
                                    payer_email:
                                      type: string
                                      description: |-
                                        Customer's email.

                                        <blockquote>
                                          <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                        </blockquote>
                                retry_attempt:
                                  type: integer
                                  description: |-
                                    Number of retry attempts for the subscription payments.

                                    <blockquote>
                                      <p>Use it for analytics and conversion tuning purposes.</p>
                                    </blockquote>
                                  minimum: 0
                                operation:
                                  type: string
                                  description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                                  enum:
                                    - pay
                                    - recurring
                                    - recurring-auth
                                    - refund
                                    - resign
                                    - resign-auth
                                    - auth
                                    - settle
                                    - void
                                    - apple-pay
                                    - google-pay
                                  deprecated: true
                              required:
                                - id
                                - status
                                - amount
                                - created_at
                                - processed_at
                                - retry_attempt
                          required:
                            - <order_id_value_#1>
                      required:
                        - id
                        - amount
                        - status
                        - created_at
                        - updated_at
                        - billing_period_started_at
                        - billing_period_ended_at
                        - subscription_term_number
                        - orders
                pause:
                  type: object
                  description: Pause schedule parameters.
                  properties:
                    from_date:
                      type: string
                      description: Pause start date.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                    to_date:
                      type: string
                      description: Pause end date.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  required:
                    - from_date
              required:
                - id
                - updated_at
                - started_at
                - trial
                - payment_type
                - status
                - customer
                - product
                - invoices
          required:
            - <subscription_id_value_#1>
        metadata:
          type: object
          description: Contains metadata related to the request, particularly for pagination.
          properties:
            next_page_iterator:
              type: string
              description: |-
                To perform pagination in the request body, add the field with the value from the previous response.

                <blockquote>
                  <p>If this value is <code>null</code>, all data was successfully retrieved by the merchant.</p>
                </blockquote>
            count:
              type: integer
              description: Number of subscriptions on the page.
          required:
            - next_page_iterator
            - count
      required:
        - subscriptions
        - metadata
    ResponseReportsChargebacks:
      title: Success
      type: object
      required:
        - orders
        - metadata
      properties:
        orders:
          type: array
          description: List of orders, each containing attributes like order identifier, status, type, amount, currency, and timestamps for creation and updates.
          items:
            type: object
            required:
              - order_id
              - status
              - type
              - amount
              - currency
              - order_description
              - is_secured
              - created_at
              - updated_at
              - chargebacks
            properties:
              order_id:
                type: string
                description: Unique order identifier defined by the merchant.
                maxLength: 255
              order_description:
                type: string
                description: Description of the order.
                maxLength: 255
              created_at:
                type: string
                description: Datetime when the order was created.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              updated_at:
                type: string
                description: Datetime when the order was updated.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              amount:
                type: integer
                description: Original order amount.
              currency:
                type: string
                description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the order.
                maxLength: 3
                minLength: 3
              status:
                type: string
                description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
                enum:
                  - processing
                  - 3ds_verify
                  - refunded
                  - auth_ok
                  - auth_failed
                  - settle_ok
                  - partial_settled
                  - void_ok
              type:
                type: string
                description: |-
                  <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.

                  <blockquote>
                    <p>The <code>type</code> from the initialized transaction.</p>
                  </blockquote>
                enum:
                  - pay
                  - recurring
                  - recurring-auth
                  - refund
                  - resign
                  - resign-auth
                  - auth
                  - settle
                  - void
                  - apple-pay
                  - google-pay
              is_secured:
                type: boolean
                description: Indicates whether this was a <a href="https://docs.solidgate.com/payments/payments-overview/#3ds" target="_blank">3DS</a> payment.
              customer_account_id:
                type: string
                description: Unique customer identifier defined by the merchant.
                maxLength: 100
              customer_email:
                type: string
                description: Customer's email address.
                maxLength: 100
              customer_first_name:
                type: string
                description: Customer's first name.
              customer_last_name:
                type: string
                description: Customer's last name.
              ip_address:
                type: string
                description: |-
                  Public IP address of the cardholder, both IPv4 and IPv6 are supported.

                  <blockquote style="border-left: 4px solid #F2C4C4; ">                
                    <p><b>Required</b> for antifraud checks.</p>
                    <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
                  </blockquote>
                maxLength: 50
              platform:
                type: string
                description: |-
                  Device platform used by the customer at the time of payment.

                  <blockquote>                
                    <p><strong>APP</strong> for application, <strong>WEB</strong> for desktop web, and <strong>MOB</strong> for mobile web.</p>
                  </blockquote>
                enum:
                  - MOB
                  - WEB
                  - APP
              geo_country:
                type: string
                description: Country where the customer account is registered on the merchant platform.
                format: iso_code_a3
                maxLength: 3
                minLength: 3
              chargebacks:
                type: array
                description: List of chargebacks, each containing attributes such as unique identifier, creation, dispute, and settlement dates, amount, currency, type, status, and reason codes.
                items:
                  type: object
                  required:
                    - id
                    - dispute_date
                    - amount
                    - currency
                    - created_at
                    - updated_at
                  properties:
                    id:
                      type: string
                      description: |-
                        Unique chargeback identifier.

                        <blockquote>
                          <p>int64 value serialized as a string in JSON.</p>
                        </blockquote>
                      maxLength: 100
                    created_at:
                      type: string
                      description: Datetime when the chargeback was created.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                    updated_at:
                      type: string
                      description: Datetime when the chargeback was updated.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                    dispute_date:
                      type: string
                      description: Date when the chargeback was created by the issuer.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ || ^\d{4}-\d{2}-\d{2}
                    settlement_date:
                      type: string
                      description: Date when the chargeback was financially settled.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                    amount:
                      type: integer
                      description: |-
                        Amount that will be deducted for the chargeback on a specific order.

                        <blockquote>
                          <p>This amount may vary depending on the cardholder's decision on the amount to dispute.</p>
                        </blockquote>
                    currency:
                      type: string
                      description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the chargeback amount.
                      maxLength: 3
                      minLength: 3
                    type:
                      type: string
                      description: <a href="https://docs.solidgate.com/risks/chargebacks/#types" target="_blank">Current type</a> of the chargeback.
                      enum:
                        - 1st_chb
                        - 2nd_chb
                        - arbitration
                    status:
                      type: string
                      description: <a href="https://docs.solidgate.com/risks/chargebacks/#statuses" target="_blank">Status</a> of the chargeback.
                      enum:
                        - in_progress
                        - document_sent
                        - reversed
                        - accepted
                        - resolved
                        - resolved_reversal
                    reason_group:
                      type: string
                      description: |-
                        <a href="https://docs.solidgate.com/risks/reason-codes/" target="_blank">Reason code</a> group.

                        <blockquote>                
                          <p>It can be used for the segmentation and analytic purposes.</p>
                        </blockquote>
                    reason_code:
                      type: string
                      description: <a href="https://docs.solidgate.com/risks/reason-codes/" target="_blank">Reason code</a> for the chargeback provided by the card scheme.
                    reason_description:
                      type: string
                      description: <a href="https://docs.solidgate.com/risks/reason-codes/" target="_blank">Reason code</a> description for the chargeback provided by the card scheme.
                    flows:
                      type: array
                      description: List of chargeback flows, each containing attributes such as unique identifier, creation, settlement, and deadline dates, amount, currency, type, status, and ARN code.
                      items:
                        type: object
                        required:
                          - id
                          - amount
                          - dispute_amount
                          - currency
                          - type
                          - status
                          - created_at
                          - updated_at
                        properties:
                          id:
                            type: string
                            description: |-
                              Unique chargeback flow identifier.

                              <blockquote>
                                <p>int64 value serialized as a string in JSON.</p>
                              </blockquote>
                            maxLength: 100
                          date:
                            type: string
                            description: Datetime when the chargeback flow was created by Solidgate.
                            pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          created_at:
                            type: string
                            description: Datetime when the chargeback flow was created.
                            pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          updated_at:
                            type: string
                            description: Datetime when the chargeback flow was updated.
                            pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          settlement_date:
                            type: string
                            description: Date when the chargeback flow was financially settled.
                            pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          deadline_date:
                            type: string
                            description: |-
                              Deadline for submitting a response to contest the dispute.

                              <blockquote>
                                <p>This corresponds to date + n, where n is a number of calendar days set by the scheme or acquirer.</p>
                              </blockquote>
                            pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          amount:
                            type: integer
                            description: |-
                              Amount involved in each stage of the chargeback process.

                              <blockquote>
                                <p>For example, there can be two records in <code>chargeback_flow</code> one with an amount of 113.58 USD and another with an amount of 100 USD.</p>
                              </blockquote>
                          dispute_amount:
                            type: integer
                            description: |-
                              Specific amount disputed, typically in the smallest currency unit, that is returned to the merchant if the dispute is resolved in their favor.

                              <blockquote>
                                <p>For example, if the second chargeback is successfully disputed, the <code>dispute_amount</code> will be 100 USD.</p>
                              </blockquote>
                          currency:
                            type: string
                            description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the chargeback amount.
                            minLength: 3
                            maxLength: 3
                          type:
                            type: string
                            description: <a href="https://docs.solidgate.com/risks/chargebacks/#types" target="_blank">Type</a> of the chargeback flow.
                            enum:
                              - 1st_chb
                              - 2nd_chb
                              - arbitration
                          status:
                            type: string
                            description: <a href="https://docs.solidgate.com/risks/chargebacks/#statuses" target="_blank">Status</a> of the chargeback flow.
                            enum:
                              - in_progress
                              - document_sent
                              - reversed
                              - accepted
                              - resolved
                              - resolved_reversal
                          represented_by:
                            type: string
                            description: Indicates which party has provided the defense document for dispute <a href="https://docs.solidgate.com/risks/chargebacks/#respond-to-chargebacks" target="_blank">representment</a>.
                            enum:
                              - merchant
                              - automation
                          arn_code:
                            type: string
                            description: |-
                              Acquirer Reference Number (ARN) assigned to transactions.

                              <blockquote>
                                <p>Use ARN to check transaction <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">status</a>.</p>
                              </blockquote>
              fraudulent:
                type: boolean
                description: Whether the merchant system has flagged this customer as suspicious.
                deprecated: true
        metadata:
          type: object
          description: Metadata object containing pagination and count information.
          required:
            - next_page_iterator
            - count
          properties:
            next_page_iterator:
              type: string
              description: |-
                Pagination helps in managing large datasets by dividing them into smaller, manageable chunks.

                <blockquote>
                  <p>If this value is <code>null</code>, it indicates that all available data has been successfully retrieved by the merchant.</p>
                </blockquote>
            count:
              type: integer
              description: Number of orders on the page.
    ResponseReportsPaypalDisputes:
      title: Success
      type: object
      required:
        - disputes
        - metadata
      properties:
        disputes:
          type: array
          description: List of disputes, each containing attributes like identifiers, dates, amounts, currencies, stages, channels, reasons, and status.
          items:
            type: object
            required:
              - dispute_id
              - order_id
              - dispute_amount
              - dispute_currency
              - reason
              - status
              - dispute_life_cycle_stage
              - dispute_channel
              - dispute_create_time
              - dispute_update_time
              - created_at
              - updated_at
            properties:
              dispute_id:
                type: string
                description: Unique dispute identifier.
              order_id:
                type: string
                description: Unique order identifier defined by the merchant.
                maxLength: 255
              subscription_product_id:
                description: |-
                  Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier of the subscription.

                  <blockquote>
                     <p>It corresponds to the <code>product_id</code> parameter in subscriptions.</p>
                  </blockquote>
                format: uuid
                maxLength: 36
                minLength: 36
              subscription_service_id:
                description: |-
                  Subscription identifier.

                  <blockquote>
                     <p>It corresponds to the <code>subscription_id</code> parameter in <a href="https://api-docs.solidgate.com/#tag/Manage-subscriptions" target="_blank">subscriptions</a>.</p>
                  </blockquote>
                format: uuid
                maxLength: 36
                minLength: 36
              created_at:
                type: string
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                description: Datetime when the dispute was created.
              updated_at:
                type: string
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                description: Datetime when the dispute was updated.
              seller_response_due_date:
                type: string
                description: Deadline for submitting a response to the dispute.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              dispute_amount:
                type: integer
                description: Dispute amount.
              dispute_currency:
                type: string
                description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the dispute.
                minLength: 3
                maxLength: 3
              dispute_life_cycle_stage:
                type: string
                description: Stage in the <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/insights/" target="_blank">dispute lifecycle</a>.
                enum:
                  - INQUIRY
                  - CHARGEBACK
                  - PRE_ARBITRATION
                  - ARBITRATION
              dispute_channel:
                type: string
                description: Indicates the <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/insights/" target="_blank">channel</a> by which PayPal dispute has been received.
                enum:
                  - INTERNAL
                  - EXTERNAL
                  - ALERT
              dispute_create_time:
                type: string
                description: Datetime when the dispute was created.
              dispute_update_time:
                type: string
                description: Datetime when the dispute was updated.
              dispute_outcome:
                type: string
                description: <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/insights/" target="_blank">Outcome</a> of the dispute.
                enum:
                  - RESOLVED_BUYER_FAVOUR
                  - RESOLVED_SELLER_FAVOUR
                  - RESOLVED_WITH_PAYOUT
                  - CANCELED_BY_BUYER
                  - NONE
              reason:
                type: string
                description: <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/insights/" target="_blank">Reason</a> for the received dispute.
                enum:
                  - MERCHANDISE_OR_SERVICE_NOT_RECEIVED
                  - MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED
                  - UNAUTHORISED
                  - CREDIT_NOT_PROCESSED
                  - DUPLICATE_TRANSACTION
                  - INCORRECT_AMOUNT
                  - PAYMENT_BY_OTHER_MEANS
                  - CANCELED_RECURRING_BILLING
                  - PROBLEM_WITH_REMITTANCE
                  - OTHER
              status:
                type: string
                description: <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/insights/" target="_blank">Status</a> of the PayPal dispute.
                enum:
                  - OPEN
                  - WAITING_FOR_BUYER_RESPONSE
                  - WAITING_FOR_SELLER_RESPONSE
                  - UNDER_REVIEW
                  - RESOLVED
                  - OTHER
              represented_by:
                type: string
                description: Indicates which party has provided the defense document for dispute <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/manage/#dispute-representment" target="_blank">representment</a>.
                enum:
                  - merchant
                  - automation
              customer_account_id:
                type: string
                description: Unique customer identifier defined by the merchant.
                maxLength: 100
              customer_email:
                type: string
                description: Customer's email address.
        metadata:
          type: object
          description: Metadata object containing pagination and count information.
          required:
            - next_page_iterator
            - count
          properties:
            next_page_iterator:
              type: string
              description: |-
                Pagination helps in managing large datasets by dividing them into smaller, manageable chunks.

                <blockquote>
                  <p>If this value is <code>null</code>, it indicates that all available data has been successfully retrieved by the merchant.</p>
                </blockquote>
            count:
              type: integer
              description: Number of disputes on the page.
    ResponseReportsPreventionAlerts:
      title: Success
      type: object
      properties:
        report_url:
          type: string
          description: URL for the report stored on Amazon S3, which needs to be downloaded.
          example: https://reports.solidgate.com/api/v1/prevention_alerts/report/prev_alert_220504_143924_test/download
    ResponseReportsFraudAlerts:
      title: Success
      type: object
      required:
        - alerts
        - metadata
      properties:
        alerts:
          type: array
          description: List of alerts, each containing detailed attributes such as order identifier, creation, update, and report dates, amounts in original currency and USD, fraud type, card scheme, and reason code description.
          items:
            type: object
            properties:
              order_id:
                type: string
                description: Unique order identifier defined by the merchant.
                maxLength: 255
              created_at:
                type: string
                description: Datetime when the fraud alert was created by Solidgate.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              updated_at:
                type: string
                description: Datetime when the fraud alert was updated Solidgate.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              fraud_amount:
                type: integer
                description: Amount of the fraud reported.
              fraud_currency:
                type: string
                description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the fraud amount.
                minLength: 3
                maxLength: 3
              fraud_amount_usd:
                type: integer
                description: |-
                  Amount of the fraud reported in USD.

                  <blockquote>
                    <p>It can be used for the risk monitoring purposes.</p>
                  </blockquote>
              fraud_report_date:
                type: string
                description: |-
                  Datetime when fraud was reported by the issuer.

                  <blockquote>
                    <p>In the <a href="https://api-docs.solidgate.com/#tag/Card-payments/operation/webhook-fraud-alert" target="_blank">fraud alert webhooks</a>, <code>fraud_report_<b>day</b></code> field has an identical meaning.</p>
                  </blockquote>
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              fraud_type:
                type: string
                description: Type of fraud detected, categorizing the nature of the fraudulent activity.
              card_scheme:
                type: string
                description: Card scheme associated with the transaction like Visa or Mastercard, providing context on the payment network involved.
              reason_code_description:
                type: string
                description: Detailed explanation of the <a href="https://docs.solidgate.com/risks/fraud-codes/" target="_blank">reason code</a> associated with the fraud alert, offering insights into why the fraud was flagged.
        metadata:
          type: object
          description: Metadata object containing pagination and count information.
          properties:
            next_page_iterator:
              type: string
              description: |-
                Pagination helps in managing large datasets by dividing them into smaller, manageable chunks.

                <blockquote>
                  <p>If this value is <code>null</code>, it indicates that all available data has been successfully retrieved by the merchant.</p>
                </blockquote>
            count:
              type: integer
              description: Number of alerts on the page.
          required:
            - next_page_iterator
            - count
    ResponseReportsFinancialEntries:
      title: Success
      type: object
      properties:
        report_url:
          type: string
          description: URL for the report stored on Amazon S3, which needs to be downloaded.
          example: https://reports.solidgate.com/api/v1/finance/financial_entries/report/fin_220808_143924_test/download
    ResponseReportsRoutingV2Report:
      title: Success
      type: object
      required:
        - report_url
      properties:
        report_url:
          type: string
          description: URL for the report stored on Amazon S3, which needs to be downloaded.
          example: https://reports.solidgate.com/api/v1/routing/events/report/routing_220504_143924_test/download
    SchemaRisksListFieldCardId:
      title: SchemaRisksListFieldCardId
      type: object
      required:
        - list_type
        - payment_field
        - field_value
      properties:
        list_type:
          type: string
          description: Type of fraud prevention list, where <code>pass</code> indicates an allowlist and <code>reject</code> indicates a blocklist.
          enum:
            - pass
            - reject
        payment_field:
          type: string
          description: Payment field to match against the fraud prevention list.
          enum:
            - card_id
        field_value:
          type: string
          maxLength: 150
          description: Value of the payment field to match against the fraud prevention list.
        expired_at:
          type: string
          description: |-
            Expiration date of the list item.

            <blockquote>
              <p>If not provided, the item never expires.</p>
            </blockquote>
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        description:
          type: string
          description: Reason for adding this item to the list.
          maxLength: 255
        created_by:
          type: string
          description: Email address of the user who created the list item.
          maxLength: 255
          format: email
    SchemaRisksListFieldCardHolder:
      title: SchemaRisksListFieldCardHolder
      type: object
      required:
        - list_type
        - payment_field
        - field_value
      properties:
        list_type:
          type: string
          description: Type of fraud prevention list, where <code>pass</code> indicates an allowlist and <code>reject</code> indicates a blocklist.
          enum:
            - pass
            - reject
        payment_field:
          type: string
          description: Payment field to match against the fraud prevention list.
          enum:
            - cardholder
        field_value:
          type: string
          maxLength: 150
          description: Value of the payment field to match against the fraud prevention list.
        expired_at:
          type: string
          description: |-
            Expiration date of the list item.

            <blockquote>
              <p>If not provided, the item never expires.</p>
            </blockquote>
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        description:
          type: string
          description: Reason for adding this item to the list.
          maxLength: 255
        created_by:
          type: string
          description: Email address of the user who created the list item.
          maxLength: 255
          format: email
    SchemaRisksListFieldCustomerId:
      title: SchemaRisksListFieldCustomerId
      type: object
      required:
        - list_type
        - payment_field
        - field_value
      properties:
        list_type:
          type: string
          description: Type of fraud prevention list, where <code>pass</code> indicates an allowlist and <code>reject</code> indicates a blocklist.
          enum:
            - pass
            - reject
        payment_field:
          type: string
          description: Payment field to match against the fraud prevention list.
          enum:
            - customer_id
        field_value:
          type: string
          maxLength: 150
          description: Value of the payment field to match against the fraud prevention list.
        expired_at:
          type: string
          description: |-
            Expiration date of the list item.

            <blockquote>
              <p>If not provided, the item never expires.</p>
            </blockquote>
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        description:
          type: string
          description: Reason for adding this item to the list.
          maxLength: 255
        created_by:
          type: string
          description: Email address of the user who created the list item.
          maxLength: 255
          format: email
    SchemaRisksListFieldCustomerEmail:
      title: SchemaRisksListFieldCustomerEmail
      type: object
      required:
        - list_type
        - payment_field
        - field_value
      properties:
        list_type:
          type: string
          description: Type of fraud prevention list, where <code>pass</code> indicates an allowlist and <code>reject</code> indicates a blocklist.
          enum:
            - pass
            - reject
        payment_field:
          type: string
          description: Payment field to match against the fraud prevention list.
          enum:
            - customer_email
        field_value:
          type: string
          format: email
          description: Value of the payment field to match against the fraud prevention list.
        expired_at:
          type: string
          description: |-
            Expiration date of the list item.

            <blockquote>
              <p>If not provided, the item never expires.</p>
            </blockquote>
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        description:
          type: string
          description: Reason for adding this item to the list.
          maxLength: 255
        created_by:
          type: string
          description: Email address of the user who created the list item.
          maxLength: 255
          format: email
    SchemaRisksListFieldIpAddress:
      title: SchemaRisksListFieldIpAddress
      type: object
      required:
        - list_type
        - payment_field
        - field_value
      properties:
        list_type:
          type: string
          description: Type of fraud prevention list, where <code>pass</code> indicates an allowlist and <code>reject</code> indicates a blocklist.
          enum:
            - pass
            - reject
        payment_field:
          type: string
          description: Payment field to match against the fraud prevention list.
          enum:
            - ip_address
        field_value:
          type: string
          format: ipv4
          description: Value of the payment field to match against the fraud prevention list.
        expired_at:
          type: string
          description: |-
            Expiration date of the list item.

            <blockquote>
              <p>If not provided, the item never expires.</p>
            </blockquote>
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        description:
          type: string
          description: Reason for adding this item to the list.
          maxLength: 255
        created_by:
          type: string
          description: Email address of the user who created the list item.
          maxLength: 255
          format: email
    RequestRisksFraudPreventionListItemsCreate:
      title: RequestRisksFraudPreventionListItemsCreate
      type: object
      required:
        - items
      properties:
        items:
          type: array
          description: List of fraud prevention list items to be created.
          maxItems: 100
          items:
            properties:
              payment_field:
                description: Payment field to match against the fraud prevention list.
                enum:
                  - card_id
                  - cardholder
                  - customer_id
                  - customer_email
                  - ip_address
            discriminator:
              propertyName: payment_field
              mapping:
                card_id: '#/components/schemas/SchemaRisksListFieldCardId'
                cardholder: '#/components/schemas/SchemaRisksListFieldCardHolder'
                customer_id: '#/components/schemas/SchemaRisksListFieldCustomerId'
                customer_email: '#/components/schemas/SchemaRisksListFieldCustomerEmail'
                ip_address: '#/components/schemas/SchemaRisksListFieldIpAddress'
    ResponseRisksFraudPreventionListItem:
      title: Success
      type: object
      required:
        - id
        - list_type
        - payment_field
        - field_value
      properties:
        id:
          type: string
          description: Unique identifier of the fraud prevention list item.
          maxLength: 255
        list_type:
          type: string
          description: Type of fraud prevention list, where <code>pass</code> indicates an allowlist and <code>reject</code> indicates a blocklist.
          enum:
            - pass
            - reject
        payment_field:
          type: string
          description: Payment field to match against the fraud prevention list.
          enum:
            - card_id
            - cardholder
            - customer_id
            - customer_email
            - ip_address
        field_value:
          type: string
          description: |-
            Value of the payment field to match against the fraud prevention list.

            <blockquote>
              <p>Depending on the value provided in <code>payment_field</code>, the corresponding validation rules are enforced.</p>
            </blockquote>
        created_at:
          type: string
          description: Creation date of the list item.
        expired_at:
          type: string
          description: |-
            Expiration date of the list item.

            <blockquote>
              <p>If not provided, the item never expires.</p>
            </blockquote>
        description:
          type: string
          description: Reason for adding this item to the list.
          maxLength: 255
        created_by:
          type: string
          description: Email address of the user who created the list item.
          maxLength: 255
          format: email
    ResponseRisksFraudPreventionListItemsCreate:
      title: Success
      type: object
      required:
        - items
      properties:
        items:
          type: array
          description: List of created fraud prevention list items.
          items:
            $ref: '#/components/schemas/ResponseRisksFraudPreventionListItem'
    SchemaRisksListFieldValueCardId:
      title: SchemaRisksListFieldValueCardId
      type: object
      required:
        - payment_field
      properties:
        payment_field:
          type: string
          description: Payment field to match against the fraud prevention list.
          enum:
            - card_id
        field_value:
          type: string
          maxLength: 150
          description: Value of the payment field to match against the fraud prevention list.
    SchemaRisksListFieldValueCardHolder:
      title: SchemaRisksListFieldValueCardHolder
      type: object
      required:
        - payment_field
      properties:
        payment_field:
          type: string
          description: Payment field to match against the fraud prevention list.
          enum:
            - cardholder
        field_value:
          type: string
          maxLength: 150
          description: Value of the payment field to match against the fraud prevention list.
    SchemaRisksListFieldValueCustomerId:
      title: SchemaRisksListFieldValueCustomerId
      type: object
      required:
        - payment_field
      properties:
        payment_field:
          type: string
          description: Payment field to match against the fraud prevention list.
          enum:
            - customer_id
        field_value:
          type: string
          maxLength: 150
          description: Value of the payment field to match against the fraud prevention list.
    SchemaRisksListFieldValueCustomerEmail:
      title: SchemaRisksListFieldValueCustomerEmail
      type: object
      required:
        - payment_field
      properties:
        payment_field:
          type: string
          description: Payment field to match against the fraud prevention list.
          enum:
            - customer_email
        field_value:
          type: string
          format: email
          description: Value of the payment field to match against the fraud prevention list.
    SchemaRisksListFieldValueIpAddress:
      title: SchemaRisksListFieldValueIpAddress
      type: object
      required:
        - payment_field
      properties:
        payment_field:
          type: string
          description: Payment field to match against the fraud prevention list.
          enum:
            - ip_address
        field_value:
          type: string
          format: ipv4
          description: Value of the payment field to match against the fraud prevention list.
    RequestRisksFraudPreventionListItemList:
      title: RequestRisksFraudPreventionListItemList
      type: object
      properties:
        list_type:
          type: string
          description: Type of fraud prevention list, where <code>pass</code> indicates an allowlist and <code>reject</code> indicates a blocklist.
          enum:
            - pass
            - reject
        payment_field_value:
          type: object
          description: Payment field and value to match against the fraud prevention list.
          required:
            - payment_field
          properties:
            payment_field:
              type: string
              description: Payment field to match against the fraud prevention list.
              enum:
                - card_id
                - cardholder
                - customer_id
                - customer_email
                - ip_address
          discriminator:
            propertyName: payment_field
            mapping:
              card_id: '#/components/schemas/SchemaRisksListFieldValueCardId'
              cardholder: '#/components/schemas/SchemaRisksListFieldValueCardHolder'
              customer_id: '#/components/schemas/SchemaRisksListFieldValueCustomerId'
              customer_email: '#/components/schemas/SchemaRisksListFieldValueCustomerEmail'
              ip_address: '#/components/schemas/SchemaRisksListFieldValueIpAddress'
        include_deleted:
          type: boolean
          description: |-
            Indicates whether to include deleted items in the response.

            <blockquote>
              <p>If is not set, or set to <code>false</code>, only active items are returned.</p>
            </blockquote>
        created_at_from:
          type: string
          description: Items created after datetime stated in UTC+0.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-08-15 11:00:00'
        created_at_to:
          type: string
          description: Items created before datetime stated in UTC+0.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2025-08-18 11:00:00'
        limit:
          type: integer
          description: Limit value indicates the maximum number of items to be returned.
          default: 2000
          minimum: 1
          maximum: 2000
        next_page_iterator:
          type: string
          description: |-
            Reference point for retrieving the next page of results

            <blockquote>
              <p>If this value is <code>null</code>, it indicates that all available data has been successfully retrieved by the merchant.</p>
            </blockquote>
    ResponseRisksFraudPreventionListListItem:
      title: Success
      type: object
      required:
        - id
        - list_type
        - payment_field
        - field_value
      properties:
        id:
          type: string
          description: Unique identifier of the fraud prevention list item.
          maxLength: 255
        list_type:
          type: string
          description: Type of fraud prevention list, where <code>pass</code> indicates an allowlist and <code>reject</code> indicates a blocklist.
          enum:
            - pass
            - reject
        payment_field:
          type: string
          description: Payment field to match against the fraud prevention list.
          enum:
            - card_id
            - cardholder
            - customer_id
            - customer_email
            - ip_address
        field_value:
          type: string
          description: |-
            Value of the payment field to match against the fraud prevention list.

            <blockquote>
              <p>Depending on the value provided in <code>payment_field</code>, the corresponding validation rules are enforced.</p>
            </blockquote>
        created_at:
          type: string
          description: Creation date of the list item.
        expired_at:
          type: string
          description: |-
            Expiration date of the list item.

            <blockquote>
              <p>If not provided, the item never expires.</p>
            </blockquote>
        deleted_at:
          type: string
          description: |-
            Deletion date of the list item.

            <blockquote>
              <p>If not provided, the item is not deleted.</p>
            </blockquote>
        description:
          type: string
          description: Reason for adding this item to the list.
          maxLength: 255
        created_by:
          type: string
          description: Email address of the user who created the list item.
          maxLength: 255
          format: email
    ResponseRisksFraudPreventionListItemList:
      title: Success
      type: object
      required:
        - items
        - metadata
      properties:
        items:
          type: array
          description: Fraud prevention list items.
          items:
            $ref: '#/components/schemas/ResponseRisksFraudPreventionListListItem'
        metadata:
          type: object
          description: Metadata object containing pagination and count information.
          required:
            - next_page_iterator
            - count
          properties:
            next_page_iterator:
              type: string
              description: |-
                Reference point for retrieving the next page of results

                <blockquote>
                  <p>If this value is <code>null</code>, it indicates that all available data has been successfully retrieved by the merchant.</p>
                </blockquote>
            count:
              type: integer
              description: Number of list rules on the page.
    RequestRisksDisputeRepresentmentsCreateCard:
      title: RequestRisksDisputeRepresentmentsCreateCard
      type: object
      required:
        - dispute_type
        - dispute_id
        - evidence_file_id
      properties:
        dispute_type:
          type: string
          description: Type of represented dispute.
          enum:
            - card
        dispute_id:
          type: string
          description: Identifier of the represented dispute that corresponds to the <code>orders</code> <code>chargebacks</code> <code>id</code> in <a href="https://api-docs.solidgate.com/#tag/Reports/operation/retrieve-card-chargebacks" target="_blank">chargebacks</a>.
        evidence_file_id:
          type: string
          description: |-
            Unique identifier of the evidence file.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> with a <a href="https://docs.solidgate.com/risks/chargebacks/#respond-to-chargebacks" target="_blank">file</a> size not exceeding 2 MB (2097152 bytes).</p>
            </blockquote>
    RequestRisksDisputeRepresentmentsCreatePaypal:
      title: RequestRisksDisputeRepresentmentsCreatePaypal
      type: object
      required:
        - dispute_type
        - dispute_id
        - evidence_file_id
      properties:
        dispute_type:
          type: string
          description: Type of represented dispute.
          enum:
            - paypal
        dispute_id:
          type: string
          description: Identifier of the represented dispute that corresponds to the <code>dispute_id</code> parameter in <a href="https://api-docs.solidgate.com/#tag/Reports/operation/retrieve-apm-paypal-disputes" target="_blank">PayPal</a> disputes.
        evidence_file_id:
          type: string
          description: |-
            Unique identifier of the evidence file.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> with a <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/manage/#dispute-representment" target="_blank">file</a> size not exceeding 10 MB (10485760 bytes).</p>
            </blockquote>
    RequestRisksDisputeRepresentmentsCreateDiscriminator:
      title: SchemaRisksDisputeRepresentmentsCreateDiscriminator
      type: object
      discriminator:
        propertyName: dispute_type
        mapping:
          card: '#/components/schemas/RequestRisksDisputeRepresentmentsCreateCard'
          paypal: '#/components/schemas/RequestRisksDisputeRepresentmentsCreatePaypal'
    ResponseRisksDisputeRepresentmentsCreate:
      title: Success
      type: object
      required:
        - id
      properties:
        id:
          type: string
          description: Unique identifier of the created dispute representment.
          maxLength: 255
    ResponseRisksBadRequest:
      type: object
      properties:
        error:
          required:
            - code
            - message
          type: object
          description: Error object.
          properties:
            code:
              type: string
              description: Error code.
              example: '2.01'
            message:
              type: string
              description: Error message.
              example: Validation error
            constraints:
              type: object
              description: Map of constraints.
              additionalProperties:
                type: array
                description: Dynamic map where keys represent the field names that failed validation, and values are arrays of objects detailing the constraint violations.
                items:
                  properties:
                    code:
                      type: string
                      description: Error code.
                      example: NotNull
                    message:
                      type: string
                      description: Error message.
                      example: must not be null
      required:
        - error
    SchemaRisksErrorDisputeNotFound:
      title: SchemaRisksErrorDisputeNotFound
      type: object
      properties:
        code:
          type: string
          description: Error 2.01 code.
          enum:
            - '2.01'
          example: '2.01'
        message:
          type: string
          description: |-
            Dispute not found.

            <blockquote>
            <p>Specified dispute not found in the system.</p>
            </blockquote>
      required:
        - code
        - message
    SchemaRisksErrorFileNotFound:
      title: SchemaRisksErrorFileNotFound
      type: object
      properties:
        code:
          type: string
          description: Error 2.01 code.
          enum:
            - '2.01'
          example: '2.01'
        message:
          type: string
          description: |-
            File not found.

            <blockquote>
            <p>File with provided ID not found.</p>
            </blockquote>
      required:
        - code
        - message
    SchemaRisksErrorNotFoundDiscriminator:
      title: SchemaRisksErrorNotFoundDiscriminator
      description: Error object.
      properties:
        code:
          type: string
      discriminator:
        propertyName: code
        mapping:
          2.01 Dispute not found: '#/components/schemas/SchemaRisksErrorDisputeNotFound'
          2.01 File not found: '#/components/schemas/SchemaRisksErrorFileNotFound'
    ResponseRisksNotFoundError:
      title: Error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/SchemaRisksErrorNotFoundDiscriminator'
      required:
        - error
    SchemaRisksErrorFileNotReady:
      title: SchemaRisksErrorFileNotReady
      type: object
      properties:
        code:
          type: string
          description: Error 2.01 code.
          enum:
            - '2.01'
          example: '2.01'
        message:
          type: string
          description: |-
            File not ready.

            <blockquote>
              <p>File object was created, but its content uploaded was not completed yet.</p>
            </blockquote>
      required:
        - code
        - message
    SchemaRisksErrorFileSizeExceeded:
      title: SchemaRisksErrorFileSizeExceeded
      type: object
      properties:
        code:
          type: string
          description: Error 2.01 code.
          enum:
            - '2.01'
          example: '2.01'
        message:
          type: string
          description: |-
            File size exceeded.

            <blockquote>
              <p>Evidence file size exceeds the limit for the requested dispute type.</p>
            </blockquote>
      required:
        - code
        - message
    SchemaRisksErrorFileTypeNotSupported:
      title: SchemaRisksErrorFileTypeNotSupported
      type: object
      properties:
        code:
          type: string
          description: Error 2.01 code.
          enum:
            - '2.01'
          example: '2.01'
        message:
          type: string
          description: |-
            File type not supported.

            <blockquote>
              <p>Evidence file type is not suitable for dispute representment.</p>
            </blockquote>
      required:
        - code
        - message
    SchemaRisksErrorRepresentmentExists:
      title: SchemaRisksErrorRepresentmentExists
      type: object
      properties:
        code:
          type: string
          description: Error 2.01 code.
          enum:
            - '2.01'
          example: '2.01'
        message:
          type: string
          description: Representment already exists.
      required:
        - code
        - message
    SchemaRisksErrorRepresentmentNotPossible:
      title: SchemaRisksErrorRepresentmentNotPossible
      type: object
      properties:
        code:
          type: string
          description: Error 2.01 code.
          enum:
            - '2.01'
          example: '2.01'
        message:
          type: string
          description: |-
            Representment not possible.

            <blockquote>
              <p>The representment is not possible due to the current state of the dispute.</p>
            </blockquote>
      required:
        - code
        - message
    SchemaRisksErrorDiscriminator:
      title: SchemaRisksErrorDiscriminator
      description: Error object.
      properties:
        code:
          type: string
      discriminator:
        propertyName: code
        mapping:
          2.01 File not ready: '#/components/schemas/SchemaRisksErrorFileNotReady'
          2.01 File size exceeded: '#/components/schemas/SchemaRisksErrorFileSizeExceeded'
          2.01 File type not supported: '#/components/schemas/SchemaRisksErrorFileTypeNotSupported'
          2.01 Representment already exists: '#/components/schemas/SchemaRisksErrorRepresentmentExists'
          2.01 Representment not possible: '#/components/schemas/SchemaRisksErrorRepresentmentNotPossible'
    ResponseRisksError:
      title: Error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/SchemaRisksErrorDiscriminator'
      required:
        - error
    SchemaRisksRepresentmentEnrichmentContentItem:
      title: SchemaRisksRepresentmentEnrichmentContentItem
      description: Single block of dispute representment enrichment.
      type: object
      required:
        - file_id
      properties:
        file_id:
          type: string
          description: |-
            Unique identifier of the enrichment content file.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> one of extensions jpg, jpeg, png. File size does not exceed 0.5 MB (524288 bytes).</p>
            </blockquote>
        annotation:
          type: string
          maxLength: 500
          description: Annotation for the enrichment file.
    SchemaRisksRepresentmentEnrichmentContent:
      title: SchemaRisksRepresentmentEnrichmentContent
      description: Additional enrichment content for dispute representment.
      type: object
      properties:
        proof_of_communication:
          type: array
          description: Emails, chat logs, or support tickets showing cardholder interaction.
          maxItems: 3
          items:
            $ref: '#/components/schemas/SchemaRisksRepresentmentEnrichmentContentItem'
        application_logs:
          type: array
          description: System logs providing technical evidence of the transaction or user activity.
          maxItems: 3
          items:
            $ref: '#/components/schemas/SchemaRisksRepresentmentEnrichmentContentItem'
        proof_of_delivery:
          type: array
          description: Shipping confirmations, tracking info, or signed delivery receipts.
          maxItems: 3
          items:
            $ref: '#/components/schemas/SchemaRisksRepresentmentEnrichmentContentItem'
        invoice:
          type: array
          description: Invoice documents with itemized charges and billing details.
          maxItems: 3
          items:
            $ref: '#/components/schemas/SchemaRisksRepresentmentEnrichmentContentItem'
        receipts:
          type: array
          description: Transaction receipts or payment confirmations.
          maxItems: 3
          items:
            $ref: '#/components/schemas/SchemaRisksRepresentmentEnrichmentContentItem'
        other:
          type: array
          description: Additional supporting documents not covered by other categories.
          maxItems: 3
          items:
            $ref: '#/components/schemas/SchemaRisksRepresentmentEnrichmentContentItem'
    RequestRisksDisputeRepresentmentsEnrichCard:
      title: RequestRisksDisputeRepresentmentsEnrichCard
      type: object
      required:
        - dispute_type
        - dispute_id
        - enrichment
      properties:
        dispute_type:
          type: string
          description: Type of represented dispute.
          enum:
            - card
        dispute_id:
          type: string
          description: Identifier of the represented dispute that corresponds to the <code>orders</code> <code>chargebacks</code> <code>id</code> in <a href="https://api-docs.solidgate.com/#tag/Reports/operation/retrieve-card-chargebacks" target="_blank">chargebacks</a>.
        enrichment:
          $ref: '#/components/schemas/SchemaRisksRepresentmentEnrichmentContent'
        submit:
          type: boolean
          default: true
          description: |-
            Submit the dispute representment after including provided enrichment content. 
            If set to <code>false</code>, the representment file with enrichment content will be created, 
            but not submitted immediately. 
    RequestRisksDisputeRepresentmentsEnrichPayPal:
      title: RequestRisksDisputeRepresentmentsEnrichPayPal
      type: object
      required:
        - dispute_type
        - dispute_id
        - enrichment
      properties:
        dispute_type:
          type: string
          description: Type of represented dispute.
          enum:
            - paypal
        dispute_id:
          type: string
          description: Identifier of the represented dispute that corresponds to the <code>dispute_id</code> parameter in <a href="https://api-docs.solidgate.com/#tag/Reports/operation/retrieve-apm-paypal-disputes" target="_blank">PayPal</a> disputes.
        enrichment:
          $ref: '#/components/schemas/SchemaRisksRepresentmentEnrichmentContent'
        submit:
          type: boolean
          default: true
          description: |-
            Submit the dispute representment after including provided enrichment content. 
            If set to <code>false</code>, the representment file with enrichment content will be created, 
            but not submitted immediately. 
    RequestRisksDisputeRepresentmentsEnrichDiscriminator:
      title: SchemaRisksDisputeRepresentmentsEnrichDiscriminator
      type: object
      oneOf:
        - $ref: '#/components/schemas/RequestRisksDisputeRepresentmentsEnrichCard'
        - $ref: '#/components/schemas/RequestRisksDisputeRepresentmentsEnrichPayPal'
      discriminator:
        propertyName: dispute_type
        mapping:
          card: '#/components/schemas/RequestRisksDisputeRepresentmentsEnrichCard'
          paypal: '#/components/schemas/RequestRisksDisputeRepresentmentsEnrichPayPal'
    ResponseRisksDisputeRepresentmentsEnrich:
      title: Success
      type: object
      description: Empty response body for successful enrichment request.
      additionalProperties: false
    SchemaRisksErrorTotalFileSizeExceeded:
      title: SchemaRisksErrorTotalFileSizeExceeded
      type: object
      properties:
        code:
          type: string
          description: Error 2.01 code.
          enum:
            - '2.01'
          example: '2.01'
        message:
          type: string
          description: |-
            Total files size exceeded.

            <blockquote>
              <p>Total size of evidence enrichment files exceeds the limit for the requested dispute.</p>
            </blockquote>
      required:
        - code
        - message
    SchemaRisksErrorEnrichmentNotPossible:
      title: SchemaRisksErrorEnrichmentNotPossible
      type: object
      properties:
        code:
          type: string
          description: Error 2.01 code.
          enum:
            - '2.01'
          example: '2.01'
        message:
          type: string
          description: |-
            Representment enrichment not possible.

            <blockquote>
              <p>The representment enrichment is not possible due to the current state of the dispute representment.</p>
            </blockquote>
      required:
        - code
        - message
    SchemaRisksEnrichErrorDiscriminator:
      title: SchemaRisksEnrichErrorDiscriminator
      description: Error object.
      properties:
        code:
          type: string
      discriminator:
        propertyName: code
        mapping:
          2.01 File not ready: '#/components/schemas/SchemaRisksErrorFileNotReady'
          2.01 File size exceeded: '#/components/schemas/SchemaRisksErrorFileSizeExceeded'
          2.01 Total files size exceeded: '#/components/schemas/SchemaRisksErrorTotalFileSizeExceeded'
          2.01 File type not supported: '#/components/schemas/SchemaRisksErrorFileTypeNotSupported'
          2.01 Enrichment not possible: '#/components/schemas/SchemaRisksErrorEnrichmentNotPossible'
    ResponseRisksEnrichError:
      title: Error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/SchemaRisksEnrichErrorDiscriminator'
      required:
        - error
    RequestFilesCreateFileUpload:
      type: object
      required:
        - file_name
        - file_type
        - file_size
      properties:
        file_name:
          type: string
          description: |-
            Name of the file, including its extension.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> one of extensions jpg, jpeg, png, gif, txt, pdf, doc, docx, rtf, xls, xlsx.</p>
            </blockquote>
          example: document.pdf
          pattern: ^[\w,\s-]+\.[A-Za-z]{3,4}$
          minLength: 1
          maxLength: 255
        file_type:
          type: string
          description: |-
            Mime type of the file, must match the extension.

            <blockquote style="border-left: 4px solid #D1E6DF; ">
              <p><b>Should be provided</b> one of the following mime types image/jpeg for .jpg/.jpeg, image/png for .png, image/gif for .gif, etc.</p>
            </blockquote>
          example: application/pdf
        file_size:
          type: integer
          description: Size of the file in bytes.
          example: 1024000
          minimum: 1
          maximum: 52428800
          exclusiveMaximum: true
    ResponseFilesCreateFileUpload:
      title: Success
      type: object
      required:
        - file_id
        - upload_url
      properties:
        file_id:
          type: string
          description: Unique identifier of the uploaded file.
          maxLength: 255
        upload_url:
          type: string
          description: Pre-signed URL for file content upload.
          format: uri
    SchemaFilesErrorFileInvalidRequest:
      title: SchemaFilesErrorFileInvalidRequest
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Error 2.01 code.
          enum:
            - '2.01'
          example: '2.01'
        message:
          type: string
          description: |-
            Invalid request.

            <blockquote>
              <p>Missing or incorrect parameters.</p>
            </blockquote>
        constraints:
          type: object
          description: Constraints for invalid request parameters.
          properties:
            file_type:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Error code for invalid file extension.
                    example: InvalidExtension
                  message:
                    type: string
                    description: Message explaining why the file extension is not supported.
                    example: file_type extension is not supported
            file_size:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Error code for invalid file size.
                    example: InvalidSize
                  message:
                    type: string
                    description: Message explaining why the file size is not allowed.
                    example: file_size must be less than 52428800 bytes
    SchemaFilesErrorFileSizeExceeded:
      title: SchemaFilesErrorFileSizeExceeded
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Error 2.01 code.
          enum:
            - '2.01'
          example: '2.01'
        message:
          type: string
          description: |-
            File size exceeded.

            <blockquote>
              <p>Evidence file size exceeds the allowed limit.</p>
            </blockquote>
    SchemaFilesErrorFileTypeNotSupported:
      title: SchemaFilesErrorFileTypeNotSupported
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Error 2.01 code.
          enum:
            - '2.01'
          example: '2.01'
        message:
          type: string
          description: |-
            File type not supported.

            <blockquote>
              <p>Evidence file type is not suitable.</p>
            </blockquote>
    SchemaFilesErrorDiscriminator:
      title: SchemaFilesErrorDiscriminator
      description: Error object.
      properties:
        code:
          type: string
      discriminator:
        propertyName: code
        mapping:
          2.01 Invalid request: '#/components/schemas/SchemaFilesErrorFileInvalidRequest'
          2.01 File size exceeded: '#/components/schemas/SchemaFilesErrorFileSizeExceeded'
          2.01 File type not supported: '#/components/schemas/SchemaFilesErrorFileTypeNotSupported'
    ResponseFilesError:
      title: Error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/SchemaFilesErrorDiscriminator'
      required:
        - error
    SchemaWebhooksStatus:
      title: WebhookEndpointStatus
      type: string
      description: Webhook endpoint status.
      enum:
        - active
        - inactive
      default: active
    ResponseWebhooks:
      title: Success
      type: object
      description: Response object for a webhook endpoint.
      properties:
        id:
          type: string
          description: Webhook endpoint identifier.
        url:
          type: string
          description: URL for webhook event delivery.
        event_types:
          type: array
          description: List of <a href="https://docs.solidgate.com/payments/integrate/webhooks/#manage-webhooks" target="_blank">event types</a> the webhook endpoint is subscribed to.
          items:
            type: string
        name:
          type: string
          description: Field for storing the webhook configuration name.
        status:
          $ref: '#/components/schemas/SchemaWebhooksStatus'
        created_at:
          type: string
          description: Date when the webhook endpoint was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Date when the webhook endpoint was last updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
    ResponseWebhookEndpointList:
      title: Success
      type: object
      properties:
        data:
          type: array
          description: Contains an array of webhook data, each representing a specific webhook configuration.
          items:
            $ref: '#/components/schemas/ResponseWebhooks'
        pagination:
          type: object
          description: Contains information about the pagination of the results.
          properties:
            offset:
              type: integer
              description: Starting index of the returned results.
              example: 20
            limit:
              type: integer
              description: Maximum number of items to return.
              example: 10
            total_count:
              type: integer
              description: Total count of the webhook endpoints available.
              example: 150
          required:
            - offset
            - limit
            - total_count
    ResponseWebhooksInvalidRequest:
      title: Error
      type: object
      properties:
        error:
          type: object
          description: Error object.
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Error 2.01 code.
              enum:
                - '2.01'
            message:
              type: string
              description: |-
                Invalid request.

                <blockquote>
                  <p>Missing or incorrect parameters.</p>
                </blockquote>
            constraints:
              type: object
              description: |-
                An object containing validation errors for specific fields. 
                Keys are field names, and values are lists of violations with error codes and messages.
    SchemaWebhooksEventType:
      title: WebhookEndpointEventType
      type: string
      enum:
        - card_gate.order.updated
        - card_gate.chargeback.received
        - card_gate.fraud_alert.received
        - card_gate.prevention_alert.received
        - subscription.updated
        - subscription.updated.v2
        - alt_gate.order.updated
        - alt_gate.paypal_dispute.received
        - card.network_token.created
        - card.network_token.updated
        - taxer.tax.calculated
        - alt_gate.recurring_token.cancelled
    RequestWebhooksEndpointCreate:
      title: RequestWebhookEndpointCreate
      type: object
      required:
        - url
        - event_types
      properties:
        url:
          type: string
          description: URL for webhook event delivery.
          maxLength: 512
        event_types:
          type: array
          description: List of <a href="https://docs.solidgate.com/payments/integrate/webhooks/#manage-webhooks" target="_blank">event types</a> the webhook endpoint is subscribed to.
          items:
            $ref: '#/components/schemas/SchemaWebhooksEventType'
        name:
          type: string
          description: Field for storing the webhook configuration name.
          maxLength: 255
        status:
          $ref: '#/components/schemas/SchemaWebhooksStatus'
    ResponseWebhooksEndpointAlreadyExists:
      title: Endpoint exists
      type: object
      properties:
        error:
          type: object
          description: Error object.
          properties:
            code:
              type: string
              description: Error code.
            message:
              type: string
              description: Error message.
          required:
            - code
            - message
      required:
        - error
    RequestWebhooksEndpointUpdate:
      title: RequestWebhookEndpointUpdate
      type: object
      properties:
        event_types:
          type: array
          description: List of <a href="https://docs.solidgate.com/payments/integrate/webhooks/#manage-webhooks" target="_blank">event types</a> the webhook endpoint is subscribed to.
          items:
            $ref: '#/components/schemas/SchemaWebhooksEventType'
        name:
          type: string
          description: Field for storing the webhook configuration name.
          maxLength: 255
        url:
          type: string
          description: URL for webhook event delivery.
          maxLength: 512
        status:
          $ref: '#/components/schemas/SchemaWebhooksStatus'
    ResponseWebhooksEndpointNotFound:
      title: Endpoint not found
      type: object
      properties:
        error:
          type: object
          description: Error object.
          properties:
            code:
              type: string
              description: Error code.
            message:
              type: string
              description: Error message.
          required:
            - code
            - message
      required:
        - error
    HeaderMainMerchantWebhook:
      type: string
      description: Unique <a href="https://docs.solidgate.com/payments/integrate/webhooks/#security" target="_blank">public key</a> provided upon registration and must be shared for identification purposes.
      example: wh_pk_7b197...ba108f842
    RequestCardsWebhookOrderStatus:
      title: RequestWebhookCardsOrderStatus
      type: object
      properties:
        order:
          type: object
          description: Information about the order, including identifiers, timestamps, amounts, status, and customer details.
          properties:
            order_id:
              type: string
              description: |-
                Unique order identifier, which can be used to find the payment.

                <blockquote>
                  <p>For the first payment, the identifier is defined by the merchant.</p>
                  <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                </blockquote>
              maxLength: 255
              example: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
            order_description:
              type: string
              description: Brief description of the order.
              maxLength: 255
              example: Premium package
            psp_order_id:
              type: string
              description: PSP identifier generated by Solidgate.
            provider_payment_id:
              type: string
              description: |-
                PSP identifier generated by the PSP.

                <blockquote>
                  <p>Value will be if the integration transmitted this data.</p>
                </blockquote>
            product_id:
              type: string
              format: uuid
              maxLength: 36
              minLength: 36
              description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
            product_name:
              type: string
              description: <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">Product</a> name.
              minLength: 1
              maxLength: 500
            subscription_id:
              type: string
              description: Unique subscription identifier.
              format: uuid
              maxLength: 36
              minLength: 36
              example: 83b19018-cbc4-4df0-899a-dda84fd2705e
            amount:
              type: integer
              description: |-
                Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

                <blockquote>
                  <p>This is the intended initial authorization amount.</p>
                  <p>For instance, 1020 means 10 EUR and 20 cents.</p>
                </blockquote>
              example: 100
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
              minLength: 3
              maxLength: 3
              example: USD
            processing_amount:
              type: integer
              description: |-
                Amount of the payment in the smallest currency unit as it was processed by the payment service provider.

                <blockquote>
                  <p>This amount may differ from the original order amount due to currency conversion or other processing factors.</p>
                </blockquote>
            processing_currency:
              type: string
              minLength: 3
              maxLength: 3
              description: |-
                Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the payment when it was processed by payment service provider.

                <blockquote>
                  <p>In some cases, it is different from the original currency.</p>
                </blockquote>
            marketing_amount:
              type: integer
              description: |-
                Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date.

                <blockquote>
                  <p>This is based on the intended initial authorization amount.</p>
                  <p>It should not be considered financial information, but it can be used for forecasting.</p>
                </blockquote>
            marketing_currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the currency used for calculation of marketing amount.
              example: USD
            refunded_amount:
              type: integer
              description: Indicates the amount that has been already refunded.
            authorized_amount:
              type: integer
              description: Total authorized amount of the order.
            status:
              type: string
              description: |-
                <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.

                <blockquote>
                  <p>In the case of <code>auth_failed</code>, an <code>error</code> object will be returned at the order level.</p>
                </blockquote>
              enum:
                - processing
                - 3ds_verify
                - refunded
                - auth_ok
                - auth_failed
                - settle_ok
                - partial_settled
                - void_ok
              example: processing
            auth_code:
              type: string
              description: |-
                Transaction authorization code.

                <blockquote>
                  <p>It can be empty if the provider does not pass a value.</p>
                </blockquote>
              example: 2w9m8
            payment_type:
              type: string
              description: Payment <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#payment-type" target="_blank">type</a> that defines if the transaction is customer-initiated (CIT) or merchant-initiated (MIT) and helps to define if a cardholder authentication can be provided.
              enum:
                - 1-click
                - recurring
                - retry
                - installment
                - rebill
                - moto
            payment_method:
              type: string
              description: Payment method used for the transaction.
              enum:
                - card
                - network-token
                - token
                - apple-pay
                - google-pay
            customer_account_id:
              type: string
              description: Unique customer identifier defined by the merchant.
              maxLength: 100
              example: 93a1c659-288d-4d62-929d-10e241078faa
            customer_email:
              type: string
              description: Customer's email address.
              maxLength: 100
              example: example@example.com
            descriptor:
              type: string
              description: |-
                Identifying text that appears on a customer’s credit or debit card statement.

                <blockquote>
                  <p>It includes information about the transaction and helps the cardholder recognize the charge.</p>
                </blockquote>
              example: google.com
            mid:
              type: string
              description: Merchant identifier in Solidgate.
              example: bank-mid-1
            ip_address:
              type: string
              description: |-
                Public IP address of the cardholder, both IPv4 and IPv6 are supported.

                <blockquote>                
                  <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
                </blockquote>
              maxLength: 50
            traffic_source:
              type: string
              description: Identifies the marketing or acquisition channel that brought the customer to the transaction.
              maxLength: 255
              example: facebook
            fraudulent:
              type: boolean
              description: Whether the merchant system has flagged this customer as suspicious.
              deprecated: true
              default: false
        error:
          description: |-
            <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">Error</a> object.

            <blockquote>
              <p>Returned only in cases of <code>auth_failed</code> status at the order, and <code>fail</code> status at transaction.</p>
            </blockquote>
          allOf:
            - $ref: '#/components/schemas/SchemaCardsDiscriminatorErrorSuccess'
        transaction:
          description: Details of a card transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.
          properties:
            id:
              type: string
              description: Unique transaction identifier.
              maxLength: 100
            created_at:
              type: string
              description: Datetime when the transaction was created.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime when the transaction was updated.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            amount:
              type: integer
              description: |-
                Transaction amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

                <blockquote>
                  <p>For instance, 1020 means 10 EUR and 20 cents.</p>
                </blockquote>
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the transaction.
              maxLength: 3
              minLength: 3
            marketing_amount:
              type: integer
              description: |-
                Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date.

                <blockquote>
                  <p>It should not be considered financial information, but it can be used for forecasting.</p>
                </blockquote>
            marketing_currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the currency used for calculation of marketing amount.
              example: USD
            operation:
              type: string
              description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
              enum:
                - recurring-auth
                - refund
                - resign-auth
                - auth
                - settle
                - void
                - apple-pay
                - google-pay
            status:
              type: string
              description: |-
                <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.

                <blockquote>
                  <p>In the case of <code>fail</code>, an <code>error</code> object will be returned at the transaction level.</p>
                </blockquote>
              enum:
                - processing
                - success
                - fail
                - verify
            authorization_type:
              type: string
              enum:
                - final
                - estimated
                - incremental
              description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
            scheme_transaction_id:
              type: string
              description: Card-scheme transaction identifier linking this transaction to the original customer-initiated payment.
            transaction_link_id:
              type: string
              description: Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.
              maxLength: 255
            descriptor:
              type: string
              description: |-
                Identifying text that appears on a customer’s credit or debit card statement.

                <blockquote>
                  <p>It includes information about the transaction and helps the cardholder recognize the charge.</p>
                </blockquote>
            billing_details:
              $ref: '#/components/schemas/SchemaCardsBillingDetails'
            refund_reason:
              type: string
              description: Text description of the refund reason.
            refund_reason_code:
              type: string
              description: |-
                Code representing the <a href="https://docs.solidgate.com/payments/payments-insights/refund-reasons/" target="_blank">reason</a> for the refund.

                <blockquote>
                  <p>This code is used to identify the reason for both <code>void</code> and <code>refund</code> transactions <code>operation</code></p>
                </blockquote>
              minLength: 4
              maxLength: 4
            card_token:
              title: CardTokenModel
              type: object
              description: Token associated with a card method that can be used for subsequent payments.
              properties:
                token:
                  type: string
                  description: |-
                    Token generated for a card method, enabling its use for future payments.

                    <blockquote>
                    <p>The <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> is not generated for all types of payment flows.</p>
                    </blockquote>
                original_payment_method:
                  type: string
                  description: Payment method used to capture the card credentials at <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> creation.
                  enum:
                    - card
                    - apple-pay
                    - google-pay
                    - network-token
                    - click-to-pay
                  example: card
            card:
              description: Object containing detailed information about the card used in the transaction.
              type: object
              properties:
                bank:
                  type: string
                  description: Name of the card issuer.
                bin:
                  type: string
                  minLength: 6
                  maxLength: 6
                  description: Card issuer's Bank Identification Number (BIN).
                brand:
                  type: string
                  description: Card brand.
                card_exp_month:
                  type: string
                  description: Expiry month of the card.
                  minLength: 2
                  maxLength: 2
                card_exp_year:
                  type: integer
                  description: Expiry year of the card.
                card_holder:
                  type: string
                  description: |-
                    Cardholder's name as it appears on the card, which is essential for transaction processing.

                    <blockquote style="border-left: 4px solid #D1E6DF; ">
                      <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
                    </blockquote>
                  minLength: 2
                  maxLength: 52
                  pattern: ^\w.{0,50}[\w.]$
                  example: John Snow
                card_type:
                  type: string
                  description: Card type.
                  enum:
                    - CREDIT
                    - CREDIT/DEBIT
                    - DEBIT
                    - PREPAID
                    - CHARGE CARD
                    - DEFERRED DEBIT
                is_reloadable:
                  type: boolean
                  description: |-
                    <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#reloadable-prepaid-indicator" target="_blank">Indicator</a> of whether the card belongs to a reloadable program.

                    <blockquote>
                      <p><code>null</code> means the reloadable indicator is not available.</p>
                    </blockquote>
                card_id:
                  type: string
                  description: Unique identifier of the card used for the transaction.
                  format: uuid
                country:
                  type: string
                  description: Card issuer's country.
                  format: iso_code_a3
                  maxLength: 3
                  minLength: 3
                number:
                  type: string
                  description: Masked card number.
                  maxLength: 19
                card_token:
                  title: CardTokenModel
                  type: object
                  description: Token associated with a card method that can be used for subsequent payments.
                  properties:
                    token:
                      type: string
                      description: |-
                        Token generated for a card method, enabling its use for future payments.

                        <blockquote>
                        <p>The <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> is not generated for all types of payment flows.</p>
                        </blockquote>
                    original_payment_method:
                      type: string
                      description: Payment method used to capture the card credentials at <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> creation.
                      enum:
                        - card
                        - apple-pay
                        - google-pay
                        - network-token
                        - click-to-pay
                      example: card
            error:
              $ref: '#/components/schemas/SchemaCardsDiscriminatorErrorSuccess'
            payment_account_reference:
              type: string
              description: Payment Account Reference (PAR) is a unique, non-financial identifier for a payment account that remains consistent across card replacements.
              example: PAR_1A2B3C4D5E6F7G8H9
            arn_code:
              type: string
              description: |-
                Acquirer Reference Number (ARN) assigned to transactions.

                <blockquote>
                  <p>Use ARN to check transaction <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">status</a>.</p>
                </blockquote>
              example: '12345678901234567890123'
            rrn_code:
              type: string
              description: Retrieval Reference Number (RRN) assigned to transactions, based on the <a href="https://en.wikipedia.org/wiki/ISO_8583" target="_blank">ISO 8583</a> standard.
              minLength: 12
              maxLength: 12
              example: '100034876543'
        transactions:
          type: object
          description: Map of transactions where the keys are transaction identifiers.
          properties:
            <transaction_id_value_#1>:
              description: Details of a card transaction, including identifiers, timestamps, amounts, currency, operation type, status, and other relevant data.
              properties:
                id:
                  type: string
                  description: Unique transaction identifier.
                  maxLength: 100
                created_at:
                  type: string
                  description: Datetime when the transaction was created.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                updated_at:
                  type: string
                  description: Datetime when the transaction was updated.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: |-
                    Transaction amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

                    <blockquote>
                      <p>For instance, 1020 means 10 EUR and 20 cents.</p>
                    </blockquote>
                currency:
                  type: string
                  description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the transaction.
                  maxLength: 3
                  minLength: 3
                marketing_amount:
                  type: integer
                  description: |-
                    Order amount converted to USD, or other currency as agreed, using a publicly available rate at the payment date.

                    <blockquote>
                      <p>It should not be considered financial information, but it can be used for forecasting.</p>
                    </blockquote>
                marketing_currency:
                  type: string
                  description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the currency used for calculation of marketing amount.
                  example: USD
                operation:
                  type: string
                  description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                  enum:
                    - recurring-auth
                    - refund
                    - resign-auth
                    - auth
                    - settle
                    - void
                    - apple-pay
                    - google-pay
                status:
                  type: string
                  description: |-
                    <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.

                    <blockquote>
                      <p>In the case of <code>fail</code>, an <code>error</code> object will be returned at the transaction level.</p>
                    </blockquote>
                  enum:
                    - processing
                    - success
                    - fail
                    - verify
                authorization_type:
                  type: string
                  enum:
                    - final
                    - estimated
                    - incremental
                  description: Authorization <a href="https://docs.solidgate.com/payments/card-payments/estimated-and-incremental-auth/#authorization-type" target="_blank">type</a> that defines the transaction flow and capabilities.
                scheme_transaction_id:
                  type: string
                  description: Card-scheme transaction identifier linking this transaction to the original customer-initiated payment.
                transaction_link_id:
                  type: string
                  description: Transaction link identifier (<a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/mastercard-transaction-link-identifier/" target="_blank">TLID</a>) is an ID generated by Mastercard to link lifecycle activity after the original transaction.
                  maxLength: 255
                descriptor:
                  type: string
                  description: |-
                    Identifying text that appears on a customer’s credit or debit card statement.

                    <blockquote>
                      <p>It includes information about the transaction and helps the cardholder recognize the charge.</p>
                    </blockquote>
                billing_details:
                  $ref: '#/components/schemas/SchemaCardsBillingDetails'
                refund_reason:
                  type: string
                  description: Text description of the refund reason.
                refund_reason_code:
                  type: string
                  description: |-
                    Code representing the <a href="https://docs.solidgate.com/payments/payments-insights/refund-reasons/" target="_blank">reason</a> for the refund.

                    <blockquote>
                      <p>This code is used to identify the reason for both <code>void</code> and <code>refund</code> transactions <code>operation</code></p>
                    </blockquote>
                  minLength: 4
                  maxLength: 4
                card_token:
                  title: CardTokenModel
                  type: object
                  description: Token associated with a card method that can be used for subsequent payments.
                  properties:
                    token:
                      type: string
                      description: |-
                        Token generated for a card method, enabling its use for future payments.

                        <blockquote>
                        <p>The <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> is not generated for all types of payment flows.</p>
                        </blockquote>
                    original_payment_method:
                      type: string
                      description: Payment method used to capture the card credentials at <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> creation.
                      enum:
                        - card
                        - apple-pay
                        - google-pay
                        - network-token
                        - click-to-pay
                      example: card
                card:
                  description: Object containing detailed information about the card used in the transaction.
                  type: object
                  properties:
                    bank:
                      type: string
                      description: Name of the card issuer.
                    bin:
                      type: string
                      minLength: 6
                      maxLength: 6
                      description: Card issuer's Bank Identification Number (BIN).
                    brand:
                      type: string
                      description: Card brand.
                    card_exp_month:
                      type: string
                      description: Expiry month of the card.
                      minLength: 2
                      maxLength: 2
                    card_exp_year:
                      type: integer
                      description: Expiry year of the card.
                    card_holder:
                      type: string
                      description: |-
                        Cardholder's name as it appears on the card, which is essential for transaction processing.

                        <blockquote style="border-left: 4px solid #D1E6DF; ">
                          <p><b>Should be provided</b> as the cardholder's name to ensure accurate cardholder information and increase conversions. For some PSPs, if not provided, it is set to John Snow.</p>
                        </blockquote>
                      minLength: 2
                      maxLength: 52
                      pattern: ^\w.{0,50}[\w.]$
                      example: John Snow
                    card_type:
                      type: string
                      description: Card type.
                      enum:
                        - CREDIT
                        - CREDIT/DEBIT
                        - DEBIT
                        - PREPAID
                        - CHARGE CARD
                        - DEFERRED DEBIT
                    is_reloadable:
                      type: boolean
                      description: |-
                        <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#reloadable-prepaid-indicator" target="_blank">Indicator</a> of whether the card belongs to a reloadable program.

                        <blockquote>
                          <p><code>null</code> means the reloadable indicator is not available.</p>
                        </blockquote>
                    card_id:
                      type: string
                      description: Unique identifier of the card used for the transaction.
                      format: uuid
                    country:
                      type: string
                      description: Card issuer's country.
                      format: iso_code_a3
                      maxLength: 3
                      minLength: 3
                    number:
                      type: string
                      description: Masked card number.
                      maxLength: 19
                    card_token:
                      title: CardTokenModel
                      type: object
                      description: Token associated with a card method that can be used for subsequent payments.
                      properties:
                        token:
                          type: string
                          description: |-
                            Token generated for a card method, enabling its use for future payments.

                            <blockquote>
                            <p>The <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> is not generated for all types of payment flows.</p>
                            </blockquote>
                        original_payment_method:
                          type: string
                          description: Payment method used to capture the card credentials at <a href="https://docs.solidgate.com/payments/card-payments/token-usage/" target="_blank">token</a> creation.
                          enum:
                            - card
                            - apple-pay
                            - google-pay
                            - network-token
                            - click-to-pay
                          example: card
                error:
                  $ref: '#/components/schemas/SchemaCardsDiscriminatorErrorSuccess'
                payment_account_reference:
                  type: string
                  description: Payment Account Reference (PAR) is a unique, non-financial identifier for a payment account that remains consistent across card replacements.
                  example: PAR_1A2B3C4D5E6F7G8H9
                arn_code:
                  type: string
                  description: |-
                    Acquirer Reference Number (ARN) assigned to transactions.

                    <blockquote>
                      <p>Use ARN to check transaction <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">status</a>.</p>
                    </blockquote>
                  example: '12345678901234567890123'
                rrn_code:
                  type: string
                  description: Retrieval Reference Number (RRN) assigned to transactions, based on the <a href="https://en.wikipedia.org/wiki/ISO_8583" target="_blank">ISO 8583</a> standard.
                  minLength: 12
                  maxLength: 12
                  example: '100034876543'
        three_ds:
          $ref: '#/components/schemas/SchemaCardsThreeDs'
        routing:
          $ref: '#/components/schemas/SchemaCardsRouting'
        antifraud_result:
          $ref: '#/components/schemas/SchemaCardsAntifraudResult'
        verification_result:
          $ref: '#/components/schemas/SchemaCardsVerificationResult'
        chargebacks:
          type: object
          description: Map of chargebacks where the keys are chargeback identifiers.
          properties:
            id:
              type: integer
              description: Unique chargeback identifier.
              maxLength: 100
            dispute_date:
              type: string
              description: Date on which the chargeback was created by the issuer.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$ || ^\d{4}-\d{2}-\d{2}
            settlement_date:
              type: string
              description: Date on which the chargeback was financially settled.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            amount:
              type: integer
              description: |-
                Amount that will be deducted for the chargeback on a specific order.

                <blockquote>
                  <p>This amount may vary based on the user's decision to dispute a different amount.</p>
                </blockquote>
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the chargeback amount.
              maxLength: 3
              minLength: 3
            type:
              type: string
              description: <a href="https://docs.solidgate.com/risks/chargebacks/#types" target="_blank">Current type</a> of the chargeback.
              enum:
                - 1st_chb
                - 2nd_chb
                - arbitration
            status:
              type: string
              description: <a href="https://docs.solidgate.com/risks/chargebacks/#statuses" target="_blank">Status</a> of the chargeback.
              enum:
                - in_progress
                - document_sent
                - reversed
                - accepted
                - resolved
                - resolved_reversal
            reason_group:
              type: string
              description: |-
                <a href="https://docs.solidgate.com/risks/reason-codes/" target="_blank">Reason code</a> group.

                <blockquote>
                  <p>It could be used for the segmentation and analytic purposes.</p>
                </blockquote>
            reason_code:
              type: string
              description: <a href="https://docs.solidgate.com/risks/reason-codes/" target="_blank">Reason code</a> for the chargeback provided by the card scheme.
            reason_description:
              type: string
              description: <a href="https://docs.solidgate.com/risks/reason-codes/" target="_blank">Reason code</a> description for the chargeback provided by the card scheme.
            chargeback_flow:
              type: array
              description: Map of chargeback flows where the keys are chargeback flow identifiers.
              items:
                properties:
                  id:
                    type: integer
                    description: Unique chargeback flow identifier.
                    maxLength: 100
                  date:
                    type: string
                    description: Datetime when the chargeback flow was created.
                    pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  updated_date:
                    type: string
                    description: Datetime when the chargeback flow was updated.
                    pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  settlement_date:
                    type: string
                    pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                    description: Date when the chargeback flow was financially settled.
                  deadline_date:
                    type: string
                    pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                    description: |-
                      Deadline for submitting a response to the dispute.

                      <blockquote>
                        <p>This corresponds to date + n, where n is a number of calendar days set by the scheme/acquirer.</p>
                      </blockquote>
                  amount:
                    type: integer
                    description: |-
                      Amount involved in each stage of the chargeback process.

                      <blockquote>
                        <p>For example, there could be two records in <code>chargeback_flow</code> one with an amount of 113.58 USD and another with an amount of 100 USD.</p>
                      </blockquote>
                  dispute_amount:
                    type: integer
                    description: |-
                      Specific amount disputed, typically in the smallest currency unit, that would be returned to the merchant if the dispute is resolved in their favor.

                      <blockquote>
                        <p>For example, if the second chargeback was successfully disputed, the <code>dispute_amount</code> would be 100 USD.</p>
                      </blockquote>
                  currency:
                    type: string
                    description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the chargeback amount.
                    minLength: 3
                    maxLength: 3
                  type:
                    type: string
                    description: <a href="https://docs.solidgate.com/risks/chargebacks/#types" target="_blank">Type</a> of the chargeback flow.
                    enum:
                      - 1st_chb
                      - 2nd_chb
                      - arbitration
                  status:
                    type: string
                    description: <a href="https://docs.solidgate.com/risks/chargebacks/#statuses" target="_blank">Status</a> of the chargeback.
                    enum:
                      - in_progress
                      - document_sent
                      - reversed
                      - accepted
                      - resolved
                      - resolved_reversal
                  arn_code:
                    type: string
                    description: |-
                      Acquirer Reference Number (ARN) assigned to transactions.

                      <blockquote>
                        <p>Use ARN to check transaction <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">status</a>.</p>
                      </blockquote>
                  rrn_code:
                    type: string
                    description: Retrieval Reference Number (RRN) assigned to transactions, based on the <a href="https://en.wikipedia.org/wiki/ISO_8583" target="_blank">ISO 8583</a> standard.
                    minLength: 12
                    maxLength: 12
        device_info:
          description: Information about the device used.
          allOf:
            - $ref: '#/components/schemas/SchemaCardsDeviceInfo'
        verify_url:
          type: string
          description: |-
            URL where the customer should be redirected to complete 3DS authentication.

            <blockquote>
              <p>Only after opening the URL and authenticating the order <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">status</a> change to <code>3ds_verify</code>.</p>
            </blockquote>
        redirect_url:
          type: string
          description: URL where customer should be redirected after finishing 3D Secure or redirect payment method.
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        payment_adviser:
          deprecated: true
          allOf:
            - $ref: '#/components/schemas/SchemaCardsPaymentAdviser'
    RequestCardsWebhookNetworkTokenCreated:
      title: RequestWebhookCardsNetworkTokenCreated
      type: object
      properties:
        card_id:
          type: string
          format: uuid
          description: Unique card identifier provided by merchant in the payment request.
        tokenization_type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/card-schemes-tokenization/#tokenization-type" target="_blank">Type</a> of tokenization associated with the card, a process that replaces the card's primary account number (PAN) with a unique digital token to ensure secure transactions.
          enum:
            - vts
            - mdes
            - scof
        status:
          type: string
          description: Network token <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/card-schemes-tokenization/#tokenization-status" target="_blank">status</a>.
          enum:
            - INACTIVE
            - ACTIVE
            - SUSPENDED
            - DEACTIVATED
            - DELETED
        created_at:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          description: Network token creation date.
        updated_at:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          description: Date of network token status update.
    RequestCardsWebhookNetworkTokenUpdated:
      title: RequestWebhookCardsNetworkTokenUpdated
      type: object
      properties:
        card_id:
          type: string
          format: uuid
          description: Unique card identifier provided by merchant in the payment request.
        tokenization_type:
          type: string
          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/card-schemes-tokenization/#tokenization-type" target="_blank">Type</a> of tokenization associated with the card, a process that replaces the card's primary account number (PAN) with a unique digital token to ensure secure transactions.
          enum:
            - vts
            - mdes
            - scof
        status:
          type: string
          description: Network token <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/card-schemes-tokenization/#tokenization-status" target="_blank">status</a>.
          enum:
            - INACTIVE
            - ACTIVE
            - SUSPENDED
            - DEACTIVATED
            - DELETED
        created_at:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          description: Network token creation date.
        updated_at:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          description: Date of network token status update.
    RequestCardsWebhookChargeback:
      title: RequestWebhookCardsChargeback
      type: object
      properties:
        order:
          type: object
          description: Information about the order, including identifiers, timestamps, amounts, status, and customer details.
          properties:
            order_id:
              type: string
              description: |-
                Unique order identifier, which can be used to find the payment.

                <blockquote>
                  <p>For the first payment, the identifier is defined by the merchant.</p>
                  <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                </blockquote>
              maxLength: 255
            amount:
              type: integer
              description: |-
                Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

                <blockquote>
                  <p>For instance, 1020 means 10 EUR and 20 cents.</p>
                </blockquote>
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
              minLength: 3
              maxLength: 3
            status:
              type: string
              description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
              enum:
                - processing
                - 3ds_verify
                - refunded
                - auth_ok
                - auth_failed
                - settle_ok
                - partial_settled
                - void_ok
        chargeback:
          type: object
          description: Map of chargebacks where the keys are chargeback identifiers.
          properties:
            id:
              type: integer
              description: Unique chargeback identifier.
              maxLength: 100
            dispute_date:
              type: string
              description: Date on which the chargeback was created by the issuer.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            settlement_date:
              type: string
              description: Date on which the chargeback was financially settled.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            amount:
              type: integer
              description: |-
                Amount that will be deducted for the chargeback on a specific order.

                <blockquote>
                  <p>This amount may vary based on the user's decision to dispute a different amount.</p>
                </blockquote>
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the chargeback amount.
              maxLength: 3
              minLength: 3
            type:
              type: string
              description: <a href="https://docs.solidgate.com/risks/chargebacks/#types" target="_blank">Current type</a> of the chargeback.
              enum:
                - 1st_chb
                - 2nd_chb
                - arbitration
            status:
              type: string
              description: <a href="https://docs.solidgate.com/risks/chargebacks/#statuses" target="_blank">Status</a> of the chargeback.
              enum:
                - in_progress
                - document_sent
                - reversed
                - accepted
                - resolved
                - resolved_reversal
            reason_group:
              type: string
              description: |-
                <a href="https://docs.solidgate.com/risks/reason-codes/" target="_blank">Reason code</a> group.

                <blockquote>
                  <p>It could be used for the segmentation and analytic purposes.</p>
                </blockquote>
            reason_code:
              type: string
              description: <a href="https://docs.solidgate.com/risks/reason-codes/" target="_blank">Reason code</a> for the chargeback provided by the card scheme.
            reason_description:
              type: string
              description: <a href="https://docs.solidgate.com/risks/reason-codes/" target="_blank">Reason code</a> description for the chargeback provided by the card scheme.
            available_actions:
              type: array
              description: List of available actions for the chargeback in the current state.
              items:
                type: string
                enum:
                  - enrich_evidence
                  - provide_evidence
        chargeback_flow:
          type: array
          description: Map of chargeback flows where the keys are chargeback flow identifiers.
          items:
            properties:
              id:
                type: integer
                description: Unique chargeback flow identifier.
                maxLength: 100
              date:
                type: string
                description: Datetime when the chargeback flow was created.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              updated_date:
                type: string
                description: Datetime when the chargeback flow was updated.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              settlement_date:
                type: string
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                description: Date on which the chargeback flow was financially settled.
              deadline_date:
                type: string
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                description: |-
                  Deadline for submitting a response to the dispute.

                  <blockquote>
                    <p>This corresponds to date + n, where n is a number of calendar days set by the scheme/acquirer.</p>
                  </blockquote>
              amount:
                type: integer
                description: |-
                  Amount involved in each stage of the chargeback process.

                  <blockquote>
                    <p>For example, there could be two records in <code>chargeback_flow</code> one with an amount of 113.58 USD and another with an amount of 100 USD.</p>
                  </blockquote>
              dispute_amount:
                type: integer
                description: |-
                  Specific amount disputed, typically in the smallest currency unit, that would be returned to the merchant if the dispute is resolved in their favor.

                  <blockquote>
                    <p>For example, if the second chargeback was successfully disputed, the <code>dispute_amount</code> would be 100 USD.</p>
                  </blockquote>
              currency:
                type: string
                description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code  of the chargeback amount.
                minLength: 3
                maxLength: 3
              type:
                type: string
                description: <a href="https://docs.solidgate.com/risks/chargebacks/#types" target="_blank">Type</a> of the chargeback flow.
                enum:
                  - 1st_chb
                  - 2nd_chb
                  - arbitration
              status:
                type: string
                description: <a href="https://docs.solidgate.com/risks/chargebacks/#statuses" target="_blank">Status</a> of the chargeback.
                enum:
                  - in_progress
                  - document_sent
                  - reversed
                  - accepted
                  - resolved
                  - resolved_reversal
              represented_by:
                type: string
                description: Indicates which party has provided the defense document for dispute <a href="https://docs.solidgate.com/risks/chargebacks/#respond-to-chargebacks" target="_blank">representment</a>.
                enum:
                  - merchant
                  - automation
              arn_code:
                type: string
                description: |-
                  Acquirer Reference Number (ARN) assigned to transactions.

                  <blockquote>
                    <p>Use ARN to check transaction <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">status</a>.</p>
                  </blockquote>
              rrn_code:
                type: string
                description: Retrieval Reference Number (RRN) assigned to transactions, based on the <a href="https://en.wikipedia.org/wiki/ISO_8583" target="_blank">ISO 8583</a> standard.
                minLength: 12
                maxLength: 12
    RequestCardsWebhookPreventAlert:
      title: RequestWebhookCardsPreventAlert
      type: object
      properties:
        order:
          type: object
          description: Information about the order, including identifiers, timestamps, amounts, status, and customer details.
          properties:
            id:
              type: string
              description: |-
                Unique order identifier, which can be used to find the payment.

                <blockquote>
                  <p>For the first payment, the identifier is defined by the merchant.</p>
                  <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                </blockquote>
              maxLength: 255
            created_at:
              type: string
              description: Datetime when the order was created.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            amount:
              type: integer
              description: |-
                Order amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

                <blockquote>
                  <p>For instance, 1020 means 10 EUR and 20 cents.</p>
                </blockquote>
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
              minLength: 3
              maxLength: 3
            status:
              type: string
              description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
              enum:
                - processing
                - settle_pending
                - approved
                - declined
                - refunded
        alert:
          type: object
          description: Information about chargeback alerts, including identifiers, amounts, currency, provider details, alert types, and outcomes.
          properties:
            id:
              type: string
              description: Unique identifier assigned to each alert.
              maxLength: 100
            amount:
              type: integer
              description: Amount specified in the alert.
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
            provider_name:
              type: string
              description: Name of provider that sent alerts.
              enum:
                - ethoca
                - verifi
            alert_date:
              type: string
              description: Datetime when the alert was raised on the provider's side.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            created_at:
              type: string
              description: Datetime when the alert was created in the system.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime when the alert was updated in the system.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            alert_type:
              type: string
              description: |-
                <a href="https://docs.solidgate.com/risks/prevention-alerts/insights/#alert-types" target="_blank">Type</a> of alert. 

                <blockquote>
                  <p>Each alert type denotes a specific event or action in the chargeback flow.</p>
                </blockquote>
              enum:
                - inquiry
                - init-refund
                - resolved
                - prevented
            outcome:
              type: string
              description: |-
                Specific response <a href="https://docs.solidgate.com/risks/prevention-alerts/insights/#alert-outcome" target="_blank">statuses</a> for webhook alerts.

                <blockquote>
                  <p>Upon receiving a webhook alert, the primary task is to promptly provide a valid response using one of the specified outcomes. Only the initial response to the alert is accepted, with the exception when the initial status was set to <code>pending</code>. Once a response is submitted to the provider, subsequent modifications are not permitted.</p>
                </blockquote>
              enum:
                - reversed
                - previously-reversed
                - duplicate
                - decline
                - error
                - reverse-error
                - not-found
                - acknowledged
                - pending
                - shipped
    RequestCardsWebhookFraudAlert:
      title: RequestCardsWebhookFraudAlert
      type: object
      properties:
        id:
          type: integer
          description: Unique fraud alert identifier.
          maxLength: 100
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        created_at:
          type: string
          description: Datetime when the fraud alert was created by Solidgate.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the fraud alert was updated by Solidgate.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        fraud_amount:
          type: integer
          description: |-
            Fraud amount in the smallest <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">currency</a> unit.

            <blockquote>
              <p>For instance, 1020 means 10 EUR and 20 cents.</p>
            </blockquote>
        fraud_currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
        fraud_amount_usd:
          type: integer
          description: Amount converted to USD, used for standardized reporting and analysis across different currencies.
        fraud_report_day:
          type: string
          description: Date on which the fraud was reported.
        fraud_type:
          type: string
          description: Type of fraud detected, categorizing the nature of the fraudulent activity.
        card_scheme:
          type: string
          description: Card scheme associated with the transaction (e.g., Visa, Mastercard), providing context on the payment network involved.
        reason_code_description:
          type: string
          description: Detailed explanation of the reason code associated with the fraud alert, offering insights into why the fraud was flagged.
    RequestBillingWebhookTaxCalculated:
      title: RequestFinancesWebhookTaxCalculated
      type: object
      properties:
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
          example: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id:
          type: string
          description: |-
            Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.

            <blockquote>
              <p>Can be absent for payments without <code>product_id</code>.</p>
            </blockquote>
          maxLength: 36
          format: uuid
        total_amount:
          type: integer
          description: |-
            Payment total amount in the smallest currency unit.

            <blockquote>
              <p>It is negative if the <code>action</code> is not <code>sale</code>, <code>chargeback_reversed</code>, or <code>rdr_reversed</code>.</p>
            </blockquote>
        currency:
          type: string
          description: Currency used to initiate the payment by the merchant. Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
          maxLength: 3
          minLength: 3
        action:
          type: string
          description: |-
            <a href="https://docs.solidgate.com/billing/taxes/tax-insights/#tax-actions" target="_blank">Action</a> of a transaction involving tax calculation.

            <blockquote>
              <p>For all <code>action</code> types except <code>sale</code>, <code>chargeback_reversed</code>, and <code>rdr_reversed</code>, the calculation amounts will be negative.</p>
            </blockquote>
          enum:
            - sale
            - refund
            - chargeback
            - rdr
            - chargeback_reversed
            - rdr_reversed
            - paypal_dispute
        payment_category:
          type: string
          description: Payment method used to process the payment.
          enum:
            - card-payment
            - apm-payment
        transaction_date:
          type: string
          description: Datetime when the payment was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        tax_included:
          type: boolean
          description: Indicates type of the tax.
        tax:
          type: object
          description: |-
            Information related to the tax calculation.

            <blockquote>
              <p>It is absent if the tax calculation fails.</p>
            </blockquote>
          properties:
            tax_amount:
              type: integer
              description: |-
                Amount of the tax calculated.

                <blockquote>
                  <p>It is negative if the <code>action</code> is not <code>sale</code>, <code>chargeback_reversed</code>, or <code>rdr_reversed</code>.</p>
                </blockquote>
            taxable_amount:
              type: integer
              description: |-
                Taxable amount of the transaction before tax.

                <blockquote>
                  <p>It is negative if the <code>action</code> is not <code>sale</code>, <code>chargeback_reversed</code>, or <code>rdr_reversed</code>.</p>
                </blockquote>
            rate:
              type: number
              format: decimal
              description: Tax rate used for the tax calculation.
            currency:
              type: string
              description: |-
                Currency in which the tax was calculated. Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.

                <blockquote>
                  <p>Some locations only accept tax in their native currency.</p>
                </blockquote>
              maxLength: 3
              minLength: 3
            location:
              type: object
              description: Information about the cardholder's location.
              properties:
                country:
                  type: string
                  description: Country code where the tax applies, specified using an <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">ISO 3166-1 alpha-3</a> code.
                  format: iso_code_a3
                  minLength: 3
                  maxLength: 3
                state:
                  type: string
                  description: |-
                    Name of the tax jurisdiction state.

                    <blockquote>
                      <p>It is filled if the country is the USA. Otherwise, it is absent.</p>
                    </blockquote>
            legal_entity:
              type: string
              description: Name of the Legal entity for tax submission.
        no_tax_reason:
          type: string
          description: |-
            Reason for no tax calculated.

            <blockquote>
              <p>It is absent if the tax calculation is successful.</p>
            </blockquote>
    RequestApmWebhookOrderStatus:
      title: RequestApmWebhookOrderStatus
      type: object
      properties:
        order:
          type: object
          description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
          properties:
            method:
              type: string
              description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
            order_id:
              type: string
              description: |-
                Unique order identifier, which can be used to find the payment.

                <blockquote>
                  <p>For the first payment, the identifier is defined by the merchant.</p>
                  <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                </blockquote>
              maxLength: 255
            subscription_id:
              type: string
              description: Unique subscription identifier.
              format: uuid
              maxLength: 36
              minLength: 36
            token:
              type: string
              description: Token associated with a card method that can be used for the subsequent payments.
            created_at:
              type: string
              description: Datetime when the order was created.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime when the order was updated.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            amount:
              type: integer
              description: Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
              minLength: 3
              maxLength: 3
            order_description:
              type: string
              description: Brief order description.
              maxLength: 100
            descriptor:
              type: string
              description: |-
                Identifying text that appears on a customer’s statement.

                <blockquote>
                  <p>It includes information about the transaction and helps the customer recognize the charge and provided only for <code>paypal-vault</code> method.</p>
                </blockquote>
            status:
              type: string
              description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
              enum:
                - created
                - processing
                - settle_pending
                - approved
                - declined
                - refunded
            customer_account_id:
              type: string
              description: Unique customer identifier defined by the merchant.
              maxLength: 100
            customer_email:
              type: string
              description: Customer's email address.
              maxLength: 100
            ip_address:
              type: string
              description: |-
                Public IP address of the cardholder, both IPv4 and IPv6 are supported.

                <blockquote>                
                  <p>Useful for antifraud checks. For recurring payments, use the last session or registration IP.</p>
                  <p>Private IPs (10.0.0.0-10.255.255.255, 172.16.0.0-172.31.255.255, 192.168.0.0-192.168.255.255) will result in an <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/#213-invalid-ip" target="_blank">'Invalid IP'</a> error.</p>
                </blockquote>
              maxLength: 50
            provider_data:
              $ref: '#/components/schemas/SchemaApmProviderData'
        error:
          description: |-
            <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">Error</a> object.

            <blockquote>
              <p>Returned only in cases of <code>declined</code> statuses at the order, and <code>fail</code> status at transaction.</p>
            </blockquote>
          allOf:
            - $ref: '#/components/schemas/SchemaApmDiscriminatorErrorSuccess'
        transactions:
          type: array
          description: Details of transactions, including identifiers, amounts, currencies, statuses, and types.
          items:
            type: object
            properties:
              method:
                type: string
                description: Payment <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">method</a> that was used to process the order.
              id:
                type: string
                description: Unique transaction identifier.
                maxLength: 100
              created_at:
                type: string
                description: Datetime when the transaction was created.
                pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              amount:
                type: integer
                description: Transaction amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> supported by the alternative payment method.
              currency:
                type: string
                description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
                maxLength: 3
                minLength: 3
              status:
                type: string
                description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the transaction.
                enum:
                  - created
                  - processing
                  - settle_pending
                  - success
                  - fail
              type:
                type: string
                description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                enum:
                  - pay
                  - recurring
                  - refund
              refund_reason:
                type: string
                description: Text description of the refund reason.
              refund_reason_code:
                type: string
                description: |-
                  Refund reason <a href="https://docs.solidgate.com/payments/payments-insights/refund-reasons/" target="_blank">code</a>.

                  <blockquote>
                    <p>This field is actively validated against the current list of reason codes. Deprecated codes will not be accepted.</p>
                  </blockquote>
                minLength: 4
                maxLength: 4
              payer_details:
                description: |-
                  Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                  <blockquote>
                    <p>It provides essential information such as the payer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                  </blockquote>
                type: object
                deprecated: true
                properties:
                  invoice_id:
                    type: string
                    description: |-
                      Unique invoice identifier provided by PayPal.

                      <blockquote>
                        <p>It would be provided only for the transactions with <code>paypal-vault</code> method.</p>
                      </blockquote>
                    format: uuid
                    maxLength: 36
                    minLength: 36
                    deprecated: true
                  payer_email:
                    type: string
                    description: |-
                      Payer's email.

                      <blockquote>
                        <p>It would be provided only for the transactions with <code>paypal-vault</code> method.</p>
                      </blockquote>
                    deprecated: true
        order_metadata:
          type: object
          description: Metadata is useful for storing additional, structured information about an order.
          additionalProperties:
            type: string
            maxLength: 380
          maxProperties: 10
        pay_form:
          type: object
          description: |-
            Payment form data.

            <blockquote>
              <p>Including fields necessary for processing the payment.</p>
            </blockquote>
          properties:
            token:
              type: string
              description: Secure payment token representing sensitive payment method information.
              deprecated: true
            script_url:
              type: string
              description: URL of the JavaScript file needed to display the <a href="https://docs.solidgate.com/payments/integrate/payment-form/apm-buttons/#method-specific-configuration" target="_blank">PayPal button</a> is required for integration, initialization, configuration.
              maxLength: 255
              deprecated: true
          deprecated: true
    RequestApmWebhookPaypalDispute:
      title: RequestWebhookPaypalDispute
      type: object
      properties:
        dispute_id:
          type: string
          description: Unique dispute identifier.
        order_id:
          type: string
          description: |-
            Unique order identifier, which can be used to find the payment.

            <blockquote>
              <p>For the first payment, the identifier is defined by the merchant.</p>
              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
            </blockquote>
          maxLength: 255
        subscription_product_id:
          description: |-
            Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier of the subscription.

            <blockquote>
               <p>It corresponds to the <code>product_id</code> parameter in subscriptions.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        subscription_service_id:
          description: |-
            Unique subscription identifier.

            <blockquote>
               <p>It corresponds to the <code>subscription_id</code> parameter in <a href="https://api-docs.solidgate.com/#tag/Manage-subscriptions" target="_blank">subscriptions</a>.</p>
            </blockquote>
          format: uuid
          maxLength: 36
          minLength: 36
        created_at:
          type: string
          description: Datetime when the dispute was created.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        updated_at:
          type: string
          description: Datetime when the dispute was updated.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
        seller_response_due_date:
          type: string
          description: Deadline for submitting a response to the dispute.
        dispute_amount:
          type: integer
          description: Dispute amount.
        dispute_currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the dispute.
          minLength: 3
          maxLength: 3
        dispute_life_cycle_stage:
          type: string
          description: Stage in the <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/insights/" target="_blank">dispute lifecycle</a>.
          enum:
            - INQUIRY
            - CHARGEBACK
            - PRE_ARBITRATION
            - ARBITRATION
        dispute_channel:
          type: string
          description: Indicates the <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/insights/" target="_blank">channel</a> by which PayPal dispute has been received.
          enum:
            - INTERNAL
            - EXTERNAL
            - ALERT
        dispute_create_time:
          type: string
          description: Datetime when the dispute was created.
        dispute_update_time:
          type: string
          description: Datetime when the dispute was updated.
        dispute_outcome:
          type: string
          description: <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/insights/" target="_blank">Outcome</a> of the dispute.
          enum:
            - RESOLVED_BUYER_FAVOUR
            - RESOLVED_SELLER_FAVOUR
            - RESOLVED_WITH_PAYOUT
            - CANCELED_BY_BUYER
            - NONE
        reason:
          type: string
          description: <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/insights/" target="_blank">Reason</a> for the received dispute.
          enum:
            - MERCHANDISE_OR_SERVICE_NOT_RECEIVED
            - MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED
            - UNAUTHORISED
            - CREDIT_NOT_PROCESSED
            - DUPLICATE_TRANSACTION
            - INCORRECT_AMOUNT
            - PAYMENT_BY_OTHER_MEANS
            - CANCELED_RECURRING_BILLING
            - PROBLEM_WITH_REMITTANCE
            - OTHER
        status:
          type: string
          description: <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/insights/" target="_blank">Status</a> of the PayPal dispute.
          enum:
            - OPEN
            - WAITING_FOR_BUYER_RESPONSE
            - WAITING_FOR_SELLER_RESPONSE
            - UNDER_REVIEW
            - RESOLVED
            - OTHER
        represented_by:
          type: string
          description: Indicates which party has provided the defense document for dispute <a href="https://docs.solidgate.com/risks/paypal-risk-metrics/manage/#dispute-representment" target="_blank">representment</a>.
          enum:
            - merchant
            - automation
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
        available_actions:
          type: array
          description: List of available actions for the dispute in the current state.
          items:
            type: string
            enum:
              - enrich_evidence
              - provide_evidence
    RequestApmWebhookPreventAlert:
      title: RequestWebhookCardsPreventAlert
      type: object
      properties:
        order:
          type: object
          description: Details of an order, including identifiers, timestamps, amounts, status, and customer data.
          properties:
            id:
              type: string
              description: |-
                Unique order identifier, which can be used to find the payment.

                <blockquote>
                  <p>For the first payment, the identifier is defined by the merchant.</p>
                  <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                </blockquote>
              maxLength: 255
            created_at:
              type: string
              description: Datetime when the order was created.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            amount:
              type: integer
              description: |-
                Order amount in the <a href="https://docs.solidgate.com/payments/payments-insights/supported-currencies/" target="_blank">smallest currency unit</a> (cents for euros).

                <blockquote>
                  <p>For instance, 1020 means 10 EUR and 20 cents.</p>
                </blockquote>
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
              minLength: 3
              maxLength: 3
            status:
              type: string
              description: <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">Status</a> of the requested order.
              enum:
                - created
                - processing
                - settle_pending
                - approved
                - declined
                - refunded
        alert:
          type: object
          description: Details about chargeback alerts, including identifiers, amounts, currency, provider data, alert types, and outcomes.
          properties:
            id:
              type: string
              description: Unique identifier assigned to each alert.
              maxLength: 100
            amount:
              type: integer
              description: Amount specified in the alert.
            currency:
              type: string
              description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code.
            provider_name:
              type: string
              description: Name of the alert provider.
              enum:
                - ethoca
                - verifi
            alert_date:
              type: string
              description: Datetime when the alert was raised on the provider's side.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            created_at:
              type: string
              description: Datetime when the alert was created in the system.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime when the alert was updated in the system.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            alert_type:
              type: string
              description: |-
                <a href="https://docs.solidgate.com/risks/prevention-alerts/insights/#alert-types" target="_blank">Type</a> of alert. 

                <blockquote>
                  <p>Each alert type denotes a specific event or action in the chargeback flow.</p>
                </blockquote>
              enum:
                - inquiry
                - resolved
            outcome:
              type: string
              description: |-
                Specific response <a href="https://docs.solidgate.com/risks/prevention-alerts/insights/#alert-outcome" target="_blank">statuses</a> for webhook alerts.

                <blockquote>
                  <p>Upon receiving a webhook alert, the primary task is to promptly provide a valid response using one of the specified outcomes. Only the initial response to the alert is accepted, with the exception when the initial status was set to <code>pending</code>. Once a response is submitted to the provider, subsequent modifications are not permitted.</p>
                </blockquote>
              enum:
                - reversed
                - previously-reversed
                - duplicate
                - decline
                - error
                - reverse-error
                - not-found
                - acknowledged
                - pending
                - shipped
    RequestApmWebhookRevokedRecurringToken:
      title: RequestApmWebhookRevokedRecurringToken
      type: object
      required:
        - token
        - initial_order_id
        - cancelled_at
      properties:
        token:
          type: string
          description: Recurring token.
          example: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        initial_order_id:
          type: string
          description: Initial order identifier.
          maxLength: 255
          example: 22738n
        cancelled_at:
          type: string
          description: Datetime when the token was cancelled.
          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
          example: '2024-12-21 11:21:30'
    SchemaBillingSubscriptionWebhookProduct:
      type: object
      description: |-
        Subscription product details, including name, pricing logic, amount, currency, trial settings, and other related attributes.

        <blockquote>
          <p>The list of fields within the object differs from the field set during the <a href="https://api-docs.solidgate.com/#tag/Products-and-prices/operation/create-product" target="_blank">creation of the product</a> request.</p>
        </blockquote>
      properties:
        product_id:
          type: string
          description: Unique <a href="https://docs.solidgate.com/billing/product-and-price-management/" target="_blank">product</a> identifier.
          minLength: 36
          maxLength: 36
          format: uuid
        name:
          type: string
          description: Product name.
        payment_action:
          type: string
          description: |-
            Specifies a <a href="https://docs.solidgate.com/payments/payments-overview/" target="_blank">payment flow</a> applied to the first transaction, with or without the next money return, for:
            - **free trial** - the payment actions are `auth_0_amount` and `auth_void`, with the last indicating that the funds will be refunded to the customer
            - **paid trial** - the payment action is `auth_settle`, indicating the funds will be deducted from the customer's account as payment for the trial period and transferred to the merchant's account

            <blockquote style="border-left: 4px solid #F2C4C4;">
              <p><strong>Required</strong> if product has a trial.</p>
            </blockquote>
          enum:
            - auth_0_amount
            - auth_void
            - auth_settle
        amount:
          description: Product price.
          type: integer
        currency:
          type: string
          description: Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the product price currency.
          maxLength: 3
          minLength: 3
        trial:
          type: boolean
          description: Indicates whether the product has a trial.
        trial_period:
          type: integer
          description: |-
            Indicates the trial period in minutes.

              <blockquote style="border-left: 4px solid #F2C4C4;">
                <p><strong>Required</strong> if the product has a trial.</p>
              </blockquote>
        trial_amount:
          type: integer
          description: |-
            Trial price.

            <blockquote style="border-left: 4px solid #F2C4C4;">
              <p><strong>Required</strong> if product has a trial.</p>
            </blockquote>
        trial_currency:
          type: string
          description: |-
            Three-letter <a href="https://en.wikipedia.org/wiki/ISO_4217" target="_blank">ISO-4217</a> currency code of the trial price currency.

            <blockquote style="border-left: 4px solid #F2C4C4;">
              <p><strong>Required</strong> if product has a trial.</p>
            </blockquote>
          maxLength: 3
          minLength: 3
      required:
        - product_id
        - name
        - amount
        - currency
        - trial
    SchemaBillingSubscriptionWebhookCustomer:
      type: object
      description: Customer details related to the subscription, including key information such as the customer's email address.
      properties:
        customer_account_id:
          type: string
          description: Unique customer identifier defined by the merchant.
          maxLength: 100
        customer_email:
          type: string
          description: Customer's email address.
          maxLength: 100
      required:
        - customer_account_id
        - customer_email
    SchemaBillingSubscriptionWebhookExtendedCreate:
      title: WebhookSubscriptionCreate
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      properties:
        callback_type:
          type: string
          description: |-
            Subscription event type, representing a specific change in the subscription lifecycle.

            <blockquote>
              <p>View parameters specific to a particular callback type by choosing the relevant callback type.</p>
            </blockquote>
          enum:
            - create
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - updated_at
            - trial
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - pending
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - processing
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                          enum:
                            - processing
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedExpire:
      title: WebhookSubscriptionExpire
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - expire
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - updated_at
            - trial
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - cancelled
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - fail
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedPaymentAttempt:
      title: WebhookSubscriptionPaymentAttempt
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - payment_attempt
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - updated_at
            - trial
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - pending
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - processing
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                          enum:
                            - processing
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedActive:
      title: WebhookSubscriptionActive
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - active
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedRenew:
      title: WebhookSubscriptionRenew
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - renew
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedSwitchProduct:
      title: WebhookSubscriptionSwitchProduct
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - switch_product
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            cancellation_requested_at:
              type: string
              description: |-
                Datetime of subscription cancellation request.

                <blockquote>
                  <p>Present <strong>only</strong> when the product is changed after subscription cancellation.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                    - fail
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedUpdateOrder:
      title: WebhookSubscriptionUpdateOrder
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: |-
            Subscription event type, representing a specific change in the subscription lifecycle.

            <blockquote>
              <p>If the subscription has multiple invoices, this event is only sent for the most recent invoice at the time the order status changes. Webhooks for orders on older invoices are suppressed. <br> To receive events for all order updates regardless of invoice status, <a href="https://docs.solidgate.com/payments/integrate/webhooks/#manage-webhooks" target="_blank">subscribe</a> to <code>card_gate.order.updated</code> and <code>alt_gate.order.updated</code>.</p>
            </blockquote>
          enum:
            - order_update
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - updated_at
            - trial
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - pending
                - active
                - cancelled
                - redemption
                - paused
                - expired
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - processing
                    - retry
                    - success
                    - fail
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedPause:
      title: WebhookSubscriptionPause
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - pause
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - pause
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - paused
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
            pause:
              type: object
              description: Pause schedule parameters.
              properties:
                from_date:
                  type: string
                  description: |-
                    Datetime of the pause start.

                    <blockquote>
                      <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                to_date:
                  type: string
                  description: |-
                    Datetime of the pause end.

                    <blockquote>
                      <p>It is absent when the subscription is planned to pause infinitely.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              required:
                - from_date
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedCreatePauseSchedule:
      title: WebhookSubscriptionCreatePauseSchedule
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - pause_schedule.create
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - pause
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
            pause:
              type: object
              description: Pause schedule parameters.
              properties:
                from_date:
                  type: string
                  description: |-
                    Datetime of the pause start.

                    <blockquote>
                      <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                to_date:
                  type: string
                  description: |-
                    Datetime of the pause end.

                    <blockquote>
                      <p>It is absent when the subscription is planned to pause infinitely.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              required:
                - from_date
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          description: Datetime of the order creation.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          description: Datetime of the order creation.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedUpdatePauseSchedule:
      title: WebhookSubscriptionUpdatePauseSchedule
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - pause_schedule.update
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - pause
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
                - paused
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
            pause:
              type: object
              description: Pause schedule parameters.
              properties:
                from_date:
                  type: string
                  description: |-
                    Datetime of the pause start.

                    <blockquote>
                      <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                to_date:
                  type: string
                  description: |-
                    Datetime of the pause end.

                    <blockquote>
                      <p>It is absent when the subscription is planned to pause infinitely.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              required:
                - from_date
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedDeletePauseSchedule:
      title: WebhookSubscriptionDeletePauseSchedule
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - pause_schedule.delete
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - processing
                    - retry
                    - success
                    - fail
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedResume:
      title: WebhookSubscriptionResume
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - resume
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedRecurring:
      title: WebhookSubscriptionRecurring
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - recurring
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - processing
                    - retry
                    - success
                    - fail
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedRestore:
      title: WebhookSubscriptionRestore
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - restore
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                    - fail
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedCancel:
      title: WebhookSubscriptionCancel
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - cancel
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - cancelled_at
            - cancellation_requested_at
            - cancel_code
            - cancel_message
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - cancelled
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
            cancelled_at:
              type: string
              description: |-
                Datetime of subscription cancellation. 

                <blockquote>                
                  <p>This parameter is <strong>required</strong>, but in other cases, for example in refunds, this parameter is <code>null</code>.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            cancellation_requested_at:
              type: string
              description: Datetime of subscription cancellation request.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            cancel_code:
              type: string
              description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
              enum:
                - '8.01'
                - '8.02'
                - '8.03'
                - '8.04'
                - '8.05'
                - '8.06'
                - '8.07'
                - '8.08'
                - '8.09'
                - '8.10'
                - '8.11'
                - '8.12'
                - '8.13'
                - '8.14'
                - '8.15'
            cancel_message:
              type: string
              description: Cancellation reason.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                    - fail
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedScheduleCancellation:
      title: WebhookSubscriptionScheduleCancellation
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - scheduled_for_cancellation
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - cancelled_at
            - cancellation_requested_at
            - cancel_code
            - cancel_message
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
            cancelled_at:
              type: string
              description: |-
                Datetime of subscription cancellation. 

                <blockquote>                
                  <p>This parameter is <strong>required</strong>, but in other cases, for example in refunds, this parameter is <code>null</code>.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            cancellation_requested_at:
              type: string
              description: Datetime of subscription cancellation request.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            cancel_code:
              type: string
              description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
              enum:
                - '8.01'
                - '8.02'
                - '8.03'
                - '8.04'
                - '8.05'
                - '8.06'
                - '8.07'
                - '8.08'
                - '8.09'
                - '8.10'
                - '8.11'
                - '8.12'
                - '8.13'
                - '8.14'
                - '8.15'
            cancel_message:
              type: string
              description: Cancellation reason.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                    - fail
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/manage-card-payments/#insights" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedRedemption:
      title: WebhookSubscriptionRedemption
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - redemption
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - redemption
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: |-
                Datetime of the subsequent charge.
                <blockquote> <p>If smart retries are enabled, this field may delay appearing in webhook payloads. Retry the <a href="https://api-docs.solidgate.com/#tag/Retrieve-subscription-data/operation/get-subscription-status" target="_blank">subscription status</a> 5–15 seconds later. In rare cases, the value becomes available within 15 minutes.</p> </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - retry
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: Type of the transaction. All possible values are described in the <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">payment guide</a>.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedRetry:
      title: WebhookSubscriptionRetry
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - retry
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - redemption
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - retry
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: Type of the transaction. All possible values are described in the <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">payment guide</a>.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                          enum:
                            - processing
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: Type of the transaction. All possible values are described in the <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">payment guide</a>.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookExtendedScheduleRetry:
      title: WebhookSubscriptionScheduleRetry
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      description: ''
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - scheduled_for_retry
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - redemption
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            discount:
              type: object
              description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
              required:
                - created_at
                - coupon
              properties:
                created_at:
                  type: string
                  description: Datetime of the discount creation.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  example: '2025-05-31 12:53:12'
                coupon_code:
                  type: string
                  minLength: 2
                  maxLength: 25
                  description: Coupon code.
                  example: SUMMER25OFF
                coupon:
                  type: object
                  description: Coupon details.
                  required:
                    - name
                    - type
                    - value
                  properties:
                    name:
                      type: string
                      description: Coupon name.
                      example: Summer 25% OFF
                    description:
                      type: string
                      description: Coupon description.
                      example: 25% off for 3 months
                    type:
                      type: string
                      description: Discount type indicating percentage or fixed amount off the price.
                      enum:
                        - percentage
                        - amount
                      example: percentage
                    value:
                      type: integer
                      description: |-
                        Discount value.

                        <blockquote>
                          <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                        </blockquote>
                      example: 25
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - retry
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                discount:
                  type: object
                  description: Contains information about the <a href="https://docs.solidgate.com/billing/coupons/" target="_blank">discount</a> applied.
                  required:
                    - created_at
                    - coupon
                  properties:
                    created_at:
                      type: string
                      description: Datetime of the discount creation.
                      pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                      example: '2025-05-31 12:53:12'
                    coupon_code:
                      type: string
                      minLength: 2
                      maxLength: 25
                      description: Coupon code.
                      example: SUMMER25OFF
                    coupon:
                      type: object
                      description: Coupon details.
                      required:
                        - name
                        - type
                        - value
                      properties:
                        name:
                          type: string
                          description: Coupon name.
                          example: Summer 25% OFF
                        description:
                          type: string
                          description: Coupon description.
                          example: 25% off for 3 months
                        type:
                          type: string
                          description: Discount type indicating percentage or fixed amount off the price.
                          enum:
                            - percentage
                            - amount
                          example: percentage
                        value:
                          type: integer
                          description: |-
                            Discount value.

                            <blockquote>
                              <p>Depending on the coupon type, the value represents either a percentage or a fixed amount.</p>
                            </blockquote>
                          example: 25
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: Type of the transaction. All possible values are described in the <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">payment guide</a>.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: Type of the transaction. All possible values are described in the <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/#transaction-status" target="_blank">payment guide</a>.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionDiscriminatorWebhookExtended:
      title: Extended
      type: object
      discriminator:
        propertyName: callback_type
        mapping:
          create: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedCreate'
          expire: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedExpire'
          payment_attempt: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedPaymentAttempt'
          active: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedActive'
          renew: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedRenew'
          switch_product: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedSwitchProduct'
          order_update: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedUpdateOrder'
          pause: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedPause'
          pause_schedule.create: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedCreatePauseSchedule'
          pause_schedule.update: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedUpdatePauseSchedule'
          pause_schedule.delete: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedDeletePauseSchedule'
          resume: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedResume'
          recurring: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedRecurring'
          restore: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedRestore'
          cancel: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedCancel'
          scheduled_for_cancellation: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedScheduleCancellation'
          redemption: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedRedemption'
          retry: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedRetry'
          scheduled_for_retry: '#/components/schemas/SchemaBillingSubscriptionWebhookExtendedScheduleRetry'
    SchemaBillingSubscriptionWebhookInit:
      title: WebhookSubscriptionInit
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      properties:
        callback_type:
          type: string
          description: |-
            Subscription event type, representing a specific change in the subscription lifecycle.

            <blockquote>
              <p>View parameters specific to a particular callback type by choosing the relevant callback type.</p>
            </blockquote>
          enum:
            - init
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookRenew:
      title: WebhookSubscriptionRenew
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - renew
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                    - fail
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookUpdate:
      title: WebhookSubscriptionUpdate
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - update
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - updated_at
            - trial
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
                - cancelled
                - redemption
                - paused
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
            cancelled_at:
              type: string
              description: |-
                Datetime of subscription cancellation. 

                <blockquote>
                  <p>This parameter is <strong>required</strong>, but in other cases, for example in refunds, this parameter is <code>null</code>.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            cancellation_requested_at:
              type: string
              description: Datetime of subscription cancellation request.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            cancel_code:
              type: string
              description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
              enum:
                - '8.01'
                - '8.02'
                - '8.03'
                - '8.04'
                - '8.05'
                - '8.06'
                - '8.07'
                - '8.08'
                - '8.09'
                - '8.10'
                - '8.11'
                - '8.12'
                - '8.13'
                - '8.14'
                - '8.15'
            cancel_message:
              type: string
              description: Cancellation reason brief description.
            pause:
              type: object
              description: Pause schedule parameters.
              properties:
                from_date:
                  type: string
                  description: |-
                    Datetime of the pause start.

                    <blockquote>
                      <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                to_date:
                  type: string
                  description: |-
                    Datetime of the pause end.

                    <blockquote>
                      <p>It is absent when the subscription is planned to pause infinitely.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              required:
                - from_date
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - processing
                    - retry
                    - success
                    - fail
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookCancel:
      title: WebhookSubscriptionCancel
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - cancel
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - cancelled_at
            - cancellation_requested_at
            - cancel_code
            - cancel_message
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - cancelled
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
            cancelled_at:
              type: string
              description: |-
                Datetime of subscription cancellation. 

                <blockquote>                
                  <p>This parameter is <strong>required</strong>, but in other cases, for example, in refunds, this parameter is <code>null</code>.</p>
                </blockquote>
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            cancellation_requested_at:
              type: string
              description: Datetime of subscription cancellation request.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            cancel_code:
              type: string
              description: <a href="https://docs.solidgate.com/billing/subscription-insights/subscription-cancel-codes/" target="_blank">Reason code</a> that is used to cancel the subscription.
              enum:
                - '8.01'
                - '8.02'
                - '8.03'
                - '8.04'
                - '8.05'
                - '8.06'
                - '8.07'
                - '8.08'
                - '8.09'
                - '8.10'
                - '8.11'
                - '8.12'
                - '8.13'
                - '8.14'
                - '8.15'
            cancel_message:
              type: string
              description: Cancellation reason brief description.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                    - fail
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookPause:
      title: WebhookSubscriptionPause
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - pause
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - pause
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - paused
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
            pause:
              type: object
              description: Pause schedule parameters.
              properties:
                from_date:
                  type: string
                  description: |-
                    Datetime of the pause start.

                    <blockquote>
                      <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                to_date:
                  type: string
                  description: |-
                    Datetime of the pause end.

                    <blockquote>
                      <p>It is absent when the subscription is planned to pause infinitely.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              required:
                - from_date
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.
                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.
                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookResume:
      title: WebhookSubscriptionResume
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - resume
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                     <blockquote>
                       <p>Filled if invoice is in the <code>success</code> status.</p>
                     </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookCreatePauseSchedule:
      title: WebhookSubscriptionCreatePauseSchedule
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - pause_schedule.create
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - pause
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
            pause:
              type: object
              description: Pause schedule parameters.
              properties:
                from_date:
                  type: string
                  description: |-
                    Datetime of the pause start.

                    <blockquote>
                      <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                to_date:
                  type: string
                  description: |-
                    Datetime of the pause end.

                    <blockquote>
                      <p>It is absent when the subscription is planned to pause infinitely.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              required:
                - from_date
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookUpdatePauseSchedule:
      title: WebhookSubscriptionUpdatePauseSchedule
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - pause_schedule.update
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - pause
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
                - paused
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
            pause:
              type: object
              description: Pause schedule parameters.
              properties:
                from_date:
                  type: string
                  description: |-
                    Datetime of the pause start.

                    <blockquote>
                      <p>If the subscription pause type value is <code>immediate</code>, the datetime is the date and time of the pause start request.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                to_date:
                  type: string
                  description: |-
                    Datetime of the pause end.

                    <blockquote>
                      <p>It is absent when the subscription is planned to pause infinitely.</p>
                    </blockquote>
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
              required:
                - from_date
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - success
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>Is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>Is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionWebhookDeletePauseSchedule:
      title: WebhookSubscriptionDeletePauseSchedule
      type: object
      required:
        - callback_type
        - subscription
        - product
        - customer
      properties:
        callback_type:
          type: string
          description: Subscription event type, representing a specific change in the subscription lifecycle.
          enum:
            - pause_schedule.delete
        subscription:
          type: object
          description: Subscription details, including its status, payment method, and other essential information for tracking and managing its lifecycle.
          required:
            - id
            - status
            - started_at
            - updated_at
            - expired_at
            - payment_type
            - trial
            - next_charge_at
          properties:
            id:
              type: string
              description: Unique subscription identifier.
              maxLength: 36
              format: uuid
            status:
              type: string
              description: Subscription <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-statuses" target="_blank">status</a>.
              enum:
                - active
            started_at:
              type: string
              description: Datetime of the subscription start.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            updated_at:
              type: string
              description: Datetime of the subscription update.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            expired_at:
              type: string
              description: Datetime of the subscription expiration.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            next_charge_at:
              type: string
              description: Datetime of the subsequent charge.
              pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
            payment_type:
              type: string
              description: Customer payment method used to pay for a subscription.
              enum:
                - card
                - paypal-vault
                - mercadopago
                - upi
                - pix
                - gcash
                - alipay
                - mbway
                - wechatpay
            trial:
              type: boolean
              description: Indicates whether the subscription is in trial period.
        product:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookProduct'
        customer:
          allOf:
            - $ref: '#/components/schemas/SchemaBillingSubscriptionWebhookCustomer'
        invoices:
          type: object
          description: Latest invoice for the subscription, including billing information, current state, financial details, and associated order history.
          properties:
            <invoice_id_value_#1>:
              type: object
              description: Invoice for the last billing period.
              required:
                - id
                - status
                - created_at
                - updated_at
                - amount
                - orders
              properties:
                id:
                  type: string
                  description: Unique invoice identifier associated with a specific subscription.
                  maxLength: 36
                  format: uuid
                status:
                  type: string
                  description: Invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a>.
                  enum:
                    - processing
                    - retry
                    - success
                    - fail
                created_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: Datetime of the invoice creation.
                updated_at:
                  type: string
                  description: Datetime of the invoice update.
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                amount:
                  type: integer
                  description: Current subscription price.
                price_product_id:
                  type: string
                  description: |-
                    Unique price identifier applied to the invoice. Use it to distinguish
                    prices configured for different currencies and locations within the
                    same product for <a href="https://docs.solidgate.com/billing/product-and-price-management/"
                    target="_blank">product and price management</a>.

                    <blockquote>
                      <p><code>null</code> is returned if the product has no prices configured for
                      other currencies and locations.</p>
                    </blockquote>
                  maxLength: 36
                  format: uuid
                  example: 61b7f690-242a-498c-99a1-eb191f93f08c
                billing_period_started_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    Start datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                billing_period_ended_at:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                  description: |-
                    End datetime of the period covered by the invoice.

                    <blockquote>
                      <p>Filled if invoice is in the <code>success</code> status.</p>
                    </blockquote>
                subscription_term_number:
                  type: integer
                  description: |-
                    Indicates the number of passed subscription periods, excluding the trial period. The value increments when a new billing period begins or when the subscription is upgraded or downgraded with a <a href="https://docs.solidgate.com/billing/subscription-overview/#subscription-process" target="_blank">billing period change</a>.

                    <blockquote>
                      <p>Filled if invoice is created:</p>
                      <ul>
                        <li>before March 1, 2024 only for the invoice with a <code>success</code> status</li>
                        <li>on or after March 1, 2024, regardless of the invoice <a href="https://docs.solidgate.com/billing/subscription-overview/#invoice-statuses" target="_blank">status</a></li>
                      </ul>
                    </blockquote>
                orders:
                  type: object
                  description: Map of orders, including details such as current status, creation and processing timestamps, and other related transaction information.
                  properties:
                    <order_id_value_#1>:
                      type: object
                      description: Single order, where `<order_id_value_#1>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: Status of the requested <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">card</a> or <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM</a> order.
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        updated_at:
                          type: string
                          description: Datetime of the order update.
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        failed_reason:
                          type: string
                          description: |-
                            Code that indicates the reason for the payment decline. All codes are explained in the <a href="https://docs.solidgate.com/payments/payments-insights/error-codes/" target="_blank">payment guide</a>.

                            <blockquote>
                              <p>This field appears only for failed orders that are the last or precede a successful one.</p>
                            </blockquote>
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                    <order_id_value_#2>:
                      type: object
                      description: Single order, where `<order_id_value_#2>` is a dynamically generated unique order identifier.
                      required:
                        - id
                        - status
                        - created_at
                        - amount
                      properties:
                        id:
                          type: string
                          description: |-
                            Unique order identifier, which can be used to find the payment.

                            <blockquote>
                              <p>For the first payment, the identifier is defined by the merchant.</p>
                              <p>For recurring subscription-based payments, it is generated by the Solidgate subscription service.</p>
                            </blockquote>
                          maxLength: 255
                        status:
                          type: string
                          description: |-
                            Status of the requested order.

                            <blockquote>
                              <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Card order</a> statuses are <code>created</code>, <code>processing</code>, <code>3ds_verify</code>, <code>auth_ok</code>, <code>auth_failed</code>, <code>void_ok</code>, <code>settle_ok</code>, and <code>refunded</code>. Card order status <code>partial_settled</code> is not used in subscriptions.
                              <br><br>
                              <a href="https://docs.solidgate.com/payments/alternative-payments/apms-insights/payment-lifecycle/" target="_blank">APM order</a> statuses are <code>created</code>, <code>processing</code>, <code>approved</code>, <code>declined</code>, and <code>refunded</code>. APM order status <code>settle_pending</code> is not used in subscriptions.
                            </blockquote>
                          enum:
                            - created
                            - processing
                            - 3ds_verify
                            - auth_ok
                            - auth_failed
                            - void_ok
                            - settle_ok
                            - refunded
                            - approved
                            - declined
                        created_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: Datetime of the order creation.
                        processed_at:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
                          description: |-
                            Datetime when the order was processed.

                            <blockquote>
                              <p>It is empty for orders in processing.</p>
                            </blockquote>
                        amount:
                          type: integer
                          description: Original order amount.
                        retry_attempt:
                          type: integer
                          description: |-
                            Indicates the number of retry attempt for the invoice.

                            <blockquote>
                              <p>Filled for orders created according to <a href="https://docs.solidgate.com/billing/manage-subscription/recover-revenue/retry-strategies/" target="_blank">retry strategy</a>.</p>
                            </blockquote>
                        payment_details:
                          description: |-
                            Details of the payer for transactions conducted through <a href="https://docs.solidgate.com/payments/alternative-payments/" target="_blank">APMs</a>.

                            <blockquote>
                              <p>It provides essential information like the customer's email and the invoice identifier, both of which are specifically applicable to transactions conducted with the PayPal method.</p>
                            </blockquote>
                          type: object
                          properties:
                            invoice_id:
                              type: string
                              description: |-
                                Unique invoice identifier provided by PayPal.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                            payer_email:
                              type: string
                              description: |-
                                Customer's email.

                                <blockquote>
                                  <p>It is provided only for the transactions with <code>paypal-vault</code> method.</p>
                                </blockquote>
                        operation:
                          type: string
                          description: <a href="https://docs.solidgate.com/payments/card-payments/card-payments-insights/payment-lifecycle/" target="_blank">Type</a> of the transaction.
                          enum:
                            - pay
                            - recurring
                            - recurring-auth
                            - refund
                            - resign
                            - resign-auth
                            - auth
                            - settle
                            - void
                            - apple-pay
                            - google-pay
                          deprecated: true
                order_metadata:
                  type: object
                  description: Metadata is useful for storing additional, structured information about an object.
                  additionalProperties:
                    type: string
                    maxLength: 380
                  maxProperties: 10
    SchemaBillingSubscriptionDiscriminatorWebhook:
      title: Legacy
      type: object
      discriminator:
        propertyName: callback_type
        mapping:
          init: '#/components/schemas/SchemaBillingSubscriptionWebhookInit'
          renew: '#/components/schemas/SchemaBillingSubscriptionWebhookRenew'
          update: '#/components/schemas/SchemaBillingSubscriptionWebhookUpdate'
          cancel: '#/components/schemas/SchemaBillingSubscriptionWebhookCancel'
          pause: '#/components/schemas/SchemaBillingSubscriptionWebhookPause'
          resume: '#/components/schemas/SchemaBillingSubscriptionWebhookResume'
          pause_schedule.create: '#/components/schemas/SchemaBillingSubscriptionWebhookCreatePauseSchedule'
          pause_schedule.update: '#/components/schemas/SchemaBillingSubscriptionWebhookUpdatePauseSchedule'
          pause_schedule.delete: '#/components/schemas/SchemaBillingSubscriptionWebhookDeletePauseSchedule'
  examples:
    ExampleCheckoutSolutionsCreatePage:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          amount: 1020
          currency: EUR
          future_usage:
            payment_type: one-time
          order_description: Premium package
          order_items: item 1 x 10, item 2 x 30
          order_date: '2025-12-21 11:21:30'
          order_number: 9
          settle_interval: 0
          authorization_type: final
          force3ds: false
          google_pay_allowed_auth_methods:
            - PAN_ONLY
          customer_date_of_birth: '1988-11-21'
          customer_email: example@example.com
          customer_first_name: Nikola
          customer_last_name: Tesla
          customer_phone: '+11234567890'
          billing_address:
            country: USA
            state: NY
            city: New York
            zip: '10001'
            address: 123 Main St
          traffic_source: facebook
          transaction_source: main_menu
          purchase_country: USA
          geo_country: USA
          geo_city: New Castle
          language: pt
          website: https://merchant.example
          order_metadata:
            coupon_code: NY2025
            partner_id: '123989'
          success_url: https://merchant.example/success
          fail_url: https://merchant.example/fail
        page_customization:
          public_name: Public Name
          order_title: Order Title
          order_description: Premium package
          payment_methods:
            - paypal
          button_font_color: '#FFFFFF'
          button_color: '#00816A'
          font_name: Open Sans
          is_cardholder_visible: true
          terms_url: https://merchant.example/terms
          back_url: https://merchant.example/back
    ExampleCheckoutSolutionsCreateSubscriptionPaymentPage:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          product_id: fa43b415-5522-4373-b026-a365562f9649
          order_description: Premium package
          order_items: item 1 x 10, item 2 x 30
          order_number: 9
          settle_interval: 0
          authorization_type: final
          retry_attempt: 3
          force3ds: false
          google_pay_allowed_auth_methods:
            - PAN_ONLY
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_date_of_birth: '1988-11-21'
          customer_email: example@example.com
          customer_first_name: Nikola
          customer_last_name: Tesla
          customer_phone: '+11234567890'
          billing_address:
            country: USA
            state: NY
            city: New York
            zip: '10001'
            address: 123 Main St
          traffic_source: facebook
          transaction_source: main_menu
          purchase_country: USA
          geo_country: USA
          geo_city: New Castle
          language: pt
          website: https://merchant.example
          order_metadata:
            coupon_code: NY2025
            partner_id: '123989'
          fail_url: https://merchant.example/fail
          success_url: https://merchant.example/success
        page_customization:
          public_name: Public Name
          order_title: Order Title
          order_description: Premium package
          payment_methods:
            - paypal
          button_font_color: '#FFFFFF'
          button_color: '#00816A'
          font_name: Open Sans
          is_cardholder_visible: true
          terms_url: https://merchant.example/terms
          back_url: https://merchant.example/back
    ExampleCheckoutSolutionsResponseCreatePage:
      value:
        url: https://payment-page.merchant.example/VxKnj3D
        id: VxKnj3D
    ExampleCheckoutSolutionsResponseAuthenticationFailed:
      value:
        error:
          code: '1.01'
          message:
            auth: Authentication failed
    ExampleCheckoutSolutionsResponseValidationError:
      value:
        error:
          code: '2.01'
          message:
            id: must be a string
    ExampleCheckoutSolutionsResponseSuccessDeactivate:
      value:
        status: ok
    ExampleCheckoutDeactivateLinkError:
      value:
        error:
          code: '2.01'
          message:
            id: must be a string
    ExampleCheckoutSolutionsCreateLink:
      value:
        order:
          amount: 1020
          currency: EUR
          future_usage:
            payment_type: one-time
          order_description: Premium package
          settle_interval: 0
          authorization_type: final
          google_pay_allowed_auth_methods:
            - PAN_ONLY
          traffic_source: facebook
          transaction_source: main_menu
          language: pt
          website: https://merchant.example
          order_metadata:
            coupon_code: NY2025
            partner_id: '123989'
          success_url: https://merchant.example/success
        page_customization:
          public_name: Public Name
          order_title: Order Title
          order_description: Premium package
          payment_methods:
            - paypal
          button_font_color: '#FFFFFF'
          button_color: '#00816A'
          font_name: Open Sans
          is_cardholder_visible: true
          terms_url: https://merchant.example/terms
          back_url: https://merchant.example/back
        configuration:
          usage_mode: reusable
          amount_setter: merchant
    ExampleCheckoutSolutionsCreateSubscriptionPaymentLink:
      value:
        order:
          product_id: fa43b415-5522-4373-b026-a365562f9649
          order_description: Premium package
          settle_interval: 0
          authorization_type: final
          google_pay_allowed_auth_methods:
            - PAN_ONLY
          traffic_source: facebook
          transaction_source: main_menu
          language: pt
          website: https://merchant.example
          order_metadata:
            coupon_code: NY2025
            partner_id: '123989'
          success_url: https://merchant.example/success
        page_customization:
          public_name: Public Name
          order_title: Order Title
          order_description: Premium package
          payment_methods:
            - paypal
          button_font_color: '#FFFFFF'
          button_color: '#00816A'
          font_name: Open Sans
          is_cardholder_visible: true
          terms_url: https://merchant.example/terms
          back_url: https://merchant.example/back
    ExampleCheckoutSolutionsResponseCreateLink:
      value:
        url: https://payment-page.merchant.example/link/Q6J3212g7K
        id: Q6J3212g7K
    ExampleCardsRequestChargePaymentPan:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        card_data_type: pan
        settle_interval: 0
        authorization_type: final
        payment_type: 1-click
        scheme_transaction_id: MDSCAJVIJ1201
        transaction_link_id: A1bCDefGhijkLmNopQrStu
        force3ds: false
        external_mpi_data:
          three_ds_version: 2.2.0
          eci: '05'
          cryptogram: QURZRU4gM0RTMiBURVNUIENBVlY=
          ds_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          cryptogram_algorithm: A
          three_ds_flow: frictionless
          three_ds_server_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          acs_challenge_mandated_ind: 'Y'
          transaction_challenge_exemption: '05'
          authentication_response: 'Y'
          authentication_timestamp: '2025-12-05T12:00:00.000Z'
          ds_transaction_reason: '01'
          acs_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          authentication_method:
            - '02'
            - '03'
          challenge_cancel_ind: '01'
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12120001111'
        card_number: '4067429974719265'
        card_holder: John Snow
        card_exp_month: '12'
        card_exp_year: 2025
        card_cvv: '123'
        card_pin: '4492'
        industry_data:
          type: airline
          airline:
            - airline_code: '001'
              airline_designator_code: DL
              airline_name: Delta Airlines
              boarding_fee: '500'
              computerized_reservation_system: AMAD
              customer_reference_number: A123456789
              document_type: '01'
              flight_date: 2025-09-01 14:30
              agency_plan_name: 1B
              travel_agency_name: Skyline Travel
              travel_agency_code: '87654321'
              agency_invoice_number: INV123
              ticket:
                number: '5661234567890'
                issue_date: '250819'
                restricted: false
                issue_address:
                  line1: 123 Main St
                  city: Atlanta
                  country: USA
                  postal: '30301'
              passenger:
                first_name: John
                last_name: Doe
                date_of_birth: '1985-03-21'
                phone_number: '+14051234567'
                traveller_type: ADT
                code: '123'
              flight_legs:
                - flight_number: DL101
                  carrier_code: DL
                  class_of_travel: 'Y'
                  departure_date: 2025-09-01 14:30
                  departure_airport: ATL
                  departure_tax: '100'
                  arrival_airport: LAX
                  fare_base_code: Y123
                  stop_over_code: X
            - airline_code: '002'
              airline_designator_code: AA
              airline_name: American Airlines
              boarding_fee: '500'
              computerized_reservation_system: AMAD
              customer_reference_number: B987654321
              document_type: '01'
              flight_date: 2025-10-01 16:00
              agency_plan_name: 2A
              travel_agency_name: Global Travel Co
              travel_agency_code: '98765432'
              agency_invoice_number: INV987
              ticket:
                number: '5670987654321'
                issue_date: '250925'
                restricted: true
                issue_address:
                  line1: 456 Elm St
                  city: Dallas
                  country: USA
                  postal: '75201'
              passenger:
                first_name: Jane
                last_name: Smith
                date_of_birth: '1990-11-10'
                phone_number: '+14051234568'
                traveller_type: ADT
                code: '124'
              flight_legs:
                - flight_number: AA102
                  carrier_code: AA
                  class_of_travel: 'Y'
                  departure_date: 2025-10-01 16:00
                  departure_airport: DFW
                  departure_tax: '150'
                  arrival_airport: ORD
                  fare_base_code: Y456
                  stop_over_code: X
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsRequestChargePaymentDpan:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        card_data_type: dpan
        dpan_source: apple-pay
        eci: '05'
        cryptogram: YwAAABkAg0+NbusAMjqEAoABFA=
        settle_interval: 0
        authorization_type: final
        payment_type: 1-click
        scheme_transaction_id: MDSCAJVIJ1201
        transaction_link_id: A1bCDefGhijkLmNopQrStu
        force3ds: false
        external_mpi_data:
          three_ds_version: 2.2.0
          eci: '01'
          cryptogram: QURZRU4gM0RTMiBURVNUIENBVlY=
          ds_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          cryptogram_algorithm: A
          three_ds_flow: frictionless
          three_ds_server_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          acs_challenge_mandated_ind: 'Y'
          transaction_challenge_exemption: '05'
          authentication_response: 'Y'
          authentication_timestamp: '2025-12-05T12:00:00.000Z'
          ds_transaction_reason: '01'
          acs_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          authentication_method:
            - '02'
            - '03'
          challenge_cancel_ind: '01'
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12120001111'
        card_number: '4067429974719265'
        card_holder: John Snow
        card_exp_month: '12'
        card_exp_year: 2025
        card_cvv: '123'
        card_pin: '4492'
        industry_data:
          type: airline
          airline:
            - airline_code: '001'
              airline_designator_code: DL
              airline_name: Delta Airlines
              boarding_fee: '500'
              computerized_reservation_system: AMAD
              customer_reference_number: A123456789
              document_type: '01'
              flight_date: 2025-09-01 14:30
              agency_plan_name: 1B
              travel_agency_name: Skyline Travel
              travel_agency_code: '87654321'
              agency_invoice_number: INV123
              ticket:
                number: '5661234567890'
                issue_date: '250819'
                restricted: false
                issue_address:
                  line1: 123 Main St
                  city: Atlanta
                  country: USA
                  postal: '30301'
              passenger:
                first_name: John
                last_name: Doe
                date_of_birth: '1985-03-21'
                phone_number: '+14051234567'
                traveller_type: ADT
                code: '123'
              flight_legs:
                - flight_number: DL101
                  carrier_code: DL
                  class_of_travel: 'Y'
                  departure_date: 2025-09-01 14:30
                  departure_airport: ATL
                  departure_tax: '100'
                  arrival_airport: LAX
                  fare_base_code: Y123
                  stop_over_code: X
            - airline_code: '002'
              airline_designator_code: AA
              airline_name: American Airlines
              boarding_fee: '500'
              computerized_reservation_system: AMAD
              customer_reference_number: B987654321
              document_type: '01'
              flight_date: 2025-10-01 16:00
              agency_plan_name: 2A
              travel_agency_name: Global Travel Co
              travel_agency_code: '98765432'
              agency_invoice_number: INV987
              ticket:
                number: '5670987654321'
                issue_date: '250925'
                restricted: true
                issue_address:
                  line1: 456 Elm St
                  city: Dallas
                  country: USA
                  postal: '75201'
              passenger:
                first_name: Jane
                last_name: Smith
                date_of_birth: '1990-11-10'
                phone_number: '+14051234568'
                traveller_type: ADT
                code: '124'
              flight_legs:
                - flight_number: AA102
                  carrier_code: AA
                  class_of_travel: 'Y'
                  departure_date: 2025-10-01 16:00
                  departure_airport: DFW
                  departure_tax: '150'
                  arrival_airport: ORD
                  fare_base_code: Y456
                  stop_over_code: X
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsRequestProductBasedPaymentCharge:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: 83b19018-cbc4-45f0-899a-dda84fd2705e
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        payment_type: 1-click
        scheme_transaction_id: MDSCAJVIJ1201
        transaction_link_id: A1bCDefGhijkLmNopQrStu
        force3ds: false
        external_mpi_data:
          three_ds_version: 2.2.0
          eci: '07'
          cryptogram: QURZRU4gM0RTMiBURVNUIENBVlY=
          ds_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          cryptogram_algorithm: A
          three_ds_flow: frictionless
          three_ds_server_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          acs_challenge_mandated_ind: 'Y'
          transaction_challenge_exemption: '05'
          authentication_response: 'Y'
          authentication_timestamp: '2025-12-05T12:00:00.000Z'
          ds_transaction_reason: '01'
          acs_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          authentication_method:
            - '02'
            - '03'
          challenge_cancel_ind: '01'
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        card_number: '4067429974719265'
        card_holder: John Snow
        card_exp_month: '12'
        card_exp_year: 2025
        card_cvv: '123'
        card_pin: '4492'
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsRequestSubscriptionPaymentCharge:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: 83b19018-cbc4-45f0-899a-dda84fd2705e
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        payment_type: 1-click
        scheme_transaction_id: MDSCAJVIJ1201
        transaction_link_id: A1bCDefGhijkLmNopQrStu
        retry_attempt: 3
        force3ds: false
        external_mpi_data:
          three_ds_version: 2.2.0
          eci: '07'
          cryptogram: QURZRU4gM0RTMiBURVNUIENBVlY=
          ds_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          cryptogram_algorithm: A
          three_ds_flow: frictionless
          three_ds_server_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          acs_challenge_mandated_ind: 'Y'
          transaction_challenge_exemption: '05'
          authentication_response: 'Y'
          authentication_timestamp: '2025-12-05T12:00:00.000Z'
          ds_transaction_reason: '01'
          acs_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          authentication_method:
            - '02'
            - '03'
          challenge_cancel_ind: '01'
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        card_number: '4067429974719265'
        card_holder: John Snow
        card_exp_month: '12'
        card_exp_year: 2025
        card_cvv: '123'
        card_pin: '4492'
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsResponseCharge:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          order_description: Premium package
          psp_order_id: 854756336423874823bdfsg6743gf5
          provider_payment_id: charge_64789DFS3827563HGF56
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          product_name: Luxury product
          amount: 100
          currency: USD
          processing_amount: 0
          processing_currency: USD
          marketing_amount: 0
          marketing_currency: USD
          refunded_amount: 0
          status: settle_ok
          auth_code: 2w9m8
          payment_type: 1-click
          payment_method: card
          customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
          customer_email: example@example.com
          descriptor: google.com
          mid: bank-mid-1
          ip_address: 203.0.113.0
          traffic_source: facebook
        transaction:
          id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 100
          currency: USD
          marketing_amount: 0
          marketing_currency: USD
          operation: auth
          status: processing
          scheme_transaction_id: MDSCAJVIJ1201
          transaction_link_id: A1bCDefGhijkLmNopQrStu
          descriptor: google.com
          billing_details:
            address: 21 Bedford Ave
            country: USA
            city: Boston
            state: NY
            zip: '91191'
          refund_reason: Solidgate - Issuer Fraud Notification
          refund_reason_code: '0022'
          card_token:
            token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          card:
            bank: JSC UNIVERSAL BANK
            bin: '444111'
            brand: VISA
            card_exp_month: '12'
            card_exp_year: 2028
            card_holder: John Snow
            card_type: CREDIT
            is_reloadable: true
            card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
            country: USA
            number: 444111XXXXXX9435
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          error:
            code: '2.01'
            messages:
              - Invalid data
            recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
            merchant_advice_code: '30'
          payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
          arn_code: '24871153022084127852235'
          rrn_code: '100034876543'
        transactions:
          <transaction_id_value_#1>:
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            currency: USD
            marketing_amount: 0
            marketing_currency: USD
            operation: auth
            status: processing
            scheme_transaction_id: MDSCAJVIJ1201
            transaction_link_id: A1bCDefGhijkLmNopQrStu
            descriptor: google.com
            billing_details:
              address: 21 Bedford Ave
              city: Boston
              country: USA
              state: NY
              zip: '91191'
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            card:
              bank: JSC UNIVERSAL BANK
              bin: '444111'
              brand: VISA
              card_exp_month: '12'
              card_exp_year: 2028
              card_holder: John Snow
              card_type: CREDIT
              is_reloadable: true
              card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
              country: USA
              number: 444111XXXXXX9435
              card_token:
                token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            error:
              code: '2.01'
              messages:
                - Invalid data
              recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
              merchant_advice_code: '30'
            payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
            arn_code: '24871153022084127852235'
            rrn_code: '100034876543'
        three_ds:
          eci: '06'
          flow: challenge
          exception: transaction_risk_assessment
        routing:
          cascade_steps:
            - mid: mid-1
              mid_descriptor: descriptor-1
              route_id: pm-1
              cascade_number: 1
              segment_id: fps_43bf3b784db24044446e8806723ff5ca
        antifraud_result:
          pre_auth: pass
        verification_result:
          avs_result: matched
          cvv_result: matched
          ani:
            status: performed
            full_name_match: matched
            first_name_match: partially_matched
            last_name_match: not_matched
        chargebacks:
          <chargeback_id_value_#1>:
            id: 12345
            dispute_date: '2025-07-10 00:00:00'
            settlement_date: '2025-07-11 00:00:00'
            amount: 100
            currency: USD
            type: 2nd_chb
            status: reversed
            reason_group: Fraud
            reason_code: '10.4'
            reason_description: Fraud – Card-Absent Environment
            chargeback_flow:
              - id: 12345
                date: '2025-07-10 00:00:00'
                updated_date: '2025-07-11 00:00:00'
                settlement_date: '2025-07-10 00:00:00'
                deadline_date: '2025-07-12 00:00:00'
                amount: 100
                dispute_amount: 0
                currency: USD
                type: 2nd_chb
                status: reversed
                arn_code: '24871153022084127852235'
        device_info:
          user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36
        verify_url: https://merchant.example/verify
        redirect_url: https://merchant.example/redirect
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleMainResponseErrorAuthFailed:
      value:
        error:
          code: '1.01'
          messages:
            - Authentication failed
    ExampleMainResponseErrorInvalidData:
      value:
        error:
          code: '2.01'
          messages:
            - Invalid data
    ExampleMainResponseErrorOrderNotFound:
      value:
        error:
          code: '2.01'
          messages:
            order:
              - Order not found.
    ExampleMainResponseError:
      value:
        error:
          code: '3.02'
          messages:
            - Insufficient funds
          recommended_message_for_user: The card balance has insufficient funds.
    ExampleCardsRequestGooglePay:
      value:
        is_decrypted: false
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        force3ds: false
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        card_holder: John Snow
        industry_data:
          type: car_rental
          car_rental:
            agreement_number: BKID12345
            renter_name: John
            pick_up_date: '2026-03-01T11:00:00Z'
            drop_off_date: '2026-03-05T16:30:00Z'
            refundability: partially_refundable
            rate: 1000
            rate_indicator: D
            days_rented: '10'
            customer_service_toll_free_number: '8001010123'
            rental_class_id: '0001'
            tax_exempt_indicator: 'Y'
            fuel_charges: 2000
            insurance_charges: 2300
            no_show_indicator: 'N'
            one_way_drop_off_charges: 50000
            return_location_id: AB1234
            pick_up_location:
              street_line_1: 1 Example Street
              state: CA
              city: San Francisco
              country: USA
              postal: SW1A1AA
            drop_off_location:
              street_line_1: 1 Example Street
              state: CA
              city: San Francisco
              country: USA
              postal: SW1A1AA
            distance_limit:
              limit: 500
              unit: miles
              additional_distance_cost:
                amount: 150
                currency: USD
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        signature: MEQCIGJGG....0ZpM4YzvUA==
        signedMessage: '{"encryptedMessage":"J......t1+Eu003d"}'
        protocolVersion: ECv1
        network: VISA
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsRequestProductBasedPaymentGooglePay:
      value:
        is_decrypted: false
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: 83b19018-cbc4-45f0-899a-dda84fd2705e
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        force3ds: false
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        card_holder: John Snow
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        signature: MEQCIGJGG....0ZpM4YzvUA==
        signedMessage: '{""""encryptedMessage"""":""J......t1+Eu003d""}'
        protocolVersion: ECv1
        network: VISA
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsRequestSubscriptionPaymentGooglePay:
      value:
        is_decrypted: false
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: 83b19018-cbc4-45f0-899a-dda84fd2705e
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        retry_attempt: 3
        force3ds: false
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        card_holder: John Snow
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        signature: MEQCIGJGG....0ZpM4YzvUA==
        signedMessage: '{""""encryptedMessage"""":""J......t1+Eu003d""}'
        protocolVersion: ECv1
        network: VISA
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsResponseGooglePay:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          order_description: Premium package
          psp_order_id: 854756336423874823bdfsg6743gf5
          provider_payment_id: charge_64789DFS3827563HGF56
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          product_name: Luxury product
          amount: 100
          currency: USD
          processing_amount: 0
          processing_currency: USD
          marketing_amount: 0
          marketing_currency: USD
          refunded_amount: 0
          status: processing
          auth_code: 2w9m8
          payment_type: 1-click
          payment_method: google-pay
          customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
          customer_email: example@example.com
          descriptor: google.com
          mid: bank-mid-1
          ip_address: 203.0.113.0
          traffic_source: facebook
        transaction:
          id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 100
          currency: USD
          marketing_amount: 0
          marketing_currency: USD
          operation: auth
          status: processing
          scheme_transaction_id: MDSCAJVIJ1201
          transaction_link_id: A1bCDefGhijkLmNopQrStu
          descriptor: google.com
          billing_details:
            address: 21 Bedford Ave
            country: USA
            city: Boston
            state: NY
            zip: '91191'
          refund_reason: Solidgate - Issuer Fraud Notification
          refund_reason_code: '0022'
          card_token:
            token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          card:
            bank: JSC UNIVERSAL BANK
            bin: '444111'
            brand: VISA
            card_exp_month: '12'
            card_exp_year: 2028
            card_holder: John Snow
            card_type: CREDIT
            is_reloadable: true
            card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
            country: USA
            number: 444111XXXXXX9435
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          error:
            code: '2.01'
            messages:
              - Invalid data
            recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
            merchant_advice_code: '30'
          payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
          arn_code: '24871153022084127852235'
          rrn_code: '100034876543'
        transactions:
          <transaction_id_value_#1>:
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            currency: USD
            marketing_amount: 0
            marketing_currency: USD
            operation: auth
            status: processing
            scheme_transaction_id: MDSCAJVIJ1201
            transaction_link_id: A1bCDefGhijkLmNopQrStu
            descriptor: google.com
            billing_details:
              address: 21 Bedford Ave
              city: Boston
              country: USA
              state: NY
              zip: '91191'
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            card:
              bank: JSC UNIVERSAL BANK
              bin: '444111'
              brand: VISA
              card_exp_month: '12'
              card_exp_year: 2028
              card_holder: John Snow
              card_type: CREDIT
              is_reloadable: true
              card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
              country: USA
              number: 444111XXXXXX9435
              card_token:
                token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            error:
              code: '2.01'
              messages:
                - Invalid data
              recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
              merchant_advice_code: '30'
            payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
            arn_code: '24871153022084127852235'
            rrn_code: '100034876543'
        three_ds:
          eci: '05'
          flow: frictionless
          exception: low_value
        routing:
          cascade_steps:
            - mid: mid-1
              mid_descriptor: descriptor-1
              route_id: pm-1
              cascade_number: 1
              segment_id: fps_43bf3b784db24044446e8806723ff5ca
        antifraud_result:
          pre_auth: pass
        verification_result:
          avs_result: matched
          cvv_result: matched
          ani:
            status: performed
            full_name_match: matched
            first_name_match: partially_matched
            last_name_match: not_matched
        chargebacks:
          <chargeback_id_value_#1>:
            id: 12345
            dispute_date: '2025-07-10 00:00:00'
            settlement_date: '2025-07-11 00:00:00'
            amount: 100
            currency: USD
            type: 2nd_chb
            status: reversed
            reason_group: Fraud
            reason_code: '10.4'
            reason_description: Fraud – Card-Absent Environment
            chargeback_flow:
              - id: 12345
                date: '2025-07-10 00:00:00'
                updated_date: '2025-07-11 00:00:00'
                settlement_date: '2025-07-10 00:00:00'
                deadline_date: '2025-07-12 00:00:00'
                amount: 100
                dispute_amount: 0
                currency: USD
                type: 2nd_chb
                status: reversed
                arn_code: '24871153022084127852235'
        device_info:
          user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36
        verify_url: https://merchant.example/verify
        redirect_url: https://merchant.example/redirect
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleCardsRequestApplePay:
      value:
        is_decrypted: false
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12120001111'
        industry_data:
          type: car_rental
          car_rental:
            agreement_number: BKID12345
            renter_name: John
            pick_up_date: '2026-03-01T11:00:00Z'
            drop_off_date: '2026-03-05T16:30:00Z'
            refundability: partially_refundable
            rate: 1000
            rate_indicator: D
            days_rented: '10'
            customer_service_toll_free_number: '8001010123'
            rental_class_id: '0001'
            tax_exempt_indicator: 'Y'
            fuel_charges: 2000
            insurance_charges: 2300
            no_show_indicator: 'N'
            one_way_drop_off_charges: 50000
            return_location_id: AB1234
            pick_up_location:
              street_line_1: 1 Example Street
              state: CA
              city: San Francisco
              country: USA
              postal: SW1A1AA
            drop_off_location:
              street_line_1: 1 Example Street
              state: CA
              city: San Francisco
              country: USA
              postal: SW1A1AA
            distance_limit:
              limit: 500
              unit: miles
              additional_distance_cost:
                amount: 150
                currency: USD
        ip_address: 203.0.113.0
        traffic_source: facebook
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        zip_code: '90210'
        country: USA
        state: WA
        city: Baltimore
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          address: 123 Main St
          zip: '91191'
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        data: qIEHeSmLKw8C5...ZIuf2oPeLhQ1DCaQj
        signature: 1UdDwEB/wQEAwIHgDAPBgkqh...92ICIAR2
        version: EC_v1
        network: VISA
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        header:
          transactionId: 7126df4ff8ac61dc60278b5cd549cc98d16b8f41
          applicationData: null
          ephemeralPublicKey: MFkwEwY......+Dh2JDCwaKeLKXQ0cUM9ya/1wnrtMHXN4A==
          publicKeyHash: mQaQhyhrXX3ZDSQv...ByX0iii0MVHthSQiXQ=
          wrappedKey: null
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsRequestProductBasedPaymentApplePay:
      value:
        is_decrypted: false
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        ip_address: 203.0.113.0
        traffic_source: facebook
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        data: qIEHeSmLKw3C5...ZIuf2oPeLhQ1DCaQj
        signature: 1UdDwEB/wQEAwIHgDAPBgkqh...92ICIAR2
        version: EC_v1
        network: VISA
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        header:
          transactionId: 7126df4ff8ac61dc60278b5cd549cc98d16b8f41
          applicationData: null
          ephemeralPublicKey: MFkwEwY......+Dh2JDCwaKeLKXQ0cUM9ya/1wnrtMHXN4A==
          publicKeyHash: mQaQhyhrXX3ZDSQv...ByX0iii0MVHthSQiXQ=
          wrappedKey: null
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsRequestSubscriptionPaymentApplePay:
      value:
        is_decrypted: false
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        retry_attempt: 3
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        ip_address: 203.0.113.0
        traffic_source: facebook
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        data: qIEHeSmLKw3C5...ZIuf2oPeLhQ1DCaQj
        signature: 1UdDwEB/wQEAwIHgDAPBgkqh...92ICIAR2
        version: EC_v1
        network: VISA
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        header:
          transactionId: 7126df4ff8ac61dc60278b5cd549cc98d16b8f41
          applicationData: null
          ephemeralPublicKey: MFkwEwY......+Dh2JDCwaKeLKXQ0cUM9ya/1wnrtMHXN4A==
          publicKeyHash: mQaQhyhrXX3ZDSQv...ByX0iii0MVHthSQiXQ=
          wrappedKey: null
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsResponseApplePay:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          order_description: Premium package
          psp_order_id: 854756336423874823bdfsg6743gf5
          provider_payment_id: charge_64789DFS3827563HGF56
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          product_name: Luxury product
          amount: 100
          currency: USD
          processing_amount: 0
          processing_currency: USD
          marketing_amount: 0
          marketing_currency: USD
          refunded_amount: 0
          status: settle_ok
          auth_code: 2w9m8
          payment_type: 1-click
          payment_method: apple-pay
          customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
          customer_email: example@example.com
          descriptor: google.com
          mid: bank-mid-1
          ip_address: 203.0.113.0
          traffic_source: facebook
        transaction:
          id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 100
          currency: USD
          marketing_amount: 0
          marketing_currency: USD
          operation: auth
          status: processing
          scheme_transaction_id: MDSCAJVIJ1201
          transaction_link_id: A1bCDefGhijkLmNopQrStu
          descriptor: google.com
          billing_details:
            address: 21 Bedford Ave
            country: USA
            city: Boston
            state: NY
            zip: '91191'
          refund_reason: Solidgate - Issuer Fraud Notification
          refund_reason_code: '0022'
          card_token:
            token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          card:
            bank: JSC UNIVERSAL BANK
            bin: '444111'
            brand: VISA
            card_exp_month: '12'
            card_exp_year: 2028
            card_holder: John Snow
            card_type: CREDIT
            is_reloadable: true
            card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
            country: USA
            number: 444111XXXXXX9435
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          error:
            code: '2.01'
            messages:
              - Invalid data
            recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
            merchant_advice_code: '30'
          payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
          arn_code: '24871153022084127852235'
          rrn_code: '100034876543'
        transactions:
          <transaction_id_value_#1>:
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            currency: USD
            marketing_amount: 0
            marketing_currency: USD
            operation: auth
            status: processing
            scheme_transaction_id: MDSCAJVIJ1201
            transaction_link_id: A1bCDefGhijkLmNopQrStu
            descriptor: google.com
            billing_details:
              address: 21 Bedford Ave
              city: Boston
              country: USA
              state: NY
              zip: '91191'
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            card:
              bank: JSC UNIVERSAL BANK
              bin: '444111'
              brand: VISA
              card_exp_month: '12'
              card_exp_year: 2028
              card_holder: John Snow
              card_type: CREDIT
              is_reloadable: true
              card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
              country: USA
              number: 444111XXXXXX9435
              card_token:
                token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            error:
              code: '2.01'
              messages:
                - Invalid data
              recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
              merchant_advice_code: '30'
            payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
            arn_code: '24871153022084127852235'
            rrn_code: '100034876543'
        three_ds:
          eci: '05'
          flow: frictionless
          exception: low_value
        routing:
          cascade_steps:
            - mid: mid-1
              mid_descriptor: descriptor-1
              route_id: pm-1
              cascade_number: 1
              segment_id: fps_43bf3b784db24044446e8806723ff5ca
        antifraud_result:
          pre_auth: pass
        verification_result:
          avs_result: matched
          cvv_result: matched
          ani:
            status: performed
            full_name_match: matched
            first_name_match: partially_matched
            last_name_match: not_matched
        chargebacks:
          <chargeback_id_value_#1>:
            id: 12345
            dispute_date: '2025-07-10 00:00:00'
            settlement_date: '2025-07-11 00:00:00'
            amount: 100
            currency: USD
            type: 2nd_chb
            status: reversed
            reason_group: Fraud
            reason_code: '10.4'
            reason_description: Fraud – Card-Absent Environment
            chargeback_flow:
              - id: 12345
                date: '2025-07-10 00:00:00'
                updated_date: '2025-07-11 00:00:00'
                settlement_date: '2025-07-10 00:00:00'
                deadline_date: '2025-07-12 00:00:00'
                amount: 100
                dispute_amount: 0
                currency: USD
                type: 2nd_chb
                status: reversed
                arn_code: '24871153022084127852235'
        device_info:
          user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleCardsRequestIncrement:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 500
    ExampleCardsResponseIncrement:
      value:
        transaction:
          id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
          amount: 500
          currency: EUR
          status: processing
    ExampleMainResponseErrorCardBrandNotSupported:
      value:
        error:
          code: '2.04'
          messages:
            - Card brand is not supported
    ExampleCardsRequestRecurring:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        payment_type: 1-click
        recurring_token: 7ats8da7sd8-a66dfa7-a9s9das89t
        force3ds: false
        external_mpi_data:
          three_ds_version: 2.2.0
          eci: '01'
          cryptogram: QURZRU4gM0RTMiBURVNUIENBVlY=
          ds_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          cryptogram_algorithm: A
          three_ds_flow: frictionless
          three_ds_server_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          acs_challenge_mandated_ind: 'Y'
          transaction_challenge_exemption: '05'
          authentication_response: 'Y'
          authentication_timestamp: '2025-12-05T12:00:00.000Z'
          ds_transaction_reason: '01'
          acs_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          authentication_method:
            - '02'
            - '03'
          challenge_cancel_ind: '01'
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsRequestProductBasedPaymentRecurring:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        payment_type: 1-click
        recurring_token: 7ats8da7sd8-a66dfa7-a9s9das89t
        force3ds: false
        external_mpi_data:
          three_ds_version: 2.2.0
          eci: '01'
          cryptogram: QURZRU4gM0RTMiBURVNUIENBVlY=
          ds_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          cryptogram_algorithm: A
          three_ds_flow: frictionless
          three_ds_server_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          acs_challenge_mandated_ind: 'Y'
          transaction_challenge_exemption: '05'
          authentication_response: 'Y'
          authentication_timestamp: '2025-12-05T12:00:00.000Z'
          ds_transaction_reason: '01'
          acs_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          authentication_method:
            - '02'
            - '03'
          challenge_cancel_ind: '01'
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsRequestSubscriptionPaymentRecurring:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: 83b19018-cbc4-45f0-899a-dda84fd2705e
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        payment_type: 1-click
        recurring_token: 7ats8da7sd8-a66dfa7-a9s9das89t
        retry_attempt: 3
        force3ds: false
        external_mpi_data:
          three_ds_version: 2.2.0
          eci: '06'
          cryptogram: QURZRU4gM0RTMiBURVNUIENBVlY=
          ds_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          cryptogram_algorithm: A
          three_ds_flow: frictionless
          three_ds_server_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          acs_challenge_mandated_ind: 'Y'
          transaction_challenge_exemption: '05'
          authentication_response: 'Y'
          authentication_timestamp: '2025-12-05T12:00:00.000Z'
          ds_transaction_reason: '01'
          acs_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          authentication_method:
            - '02'
            - '03'
          challenge_cancel_ind: '01'
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsResponseRecurring:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          order_description: Premium package
          psp_order_id: 854756336423874823bdfsg6743gf5
          provider_payment_id: charge_64789DFS3827563HGF56
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          product_name: Luxury product
          amount: 100
          currency: USD
          processing_amount: 0
          processing_currency: USD
          marketing_amount: 0
          marketing_currency: USD
          refunded_amount: 0
          status: settle_ok
          auth_code: 2w9m8
          payment_type: 1-click
          payment_method: card
          customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
          customer_email: example@example.com
          descriptor: google.com
          mid: bank-mid-1
          ip_address: 203.0.113.0
          traffic_source: facebook
        transaction:
          id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 100
          currency: USD
          marketing_amount: 0
          marketing_currency: USD
          operation: recurring-auth
          status: processing
          scheme_transaction_id: MDSCAJVIJ1201
          transaction_link_id: A1bCDefGhijkLmNopQrStu
          descriptor: google.com
          billing_details:
            address: 21 Bedford Ave
            country: USA
            city: Boston
            state: NY
            zip: '91191'
          refund_reason: Solidgate - Issuer Fraud Notification
          refund_reason_code: '0022'
          card_token:
            token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            original_payment_method: apple-pay
          card:
            bank: JSC UNIVERSAL BANK
            bin: '444111'
            brand: VISA
            card_exp_month: '12'
            card_exp_year: 2028
            card_holder: John Snow
            card_type: CREDIT
            is_reloadable: true
            card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
            country: USA
            number: 444111XXXXXX9435
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
              original_payment_method: apple-pay
          error:
            code: '2.01'
            messages:
              - Invalid data
            recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
            merchant_advice_code: '30'
          payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
          arn_code: '24871153022084127852235'
          rrn_code: '100034876543'
        transactions:
          <transaction_id_value_#1>:
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            currency: USD
            marketing_amount: 0
            marketing_currency: USD
            operation: recurring-auth
            status: processing
            scheme_transaction_id: MDSCAJVIJ1201
            transaction_link_id: A1bCDefGhijkLmNopQrStu
            descriptor: google.com
            billing_details:
              address: 21 Bedford Ave
              city: Boston
              country: USA
              state: NY
              zip: '91191'
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
              original_payment_method: apple-pay
            card:
              bank: JSC UNIVERSAL BANK
              bin: '444111'
              brand: VISA
              card_exp_month: '12'
              card_exp_year: 2028
              card_holder: John Snow
              card_type: CREDIT
              is_reloadable: true
              card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
              country: USA
              number: 444111XXXXXX9435
              card_token:
                token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
                original_payment_method: apple-pay
            error:
              code: '2.01'
              messages:
                - Invalid data
              recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
              merchant_advice_code: '30'
            payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
            arn_code: '24871153022084127852235'
            rrn_code: '100034876543'
        three_ds:
          eci: '01'
          flow: frictionless
          exception: low_value
        antifraud_result:
          pre_auth: pass
        verification_result:
          avs_result: matched
          cvv_result: matched
          ani:
            status: performed
            full_name_match: matched
            first_name_match: partially_matched
            last_name_match: not_matched
        chargebacks:
          <chargeback_id_value_#1>:
            id: 12345
            dispute_date: '2025-07-10 00:00:00'
            settlement_date: '2025-07-11 00:00:00'
            amount: 100
            currency: USD
            type: 2nd_chb
            status: reversed
            reason_group: Fraud
            reason_code: '10.4'
            reason_description: Fraud – Card-Absent Environment
            chargeback_flow:
              - id: 12345
                date: '2025-07-10 00:00:00'
                updated_date: '2025-07-11 00:00:00'
                settlement_date: '2025-07-10 00:00:00'
                deadline_date: '2025-07-12 00:00:00'
                amount: 100
                dispute_amount: 0
                currency: USD
                type: 2nd_chb
                status: reversed
                arn_code: '24871153022084127852235'
        device_info:
          user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleCardsRequestResign:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        recurring_token: 7ats8da7sd8-a66dfa7-a9s9das89t
        force3ds: false
        external_mpi_data:
          three_ds_version: 2.2.0
          eci: '05'
          cryptogram: QURZRU4gM0RTMiBURVNUIENBVlY=
          ds_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          cryptogram_algorithm: A
          three_ds_flow: frictionless
          three_ds_server_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          acs_challenge_mandated_ind: 'Y'
          transaction_challenge_exemption: '05'
          authentication_response: 'Y'
          authentication_timestamp: '2025-12-05T12:00:00.000Z'
          ds_transaction_reason: '01'
          acs_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          authentication_method:
            - '02'
            - '03'
          challenge_cancel_ind: '01'
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        card_cvv: '123'
        industry_data:
          type: car_rental
          car_rental:
            agreement_number: BKID12345
            renter_name: John
            pick_up_date: '2026-03-01T11:00:00Z'
            drop_off_date: '2026-03-05T16:30:00Z'
            refundability: partially_refundable
            rate: 1000
            rate_indicator: D
            days_rented: '10'
            customer_service_toll_free_number: '8001010123'
            rental_class_id: '0001'
            tax_exempt_indicator: 'Y'
            fuel_charges: 2000
            insurance_charges: 2300
            no_show_indicator: 'N'
            one_way_drop_off_charges: 50000
            return_location_id: AB1234
            pick_up_location:
              street_line_1: 1 Example Street
              state: CA
              city: San Francisco
              country: USA
              postal: SW1A1AA
            drop_off_location:
              street_line_1: 1 Example Street
              state: CA
              city: San Francisco
              country: USA
              postal: SW1A1AA
            distance_limit:
              limit: 500
              unit: miles
              additional_distance_cost:
                amount: 150
                currency: USD
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        zip_code: '90210'
        country: USA
        state: WA
        city: Baltimore
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsRequestProductBasedPaymentResign:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        recurring_token: 7ats8da7sd8-a66dfa7-a9s9das89t
        force3ds: false
        external_mpi_data:
          three_ds_version: 2.2.0
          eci: '05'
          cryptogram: QURZRU4gM0RTMiBURVNUIENBVlY=
          ds_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          cryptogram_algorithm: A
          three_ds_flow: frictionless
          three_ds_server_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          acs_challenge_mandated_ind: 'Y'
          transaction_challenge_exemption: '05'
          authentication_response: 'Y'
          authentication_timestamp: '2025-12-05T12:00:00.000Z'
          ds_transaction_reason: '01'
          acs_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          authentication_method:
            - '02'
            - '03'
          challenge_cancel_ind: '01'
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        card_cvv: '123'
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsRequestSubscriptionPaymentResign:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: 83b19018-cbc4-45f0-899a-dda84fd2705e
        currency: EUR
        order_description: Premium package
        order_items: item 1 x 10, item 2 x 30
        order_date: '2025-12-21 11:21:30'
        order_number: 9
        settle_interval: 0
        authorization_type: final
        recurring_token: 7ats8da7sd8-a66dfa7-a9s9das89t
        retry_attempt: 3
        force3ds: false
        external_mpi_data:
          three_ds_version: 2.2.0
          eci: '02'
          cryptogram: QURZRU4gM0RTMiBURVNUIENBVlY=
          ds_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          cryptogram_algorithm: A
          three_ds_flow: frictionless
          three_ds_server_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          acs_challenge_mandated_ind: 'Y'
          transaction_challenge_exemption: '05'
          authentication_response: 'Y'
          authentication_timestamp: '2025-12-05T12:00:00.000Z'
          ds_transaction_reason: '01'
          acs_transaction_id: 6edcc246-23ee-4e94-ac5d-8ae620bea7d9
          authentication_method:
            - '02'
            - '03'
          challenge_cancel_ind: '01'
        customer_account_id: 4245d7b0-a84c-4623-91ff-e9de0254735b
        customer_date_of_birth: '1988-11-21'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_phone: '+12025550123'
        card_cvv: '123'
        ip_address: 203.0.113.0
        traffic_source: facebook
        transaction_source: main_menu
        purchase_country: USA
        geo_country: USA
        geo_city: New Castle
        country: USA
        state: WA
        city: Baltimore
        zip_code: '90210'
        address: Apt. 123, 321 Main Street
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          address: 123 Main St
        language: en
        website: merchant.example
        device: iPhone 8 iOS 12.0
        device_sessions:
          - id: dsid_3a20_f9c1_4cd8_89d3_1c5
            provider: checkout
        platform: WEB
        header_accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng
        header_accept_language: en-US
        browser_color_depth: 32
        browser_screen_height: 1920
        browser_screen_width: 1280
        browser_java_enabled: true
        time_zone_offset: -120
        user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        payment_type_data:
          panama_id: '81234567'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleCardsResponseResign:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          order_description: Premium package
          psp_order_id: 854756336423874823bdfsg6743gf5
          provider_payment_id: charge_64789DFS3827563HGF56
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          product_name: Luxury product
          amount: 100
          currency: USD
          processing_amount: 0
          processing_currency: USD
          marketing_amount: 0
          marketing_currency: USD
          refunded_amount: 0
          status: settle_ok
          auth_code: 2w9m8
          payment_type: 1-click
          payment_method: card
          customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
          customer_email: example@example.com
          descriptor: google.com
          mid: bank-mid-1
          ip_address: 203.0.113.0
          traffic_source: facebook
        transaction:
          id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 100
          currency: USD
          marketing_amount: 0
          marketing_currency: USD
          operation: auth
          status: processing
          scheme_transaction_id: MDSCAJVIJ1201
          transaction_link_id: A1bCDefGhijkLmNopQrStu
          descriptor: google.com
          billing_details:
            address: 21 Bedford Ave
            country: USA
            city: Boston
            state: NY
            zip: '91191'
          refund_reason: Solidgate - Issuer Fraud Notification
          refund_reason_code: '0022'
          card_token:
            token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          card:
            bank: JSC UNIVERSAL BANK
            bin: '444111'
            brand: VISA
            card_exp_month: '12'
            card_exp_year: 2028
            card_holder: John Snow
            card_type: CREDIT
            is_reloadable: true
            card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
            country: USA
            number: 444111XXXXXX9435
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          error:
            code: '2.01'
            messages:
              - Invalid data
            recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
            merchant_advice_code: '30'
          payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
          arn_code: '24871153022084127852235'
          rrn_code: '100034876543'
        transactions:
          <transaction_id_value_#1>:
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            currency: USD
            marketing_amount: 0
            marketing_currency: USD
            operation: auth
            status: processing
            scheme_transaction_id: MDSCAJVIJ1201
            transaction_link_id: A1bCDefGhijkLmNopQrStu
            descriptor: google.com
            billing_details:
              address: 21 Bedford Ave
              city: Boston
              country: USA
              state: NY
              zip: '91191'
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            card:
              bank: JSC UNIVERSAL BANK
              bin: '444111'
              brand: VISA
              card_exp_month: '12'
              card_exp_year: 2028
              card_holder: John Snow
              card_type: CREDIT
              is_reloadable: true
              card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
              country: USA
              number: 444111XXXXXX9435
              card_token:
                token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            error:
              code: '2.01'
              messages:
                - Invalid data
              recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
              merchant_advice_code: '30'
            payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
            arn_code: '24871153022084127852235'
            rrn_code: '100034876543'
        three_ds:
          eci: '02'
          flow: none
          exception: transaction_risk_assessment
        routing:
          cascade_steps:
            - mid: mid-1
              mid_descriptor: descriptor-1
              route_id: pm-1
              cascade_number: 1
              segment_id: fps_43bf3b784db24044446e8806723ff5ca
        antifraud_result:
          pre_auth: pass
        verification_result:
          avs_result: matched
          cvv_result: matched
          ani:
            status: performed
            full_name_match: matched
            first_name_match: partially_matched
            last_name_match: not_matched
        chargebacks:
          <chargeback_id_value_#1>:
            id: 12345
            dispute_date: '2025-07-10 00:00:00'
            settlement_date: '2025-07-11 00:00:00'
            amount: 100
            currency: USD
            type: 2nd_chb
            status: reversed
            reason_group: Fraud
            reason_code: '10.4'
            reason_description: Fraud – Card-Absent Environment
            chargeback_flow:
              - id: 12345
                date: '2025-07-10 00:00:00'
                updated_date: '2025-07-11 00:00:00'
                settlement_date: '2025-07-10 00:00:00'
                deadline_date: '2025-07-12 00:00:00'
                amount: 100
                dispute_amount: 0
                currency: USD
                type: 2nd_chb
                status: reversed
                arn_code: '24871153022084127852235'
        device_info:
          user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36
        verify_url: https://merchant.example/verify
        redirect_url: https://merchant.example/redirect
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleCardsRequestRefund:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        refund_reason_code: '0022'
    ExampleCardsResponseRefund:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          order_description: Premium package
          psp_order_id: 854756336423874823bdfsg6743gf5
          provider_payment_id: charge_64789DFS3827563HGF56
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          product_name: Luxury product
          amount: 100
          currency: USD
          processing_amount: 0
          processing_currency: USD
          marketing_amount: 0
          marketing_currency: USD
          refunded_amount: 0
          status: processing
          auth_code: 2w9m8
          payment_type: 1-click
          payment_method: card
          customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
          customer_email: example@example.com
          descriptor: google.com
          mid: bank-mid-1
          ip_address: 203.0.113.0
          traffic_source: facebook
        transaction:
          id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 100
          currency: USD
          marketing_amount: 0
          marketing_currency: USD
          operation: auth
          status: processing
          scheme_transaction_id: MDSCAJVIJ1201
          transaction_link_id: A1bCDefGhijkLmNopQrStu
          descriptor: google.com
          billing_details:
            address: 21 Bedford Ave
            country: USA
            city: Boston
            state: NY
            zip: '91191'
          refund_reason: Solidgate - Issuer Fraud Notification
          refund_reason_code: '0022'
          card_token:
            token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          card:
            bank: JSC UNIVERSAL BANK
            bin: '444111'
            brand: VISA
            card_exp_month: '12'
            card_exp_year: 2028
            card_holder: John Snow
            card_type: CREDIT
            is_reloadable: true
            card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
            country: USA
            number: 444111XXXXXX9435
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          error:
            code: '2.01'
            messages:
              - Invalid data
            recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
            merchant_advice_code: '30'
          payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
          arn_code: '24871153022084127852235'
          rrn_code: '100034876543'
        transactions:
          <transaction_id_value_#1>:
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            currency: USD
            marketing_amount: 0
            marketing_currency: USD
            operation: auth
            status: processing
            scheme_transaction_id: MDSCAJVIJ1201
            transaction_link_id: A1bCDefGhijkLmNopQrStu
            descriptor: google.com
            billing_details:
              address: 21 Bedford Ave
              city: Boston
              country: USA
              state: NY
              zip: '91191'
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            card:
              bank: JSC UNIVERSAL BANK
              bin: '444111'
              brand: VISA
              card_exp_month: '12'
              card_exp_year: 2028
              card_holder: John Snow
              card_type: CREDIT
              is_reloadable: true
              card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
              country: USA
              number: 444111XXXXXX9435
              card_token:
                token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            error:
              code: '2.01'
              messages:
                - Invalid data
              recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
              merchant_advice_code: '30'
            payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
            arn_code: '24871153022084127852235'
            rrn_code: '100034876543'
        three_ds:
          eci: '07'
          flow: unspecified
          exception: low_value
        routing:
          cascade_steps:
            - mid: mid-1
              mid_descriptor: descriptor-1
              route_id: pm-1
              cascade_number: 1
              segment_id: fps_43bf3b784db24044446e8806723ff5ca
        antifraud_result:
          pre_auth: pass
        verification_result:
          avs_result: matched
          cvv_result: matched
          ani:
            status: performed
            full_name_match: matched
            first_name_match: partially_matched
            last_name_match: not_matched
        chargebacks:
          <chargeback_id_value_#1>:
            id: 12345
            dispute_date: '2025-07-10 00:00:00'
            settlement_date: '2025-07-11 00:00:00'
            amount: 100
            currency: USD
            type: 2nd_chb
            status: reversed
            reason_group: Fraud
            reason_code: '10.4'
            reason_description: Fraud – Card-Absent Environment
            chargeback_flow:
              - id: 12345
                date: '2025-07-10 00:00:00'
                updated_date: '2025-07-11 00:00:00'
                settlement_date: '2025-07-10 00:00:00'
                deadline_date: '2025-07-12 00:00:00'
                amount: 100
                dispute_amount: 0
                currency: USD
                type: 2nd_chb
                status: reversed
                arn_code: '24871153022084127852235'
        device_info:
          user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleCardsResponseVoid:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          order_description: Premium package
          psp_order_id: 854756336423874823bdfsg6743gf5
          provider_payment_id: charge_64789DFS3827563HGF56
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          product_name: Luxury product
          amount: 100
          currency: USD
          processing_amount: 0
          processing_currency: USD
          marketing_amount: 0
          marketing_currency: USD
          refunded_amount: 0
          status: settle_ok
          auth_code: 2w9m8
          payment_type: 1-click
          payment_method: card
          customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
          customer_email: example@example.com
          descriptor: google.com
          mid: bank-mid-1
          ip_address: 203.0.113.0
          traffic_source: facebook
        transaction:
          id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 100
          currency: USD
          marketing_amount: 0
          marketing_currency: USD
          operation: auth
          status: processing
          scheme_transaction_id: MDSCAJVIJ1201
          transaction_link_id: A1bCDefGhijkLmNopQrStu
          descriptor: google.com
          billing_details:
            address: 21 Bedford Ave
            country: USA
            city: Boston
            state: NY
            zip: '91191'
          refund_reason: Solidgate - Issuer Fraud Notification
          refund_reason_code: '0022'
          card_token:
            token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          card:
            bank: JSC UNIVERSAL BANK
            bin: '444111'
            brand: VISA
            card_exp_month: '12'
            card_exp_year: 2028
            card_holder: John Snow
            card_type: CREDIT
            is_reloadable: true
            card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
            country: USA
            number: 444111XXXXXX9435
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          error:
            code: '2.01'
            messages:
              - Invalid data
            recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
            merchant_advice_code: '30'
          payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
          arn_code: '24871153022084127852235'
          rrn_code: '100034876543'
        transactions:
          <transaction_id_value_#1>:
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            currency: USD
            marketing_amount: 0
            marketing_currency: USD
            operation: auth
            status: processing
            scheme_transaction_id: MDSCAJVIJ1201
            transaction_link_id: A1bCDefGhijkLmNopQrStu
            descriptor: google.com
            billing_details:
              address: 21 Bedford Ave
              city: Boston
              country: USA
              state: NY
              zip: '91191'
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            card:
              bank: JSC UNIVERSAL BANK
              bin: '444111'
              brand: VISA
              card_exp_month: '12'
              card_exp_year: 2028
              card_holder: John Snow
              card_type: CREDIT
              is_reloadable: true
              card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
              country: USA
              number: 444111XXXXXX9435
              card_token:
                token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            error:
              code: '2.01'
              messages:
                - Invalid data
              recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
              merchant_advice_code: '30'
            payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
            arn_code: '24871153022084127852235'
            rrn_code: '100034876543'
        three_ds:
          eci: '05'
          flow: frictionless
          exception: low_value
        routing:
          cascade_steps:
            - mid: mid-1
              mid_descriptor: descriptor-1
              route_id: pm-1
              cascade_number: 1
              segment_id: fps_43bf3b784db24044446e8806723ff5ca
        antifraud_result:
          pre_auth: pass
        verification_result:
          avs_result: matched
          cvv_result: matched
          ani:
            status: performed
            full_name_match: matched
            first_name_match: partially_matched
            last_name_match: not_matched
        chargebacks:
          <chargeback_id_value_#1>:
            id: 12345
            dispute_date: '2025-07-10 00:00:00'
            settlement_date: '2025-07-11 00:00:00'
            amount: 100
            currency: USD
            type: 2nd_chb
            status: reversed
            reason_group: Fraud
            reason_code: '10.4'
            reason_description: Fraud – Card-Absent Environment
            chargeback_flow:
              - id: 12345
                date: '2025-07-10 00:00:00'
                updated_date: '2025-07-11 00:00:00'
                settlement_date: '2025-07-10 00:00:00'
                deadline_date: '2025-07-12 00:00:00'
                amount: 100
                dispute_amount: 0
                currency: USD
                type: 2nd_chb
                status: reversed
                arn_code: '24871153022084127852235'
        device_info:
          user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleCardsResponseSettle:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          order_description: Premium package
          psp_order_id: 854756336423874823bdfsg6743gf5
          provider_payment_id: charge_64789DFS3827563HGF56
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          product_name: Luxury product
          amount: 100
          currency: USD
          processing_amount: 0
          processing_currency: USD
          marketing_amount: 0
          marketing_currency: USD
          refunded_amount: 0
          status: settle_ok
          auth_code: 2w9m8
          payment_type: 1-click
          payment_method: card
          customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
          customer_email: example@example.com
          descriptor: google.com
          mid: bank-mid-1
          ip_address: 203.0.113.0
          traffic_source: facebook
        transaction:
          id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 100
          currency: USD
          marketing_amount: 0
          marketing_currency: USD
          operation: auth
          status: processing
          scheme_transaction_id: MDSCAJVIJ1201
          transaction_link_id: A1bCDefGhijkLmNopQrStu
          descriptor: google.com
          billing_details:
            address: 21 Bedford Ave
            country: USA
            city: Boston
            state: NY
            zip: '91191'
          refund_reason: Solidgate - Issuer Fraud Notification
          refund_reason_code: '0022'
          card_token:
            token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          card:
            bank: JSC UNIVERSAL BANK
            bin: '444111'
            brand: VISA
            card_exp_month: '12'
            card_exp_year: 2028
            card_holder: John Snow
            card_type: CREDIT
            is_reloadable: true
            card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
            country: USA
            number: 444111XXXXXX9435
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          error:
            code: '2.01'
            messages:
              - Invalid data
            recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
            merchant_advice_code: '30'
          payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
          arn_code: '24871153022084127852235'
          rrn_code: '100034876543'
        transactions:
          <transaction_id_value_#1>:
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            currency: USD
            marketing_amount: 0
            marketing_currency: USD
            operation: auth
            status: processing
            scheme_transaction_id: MDSCAJVIJ1201
            transaction_link_id: A1bCDefGhijkLmNopQrStu
            descriptor: google.com
            billing_details:
              address: 21 Bedford Ave
              city: Boston
              country: USA
              state: NY
              zip: '91191'
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            card:
              bank: JSC UNIVERSAL BANK
              bin: '444111'
              brand: VISA
              card_exp_month: '12'
              card_exp_year: 2028
              card_holder: John Snow
              card_type: CREDIT
              is_reloadable: true
              card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
              country: USA
              number: 444111XXXXXX9435
              card_token:
                token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            error:
              code: '2.01'
              messages:
                - Invalid data
              recommended_message_for_user: The problem here lies with the data format and accuracy, validation error on the acquiring side
              merchant_advice_code: '30'
            payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
            arn_code: '24871153022084127852235'
            rrn_code: '100034876543'
        three_ds:
          eci: '06'
          flow: challenge
          exception: transaction_risk_assessment
        routing:
          cascade_steps:
            - mid: mid-1
              mid_descriptor: descriptor-1
              route_id: pm-1
              cascade_number: 1
              segment_id: fps_43bf3b784db24044446e8806723ff5ca
        antifraud_result:
          pre_auth: pass
        verification_result:
          avs_result: matched
          cvv_result: matched
          ani:
            status: performed
            full_name_match: matched
            first_name_match: partially_matched
            last_name_match: not_matched
        chargebacks:
          <chargeback_id_value_#1>:
            id: 12345
            dispute_date: '2025-07-10 00:00:00'
            settlement_date: '2025-07-11 00:00:00'
            amount: 100
            currency: USD
            type: 2nd_chb
            status: reversed
            reason_group: Fraud
            reason_code: '10.4'
            reason_description: Fraud – Card-Absent Environment
            chargeback_flow:
              - id: 12345
                date: '2025-07-10 00:00:00'
                updated_date: '2025-07-11 00:00:00'
                settlement_date: '2025-07-10 00:00:00'
                deadline_date: '2025-07-12 00:00:00'
                amount: 100
                dispute_amount: 0
                currency: USD
                type: 2nd_chb
                status: reversed
                arn_code: '24871153022084127852235'
        device_info:
          user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleCardsResponseStatus:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          order_description: Premium package
          psp_order_id: 854756336423874823bdfsg6743gf5
          provider_payment_id: charge_64789DFS3827563HGF56
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          product_name: Luxury product
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          amount: 100
          currency: USD
          processing_amount: 0
          processing_currency: USD
          marketing_amount: 0
          marketing_currency: USD
          refunded_amount: 0
          authorized_amount: 100
          status: auth_ok
          auth_code: 2w9m8
          payment_type: 1-click
          payment_method: card
          customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
          customer_email: example@example.com
          descriptor: google.com
          mid: bank-mid-1
          ip_address: 203.0.113.0
          traffic_source: facebook
        error:
          code: '3.08'
          messages:
            - Do not honor
          recommended_message_for_user: Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction
        transaction:
          id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 100
          currency: USD
          marketing_amount: 0
          marketing_currency: USD
          operation: auth
          status: processing
          authorization_type: final
          scheme_transaction_id: MDSCAJVIJ1201
          transaction_link_id: A1bCDefGhijkLmNopQrStu
          descriptor: google.com
          billing_details:
            address: 21 Bedford Ave
            country: USA
            city: Boston
            state: NY
            zip: '91191'
          refund_reason: Solidgate - Issuer Fraud Notification
          refund_reason_code: '0022'
          card_token:
            token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            original_payment_method: apple-pay
          card:
            bank: JSC UNIVERSAL BANK
            bin: '444111'
            brand: VISA
            card_exp_month: '12'
            card_exp_year: 2028
            card_holder: John Snow
            card_type: CREDIT
            is_reloadable: true
            card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
            country: USA
            number: 444111XXXXXX9435
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
              original_payment_method: apple-pay
          error:
            code: '3.08'
            messages:
              - Do not honor
            recommended_message_for_user: Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction
          payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
          arn_code: '24871153022084127852235'
          rrn_code: '100034876543'
        transactions:
          <transaction_id_value_#1>:
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            currency: USD
            marketing_amount: 0
            marketing_currency: USD
            operation: auth
            status: processing
            authorization_type: final
            scheme_transaction_id: MDSCAJVIJ1201
            transaction_link_id: A1bCDefGhijkLmNopQrStu
            descriptor: google.com
            billing_details:
              address: 21 Bedford Ave
              city: Boston
              country: USA
              state: NY
              zip: '91191'
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
              original_payment_method: apple-pay
            card:
              bank: JSC UNIVERSAL BANK
              bin: '444111'
              brand: VISA
              card_exp_month: '12'
              card_exp_year: 2028
              card_holder: John Snow
              card_type: CREDIT
              is_reloadable: true
              card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
              country: USA
              number: 444111XXXXXX9435
              card_token:
                token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
                original_payment_method: apple-pay
            error:
              code: '3.08'
              messages:
                - Do not honor
              recommended_message_for_user: Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction
              merchant_advice_code: '30'
            payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
            arn_code: '24871153022084127852235'
            rrn_code: '100034876543'
        three_ds:
          eci: '05'
          flow: frictionless
          exception: low_value
        routing:
          cascade_steps:
            - mid: mid-1
              mid_descriptor: descriptor-1
              route_id: pm-1
              cascade_number: 1
              segment_id: fps_43bf3b784db24044446e8806723ff5ca
        antifraud_result:
          pre_auth: review
        verification_result:
          avs_result: matched
          cvv_result: matched
          ani:
            status: performed
            full_name_match: matched
            first_name_match: partially_matched
            last_name_match: not_matched
        chargebacks:
          <chargeback_id_value_#1>:
            id: 12345
            dispute_date: '2025-07-10 00:00:00'
            settlement_date: '2025-07-11 00:00:00'
            amount: 100
            currency: USD
            type: 2nd_chb
            status: reversed
            reason_group: Fraud
            reason_code: '10.4'
            reason_description: Fraud – Card-Absent Environment
            chargeback_flow:
              - id: 12345
                date: '2025-07-10 00:00:00'
                updated_date: '2025-07-11 00:00:00'
                settlement_date: '2025-07-10 00:00:00'
                deadline_date: '2025-07-12 00:00:00'
                amount: 100
                dispute_amount: 0
                currency: USD
                type: 2nd_chb
                status: reversed
                arn_code: '24871153022084127852235'
        device_info:
          user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36
        verify_url: https://merchant.example/verify
        redirect_url: https://merchant.example/redirect
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleCardsResponseError:
      value:
        error:
          code: '2.01'
          messages:
            - Invalid data
          recommended_message_for_user: Double-check and correct payment details.
    ExampleCardsResponseArn:
      value:
        arn_codes:
          - arn_code: '24871153022084127852235'
            created_at: '2025-12-27 11:45:30'
            amount_refunded: 100
            currency: USD
            transaction_status: success
    ExampleApmRequestInitPaymentPaypal:
      value:
        payment_method: paypal-vault
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: USD
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: '10005'
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentAlipay:
      value:
        payment_method: alipay
        order_id: order_20251221_CNY_8900
        amount: 8900
        currency: CNY
        future_usage:
          payment_type: one-time
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: test@merchant.example
        customer_first_name: Wei
        customer_last_name: Zhang
        customer_phone: '+8613812345678'
        item_category: digital_goods
        billing_address:
          country: CHN
          city: Shanghai
          zip: '200000'
          line1: 123 Nanjing Road
          line2: Apt. 456
        language: en
        ip_address: 8.8.8.8
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          coupon_code: CNY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleApmRequestInitPaymentBlik:
      value:
        payment_method: blik
        payment_method_flow: direct
        future_usage:
          payment_type: unscheduled
        payment_type_data:
          blik_code: '123456'
        order_id: order_sub_20240401
        amount: 2999
        currency: PLN
        order_description: Monthly Premium Plan
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: customer@example.pl
        customer_first_name: Nikola
        customer_last_name: Tesla
        billing_address:
          country: POL
        ip_address: 178.12.34.56
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentBizum:
      value:
        payment_method: bizum
        order_id: order_20251021_EUR_400
        amount: 400
        currency: EUR
        future_usage:
          payment_type: one-time
        order_description: Premium package
        order_date: '2025-10-21 13:49:00'
        customer_account_id: user_id_12345
        customer_email: test@merchant.example
        customer_first_name: Carlos
        customer_last_name: García
        customer_phone: '+34700000000'
        item_category: digital_goods
        billing_address:
          country: ESP
          city: Madrid
          zip: '28001'
          line1: Calle Gran Vía 123
          line2: Piso 4
        language: en
        ip_address: 8.8.8.8
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          coupon_code: ES2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleApmRequestInitPaymentBoleto:
      value:
        payment_method: boleto
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        payment_method_flow: redirect
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: BRA
          state: SP
          city: São Paulo
          zip: '04530'
          line1: Avenida 1234
          line2: Apart 56
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          brazil_cpf: '23100299900'
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentEfecty:
      value:
        payment_method: efecty
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 10000
        currency: COP
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: '12345'
        customer_email: example@example.com
        customer_first_name: Alejandro
        customer_last_name: Gomez
        customer_date_of_birth: '2000-11-21'
        customer_phone: '+15551234567'
        billing_address:
          country: COL
          state: Cundinamarca
          city: Bogotá
          zip: '54321'
          line1: 'Carrera 7 # 123'
          line2: Apto 456
        shipping_address:
          country: COL
          state: Antioquia
          city: Medellín
          zip: '12345'
          line1: 'Calle 45 # 789'
          line2: Unit 789
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          colombia_cc: '42141221'
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentGcash:
      value:
        payment_method: gcash
        order_id: order_20251103_PHP_2575
        amount: 2575
        currency: PHP
        order_description: Premium package
        order_date: '2025-11-03 15:51:00'
        customer_account_id: user_id_67890
        customer_email: example.user@example.com
        customer_first_name: Maria
        customer_last_name: Santos
        customer_phone: '+639171234567'
        item_category: digital_goods
        billing_address:
          country: PHL
          city: Manila
          zip: '1000'
          line1: 123 Rizal Avenue
          line2: Unit 5B
        language: en
        ip_address: 8.8.8.8
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          coupon_code: PH2025
          partner_id: '123989'
        return_url: https://merchant.example
    ExampleApmRequestInitPaymentIdeal:
      value:
        payment_method: ideal
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: '10005'
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentMbway:
      value:
        payment_method: mbway
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        future_usage:
          payment_type: one-time
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: PRT
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestInitPaymentMercadopago:
      value:
        payment_method: mercadopago
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: '10005'
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          argentina_dni: 42243309
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentMultibanco:
      value:
        payment_method: multibanco
        order_id: order_abc123
        amount: 2490
        currency: EUR
        future_usage:
          payment_type: one-time
        order_description: 'Order #abc123'
        order_date: '2026-04-23 10:31:44'
        customer_account_id: user_id_abc123
        customer_email: buyer@example.pt
        customer_first_name: João
        customer_last_name: Silva
        customer_phone: '+351912345678'
        billing_address:
          country: PRT
          city: Lisboa
          zip: 1250-096
          line1: Avenida da Liberdade 100
          line2: 3º Esq.
        language: en
        ip_address: 178.12.34.56
        platform: WEB
        user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
        order_metadata:
          coupon_code: PT2026
          partner_id: '123989'
    ExampleApmRequestInitPaymentOxxo:
      value:
        payment_method: oxxo
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: MXN
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_email: example@example.com
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: '10005'
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          mexico_curp: ZAZD801124MBSYQN13
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentOpenbanking:
      value:
        payment_method: openbanking
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        order_description: Premium package
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: test@merchant.example
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: DEU
          state: BE
          city: Berlin
          zip: '10115'
          line1: Alexanderplatz 1
          line2: Apartment 123
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentPixQr:
      summary: Pix QR
      value:
        payment_method: pix-qr
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: BRA
          state: SP
          city: São Paulo
          zip: '04530'
          line1: Avenida 1234
          line2: Apart 56
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          brazil_cpf: '23100299900'
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentPixAutomatico:
      summary: Pix Automático
      value:
        payment_method: pix-automatico
        order_id: order_1234567890
        amount: 1000
        currency: BRL
        future_usage:
          payment_type: recurring
          billing_period:
            unit: day
            value: 7
          max_amount: 10000
        order_description: Premium package
        customer_email: example@example.com
        customer_first_name: John
        customer_last_name: Doe
        ip_address: 203.0.113.0
        platform: WEB
        billing_address:
          country: BRA
        payment_type_data:
          brazil_cpf: '12345678901'
    ExampleApmRequestInitPaymentPrzelewy24:
      value:
        payment_method: przelewy24
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: PLN
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: '10005'
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentPse:
      value:
        payment_method: pse
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 10000
        currency: COP
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: '12345'
        customer_email: example@example.com
        customer_first_name: Alejandro
        customer_last_name: Gomez
        customer_date_of_birth: '2000-11-21'
        customer_phone: '+15551234567'
        billing_address:
          country: COL
          state: Cundinamarca
          city: Bogotá
          zip: '54321'
          line1: 'Carrera 7 # 123'
          line2: Apto 456
        shipping_address:
          country: COL
          state: Antioquia
          city: Medellín
          zip: '12345'
          line1: 'Calle 45 # 789'
          line2: Unit 789
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          colombia_cc: '42141221'
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentSencillito:
      value:
        payment_method: sencillito
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1000
        currency: CLP
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: '12345'
        customer_email: example@example.com
        customer_first_name: Isabella
        customer_last_name: Martinez
        customer_date_of_birth: '2000-11-21'
        customer_phone: '+15551234567'
        billing_address:
          country: CHL
          state: Region Metropolitana
          city: Santiago
          zip: '123456'
          line1: 123 Main Street
          line2: Apartment 456
        shipping_address:
          country: CHL
          state: Region Metropolitana
          city: Santiago
          zip: '654321'
          line1: 789 Elm Street
          line2: Unit 789
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          chile_ci: 5633554V
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentServipag:
      value:
        payment_method: servipag
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1000
        currency: CLP
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: '12345'
        customer_email: example@example.com
        customer_first_name: Isabella
        customer_last_name: Martinez
        customer_date_of_birth: '2000-11-21'
        customer_phone: '+15551234567'
        billing_address:
          country: CHL
          state: Region Metropolitana
          city: Santiago
          zip: '123456'
          line1: 123 Main Street
          line2: Apartment 456
        shipping_address:
          country: CHL
          state: Region Metropolitana
          city: Santiago
          zip: '654321'
          line1: 789 Elm Street
          line2: Unit 789
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          chile_ci: 5633554V
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentPix:
      value:
        payment_method: pix
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: BRA
          state: SP
          city: São Paulo
          zip: '04530'
          line1: Avenida 1234
          line2: Apart 56
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          brazil_cpf: '23100299900'
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentUpi:
      value:
        payment_method: upi
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: INR
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: IND
          state: Maharashtra
          city: Mumbai
          zip: '400001'
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: IND
          state: Karnataka
          city: Bengaluru
          zip: '560001'
          line1: No. 1, MG Road
          line2: Near Brigade Road Junction
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          india_vpa: 1234567890@abc
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestInitPaymentWebpay:
      value:
        payment_method: webpay
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1000
        currency: CLP
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: '12345'
        customer_email: example@example.com
        customer_first_name: Isabella
        customer_last_name: Martinez
        customer_date_of_birth: '2000-11-21'
        customer_phone: '+15551234567'
        billing_address:
          country: CHL
          state: Region Metropolitana
          city: Santiago
          zip: '123456'
          line1: 123 Main Street
          line2: Apartment 456
        shipping_address:
          country: CHL
          state: Region Metropolitana
          city: Santiago
          zip: '654321'
          line1: 789 Elm Street
          line2: Unit 789
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          chile_ci: 5633554V
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestInitPaymentWechatpay:
      value:
        payment_method: wechatpay
        order_id: order_20251221_CNY_8901
        amount: 8900
        currency: CNY
        future_usage:
          payment_type: one-time
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: test@merchant.example
        customer_first_name: Li
        customer_last_name: Wang
        customer_phone: '+8613812345678'
        item_category: digital_goods
        billing_address:
          country: CHN
          city: Beijing
          zip: '100000'
          line1: 456 Chang'an Avenue
          line2: Building 3
        language: en
        ip_address: 8.8.8.8
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          coupon_code: WX2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleApmRequestOneTimeProductPaypal:
      value:
        payment_method: paypal-vault
        order_id: f3g4h5i6-7j8k-90l1-m2n3-456op789qr12
        product_id: g4h5i6j7-k8l9-01m2-n345-op678qr901st
        currency: USD
        order_description: Platinum plan
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: 10005
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: 91191
          line1: 777 Main St.
          line2: Apt. 321
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductAlipay:
      value:
        payment_method: alipay
        order_id: order_prod_20251221_CNY_001
        product_id: g4h5i6j7-k8l9-01m2-n345-op678qr901st
        currency: CNY
        future_usage:
          payment_type: one-time
        order_description: Platinum plan
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: test@merchant.example
        customer_first_name: Wei
        customer_last_name: Zhang
        customer_phone: '+8613812345678'
        item_category: digital_goods
        billing_address:
          country: CHN
          city: Shanghai
          zip: '200000'
          line1: 123 Nanjing Road
          line2: Apt. 456
        ip_address: 8.8.8.8
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleApmRequestOneTimeProductBlik:
      value:
        payment_method: blik
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: PLN
        order_description: Deluxe membership
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: '10005'
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        ip_address: 203.0.113.0
        platform: MOB
        user_agent: Mozilla/5.0
        payment_type_data:
          blik_code: '777111'
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductBoleto:
      value:
        payment_method: boleto
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        payment_method_flow: redirect
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: BRA
          state: SP
          city: São Paulo
          zip: '04530'
          line1: Avenida 1234
          line2: Apart 56
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          brazil_cpf: '23100299900'
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductEfecty:
      value:
        payment_method: efecty
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: COP
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: '12345'
        customer_email: example@example.com
        customer_first_name: Alejandro
        customer_last_name: Gomez
        customer_date_of_birth: '2000-11-21'
        customer_phone: '+15551234567'
        billing_address:
          country: COL
          state: Cundinamarca
          city: Bogotá
          zip: '54321'
          line1: 'Carrera 7 # 123'
          line2: Apto 456
        shipping_address:
          country: COL
          state: Antioquia
          city: Medellín
          zip: '12345'
          line1: 'Calle 45 # 789'
          line2: Unit 789
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          colombia_cc: '42141221'
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductGcash:
      value:
        payment_method: gcash
        order_id: order_prod_20251103_PHP_001
        product_id: g4h5i6j7-k8l9-01m2-n345-op678qr901st
        currency: PHP
        order_description: Platinum plan
        order_date: '2025-11-03 15:51:00'
        customer_account_id: user_id_67890
        customer_email: example.user@example.com
        customer_first_name: Maria
        customer_last_name: Santos
        customer_phone: '+639171234567'
        item_category: digital_goods
        billing_address:
          country: PHL
          city: Manila
          zip: '1000'
          line1: 123 Rizal Avenue
          line2: Unit 5B
        ip_address: 8.8.8.8
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example
    ExampleApmRequestOneTimeProductIdeal:
      value:
        payment_method: ideal
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: EUR
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: '10005'
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductMbway:
      value:
        payment_method: mbway
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: EUR
        future_usage:
          payment_type: one-time
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: PRT
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          partner_id: '123989'
    ExampleApmRequestOneTimeProductMercadopago:
      value:
        payment_method: mercadopago
        order_id: u4v5w6x7-8y9z-01a2-b3c4-567de890fg12
        product_id: v5w6x7y8-z901-a2b3-c456-de789fg012hi
        currency: BRL
        order_description: Premium Gold membership
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1989-09-21'
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: 10005
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: 91191
          line1: 777 Main St.
          line2: Apt. 321
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          argentina_dni: 42243309
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductMultibanco:
      value:
        payment_method: multibanco
        order_id: order_product_abc123
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: EUR
        order_description: 'Order #abc123'
        order_date: '2026-04-23 10:31:44'
        customer_account_id: user_id_abc123
        customer_email: buyer@example.pt
        customer_first_name: João
        customer_last_name: Silva
        customer_phone: '+351912345678'
        item_category: digital_goods
        billing_address:
          country: PRT
          city: Lisboa
          zip: 1250-096
          line1: Avenida da Liberdade 100
          line2: 3º Esq.
        language: en
        ip_address: 178.12.34.56
        platform: WEB
        user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
        order_metadata:
          coupon_code: PT2026
          partner_id: '123989'
    ExampleApmRequestOneTimeProductOxxo:
      value:
        payment_method: oxxo
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: MXN
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: d4e5f6g7-h8i9-j0k1-234lmn567op8
        customer_email: example@example.com
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: '10005'
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          mexico_curp: ZAZD801124MBSYQN13
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductOpenbanking:
      value:
        payment_method: openbanking
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: EUR
        order_description: Premium package
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: test@merchant.example
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: DEU
          state: BE
          city: Berlin
          zip: '10115'
          line1: Alexanderplatz 1
          line2: Apartment 123
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductPixQr:
      summary: Product-based payment Pix QR
      value:
        payment_method: pix-qr
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: '12345'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: BRA
          state: SP
          city: São Paulo
          zip: '04530'
          line1: Avenida 1234
          line2: Apart 56
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          brazil_cpf: '23100299900'
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductPixAutomatico:
      summary: Product-based payment Pix Automático
      value:
        payment_method: pix-automatico
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: BRL
        future_usage:
          max_amount: 15000
        order_description: Premium package
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        ip_address: 203.0.113.0
        platform: WEB
        billing_address:
          country: BRA
          state: SP
          city: São Paulo
        payment_type_data:
          brazil_cpf: '23100299900'
    ExampleApmRequestOneTimeProductPrzelewy24:
      value:
        payment_method: przelewy24
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: PLN
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: '10005'
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: '91191'
          line1: 777 Main St.
          line2: Apt. 321
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductPse:
      value:
        payment_method: pse
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: COP
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: '12345'
        customer_email: example@example.com
        customer_first_name: Alejandro
        customer_last_name: Gomez
        customer_date_of_birth: '2000-11-21'
        customer_phone: '+15551234567'
        billing_address:
          country: COL
          state: Cundinamarca
          city: Bogotá
          zip: '54321'
          line1: 'Carrera 7 # 123'
          line2: Apto 456
        shipping_address:
          country: COL
          state: Antioquia
          city: Medellín
          zip: '12345'
          line1: 'Calle 45 # 789'
          line2: Unit 789
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          colombia_cc: '42141221'
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductSencillito:
      value:
        payment_method: sencillito
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: CLP
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: '12345'
        customer_email: example@example.com
        customer_first_name: Isabella
        customer_last_name: Martinez
        customer_date_of_birth: '2000-11-21'
        customer_phone: '+15551234567'
        billing_address:
          country: CHL
          state: Region Metropolitana
          city: Santiago
          zip: '123456'
          line1: 123 Main Street
          line2: Apartment 456
        shipping_address:
          country: CHL
          state: Region Metropolitana
          city: Santiago
          zip: '654321'
          line1: 789 Elm Street
          line2: Unit 789
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          chile_ci: 5633554V
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductServipag:
      value:
        payment_method: servipag
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: CLP
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: '12345'
        customer_email: example@example.com
        customer_first_name: Isabella
        customer_last_name: Martinez
        customer_date_of_birth: '2000-11-21'
        customer_phone: '+15551234567'
        billing_address:
          country: CHL
          state: Region Metropolitana
          city: Santiago
          zip: '123456'
          line1: 123 Main Street
          line2: Apartment 456
        shipping_address:
          country: CHL
          state: Region Metropolitana
          city: Santiago
          zip: '654321'
          line1: 789 Elm Street
          line2: Unit 789
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          chile_ci: 5633554V
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductPix:
      value:
        payment_method: pix
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: '12345'
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: BRA
          state: SP
          city: São Paulo
          zip: '04530'
          line1: Avenida 1234
          line2: Apart 56
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          brazil_cpf: '23100299900'
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductUpi:
      value:
        payment_method: upi
        order_id: u4v5w6x7-8y9z-01a2-b3c4-567de890fg12
        product_id: v5w6x7y8-z901-a2b3-c456-de789fg012hi
        currency: INR
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1989-09-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: IND
          state: Maharashtra
          city: Mumbai
          zip: '400001'
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: IND
          state: Karnataka
          city: Bengaluru
          zip: '560001'
          line1: No. 1, MG Road
          line2: Near Brigade Road Junction
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          india_vpa: 1234567890@abc
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductWebpay:
      value:
        payment_method: webpay
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: CLP
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: '12345'
        customer_email: example@example.com
        customer_first_name: Isabella
        customer_last_name: Martinez
        customer_date_of_birth: '2000-11-21'
        customer_phone: '+15551234567'
        billing_address:
          country: CHL
          state: Region Metropolitana
          city: Santiago
          zip: '123456'
          line1: 123 Main Street
          line2: Apartment 456
        shipping_address:
          country: CHL
          state: Region Metropolitana
          city: Santiago
          zip: '654321'
          line1: 789 Elm Street
          line2: Unit 789
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          chile_ci: 5633554V
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestOneTimeProductWechatpay:
      value:
        payment_method: wechatpay
        order_id: order_prod_20251221_CNY_002
        product_id: g4h5i6j7-k8l9-01m2-n345-op678qr901st
        currency: CNY
        future_usage:
          payment_type: one-time
        order_description: Platinum plan
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: test@merchant.example
        customer_first_name: Li
        customer_last_name: Wang
        customer_phone: '+8613812345678'
        item_category: digital_goods
        billing_address:
          country: CHN
          city: Beijing
          zip: '100000'
          line1: 456 Chang'an Avenue
          line2: Building 3
        ip_address: 8.8.8.8
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
    ExampleApmRequestSubscriptionPaymentPaypal:
      value:
        payment_method: paypal-vault
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: USD
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: 10005
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: 91191
          line1: 777 Main St.
          line2: Apt. 321
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestSubscriptionPaymentAlipay:
      value:
        payment_method: alipay
        order_id: order_sub_init_20251221_CNY_001
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: CNY
        future_usage:
          payment_type: unscheduled
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_email: test@merchant.example
        customer_first_name: Wei
        customer_last_name: Zhang
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+8613800138000'
        item_category: digital_goods
        billing_address:
          country: CHN
          state: '11'
          city: Beijing
          zip: '100000'
          line1: 123 Wangfujing Street
          line2: Building A
        shipping_address:
          country: CHN
          state: '31'
          city: Shanghai
          zip: '200000'
          line1: 777 Nanjing Road
          line2: Floor 5
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36
        order_metadata:
          coupon_code: CNY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestSubscriptionPaymentBlik:
      value:
        payment_method: blik
        order_id: order_sub_init_20240501
        product_id: b2c3d4e5-f6a7-4890-b123-456789abcdef
        currency: PLN
        payment_method_flow: direct
        future_usage:
          payment_type: unscheduled
        payment_type_data:
          blik_code: '123456'
        order_description: Monthly Premium Plan
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: customer@example.pl
        billing_address:
          country: POL
        ip_address: 178.12.34.56
        platform: WEB
        user_agent: Mozilla/5.0
    ExampleApmRequestSubscriptionPaymentGcash:
      value:
        payment_method: gcash
        order_id: order_sub_init_20251103_PHP_001
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: PHP
        order_description: Premium package
        order_date: '2025-11-03 15:51:00'
        customer_email: example.user@example.com
        customer_first_name: Maria
        customer_last_name: Santos
        customer_date_of_birth: '1990-05-15'
        customer_phone: '+639171234567'
        item_category: digital_goods
        billing_address:
          country: PHL
          state: NCR
          city: Manila
          zip: '1000'
          line1: 123 Rizal Avenue
          line2: Unit 5B
        shipping_address:
          country: PHL
          state: '00'
          city: Quezon City
          zip: '1100'
          line1: 456 Commonwealth Avenue
          line2: Floor 10
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36
        order_metadata:
          coupon_code: PH2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example
    ExampleApmRequestSubscriptionPaymentMbway:
      value:
        payment_method: mbway
        order_id: order_sub_init_20251221_EUR_001
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: EUR
        future_usage:
          payment_type: recurring
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: João
        customer_last_name: Silva
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+351912345678'
        item_category: digital_goods
        billing_address:
          country: PRT
          state: '11'
          city: Lisbon
          zip: 1000-001
          line1: 123 Rua Augusta
          line2: Floor 2
        shipping_address:
          country: PRT
          state: '11'
          city: Porto
          zip: 4000-001
          line1: 777 Avenida da Boavista
          line2: Apt. 5B
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36
        order_metadata:
          coupon_code: EUR2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestSubscriptionPaymentMercadopago:
      value:
        payment_method: mercadopago
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1989-09-21'
        item_category: digital_goods
        billing_address:
          country: USA
          state: WA
          city: New York
          zip: 10005
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: USA
          state: NY
          city: Boston
          zip: 91191
          line1: 777 Main St.
          line2: Apt. 321
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          argentina_dni: 42243309
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestSubscriptionPaymentMultibanco:
      value:
        payment_method: multibanco
        order_id: order_sub_init_20260423_EUR_001
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: EUR
        future_usage:
          payment_type: recurring
        order_description: Premium subscription
        order_date: '2026-04-23 10:31:44'
        customer_account_id: user_id_abc123
        customer_email: buyer@example.pt
        customer_first_name: João
        customer_last_name: Silva
        customer_phone: '+351912345678'
        item_category: digital_goods
        billing_address:
          country: PRT
          city: Lisboa
          zip: 1250-096
          line1: Avenida da Liberdade 100
          line2: 3º Esq.
        language: en
        ip_address: 178.12.34.56
        platform: WEB
        user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
        order_metadata:
          coupon_code: PT2026
          partner_id: '123989'
    ExampleApmRequestSubscriptionPaymentPixQr:
      summary: Subscription payment Pix QR
      value:
        payment_method: pix-qr
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: BRL
        order_description: Premium package
        order_date: '2026-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: BRA
          state: SP
          city: São Paulo
          zip: '04530'
          line1: Avenida 1234
          line2: Apart 56
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          brazil_cpf: '23100299900'
        order_metadata:
          coupon_code: NY2026
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestSubscriptionPaymentPixAutomatico:
      summary: Subscription payment Pix Automático
      value:
        payment_method: pix-automatico
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: BRL
        future_usage:
          max_amount: 12000
        order_description: Premium package
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        ip_address: 203.0.113.0
        platform: WEB
        billing_address:
          country: BRA
        payment_type_data:
          brazil_cpf: '23100299900'
    ExampleApmRequestSubscriptionPaymentPix:
      value:
        payment_method: pix
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: BRA
          state: SP
          city: São Paulo
          zip: '04530'
          line1: Avenida 1234
          line2: Apart 56
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          brazil_cpf: '23100299900'
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestSubscriptionPaymentUpi:
      value:
        payment_method: upi
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: INR
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1989-09-21'
        customer_phone: '+15551234567'
        item_category: digital_goods
        billing_address:
          country: IND
          state: Maharashtra
          city: Mumbai
          zip: '400001'
          line1: 123 Main St.
          line2: Apt. 123
        shipping_address:
          country: IND
          state: Karnataka
          city: Bengaluru
          zip: '560001'
          line1: No. 1, MG Road
          line2: Near Brigade Road Junction
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0
        payment_type_data:
          india_vpa: 1234567890@abc
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmRequestSubscriptionPaymentWechatpay:
      value:
        payment_method: wechatpay
        order_id: order_sub_init_20251221_CNY_002
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: CNY
        future_usage:
          payment_type: unscheduled
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_email: test@merchant.example
        customer_first_name: Li
        customer_last_name: Wang
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+8613900139000'
        item_category: digital_goods
        billing_address:
          country: CHN
          state: '44'
          city: Guangzhou
          zip: '510000'
          line1: 456 Tianhe Road
          line2: Tower B
        shipping_address:
          country: CHN
          state: '44'
          city: Shenzhen
          zip: '518000'
          line1: 888 Shennan Avenue
          line2: Unit 1001
        ip_address: 203.0.113.0
        platform: WEB
        user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36
        order_metadata:
          coupon_code: CNY2025
          partner_id: '123989'
        success_url: https://merchant.example/success
        fail_url: https://merchant.example/fail
        return_url: https://merchant.example/success
    ExampleApmResponsePaypal:
      value:
        order:
          method: paypal-vault
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: USD
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: paypal-vault
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: USD
            status: processing
            type: pay
          - method: paypal-vault
            id: another_unique_id
            created_at: '2025-12-28 12:00:00'
            amount: 50
            currency: USD
            status: success
            type: refund
        pay_form:
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseAlipay:
      value:
        order:
          method: alipay
          order_id: order_20251221_CNY_8900
          created_at: '2025-10-20 16:28:25'
          updated_at: '2025-10-20 16:28:26'
          amount: 8900
          currency: CNY
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: test@merchant.example
          ip_address: 8.8.8.8
        transactions:
          - method: alipay
            id: 175f83e6-665d-49f2-b6f0-836690ea7e1e
            created_at: '2025-10-20 16:28:25'
            amount: 8900
            currency: CNY
            status: processing
            type: pay
          - method: alipay
            id: a641818f-71a7-4bca-9402-3e9b7d4f0123
            created_at: '2025-10-20 17:00:00'
            amount: 500
            currency: CNY
            status: success
            type: refund
        pay_form:
          return_url: https://simulator-ui-stage.boku.com/redirect/cb17a7e6-6c4e-40a9-b3e9-f50e9d7d9d04
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: CNY2025
          partner_id: '123989'
    ExampleApmResponseBlik:
      value:
        order:
          method: blik
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: PLN
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: blik
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: PLN
            status: processing
            type: pay
          - method: blik
            id: another_unique_id
            created_at: '2025-12-28 12:00:00'
            amount: 50
            currency: PLN
            status: success
            type: refund
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseBizum:
      value:
        order:
          method: bizum
          order_id: order_20251021_EUR_400
          created_at: '2025-10-21 13:49:05'
          updated_at: '2025-10-21 13:49:19'
          amount: 400
          currency: EUR
          order_description: Premium package
          status: processing
          customer_account_id: user_id_12345
          customer_email: test@merchant.example
          ip_address: 8.8.8.8
        transactions:
          - method: bizum
            id: 06ce84ca-cd5d-42a5-adc9-19dba107036f
            created_at: '2025-10-21 13:49:05'
            amount: 400
            currency: EUR
            status: processing
            type: pay
          - method: bizum
            id: c863151b-9d3e-7ade-b624-5g9f9f6h2345
            created_at: '2025-10-21 14:20:00'
            amount: 50
            currency: EUR
            status: success
            type: refund
        pay_form:
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: ES2025
          partner_id: '123989'
    ExampleApmResponseBoleto:
      value:
        order:
          method: boleto
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: BRL
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: boleto
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: BRL
            status: processing
            type: pay
          - method: boleto
            id: another_unique_id
            created_at: '2025-12-28 12:00:00'
            amount: 50
            currency: BRL
            status: success
            type: refund
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        payment_type_data:
          amount: 107.51
          currency: BRL
          expiration_date: '2025-06-04'
          image_url: https://payment-provider.example/transaction/abc123
          number: '3419109107005633044159101318002'
          type: CUSTOM
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseEfecty:
      value:
        order:
          method: efecty
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-21 11:21:30'
          updated_at: '2025-12-21 12:00:00'
          amount: 10000
          currency: COP
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: efecty
            id: unique_transaction_id_1
            created_at: '2025-12-21 11:21:30'
            amount: 5000
            currency: COP
            status: processing
            type: pay
          - method: efecty
            id: unique_transaction_id_2
            created_at: '2025-12-21 11:30:00'
            amount: 5000
            currency: COP
            status: success
            type: refund
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseGcash:
      value:
        order:
          method: gcash
          order_id: order_20251103_PHP_2575
          created_at: '2025-11-03 15:51:59'
          updated_at: '2025-11-03 15:52:10'
          amount: 2575
          currency: PHP
          order_description: Premium package
          status: processing
          customer_account_id: user_id_67890
          customer_email: example.user@example.com
          ip_address: 8.8.8.8
        transactions:
          - method: gcash
            id: 079c8d60-b9eb-4976-be49-e92c8e19a05d
            created_at: '2025-11-03 15:51:59'
            amount: 2575
            currency: PHP
            status: processing
            type: pay
          - method: gcash
            id: d974262c-ae4f-8bef-c735-6h0g0g7i3456
            created_at: '2025-11-03 16:45:00'
            amount: 100
            currency: PHP
            status: success
            type: refund
        pay_form:
          return_url: https://g.alipayplus.com/link/redirect/auto/gotourl?url=https%3A%2F%2Fm.gcash.com%2F
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: PH2025
          partner_id: '123989'
    ExampleApmResponseIdeal:
      value:
        order:
          method: ideal
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: EUR
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: ideal
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: EUR
            status: processing
            type: pay
          - method: ideal
            id: another_id_here
            created_at: '2025-12-28 12:00:00'
            amount: 50
            currency: EUR
            status: success
            type: refund
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseMbway:
      value:
        order:
          method: mbway
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: EUR
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: mbway
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: EUR
            status: processing
            type: pay
        pay_form:
          return_url: https://example.com/?return
    ExampleApmResponseMercadopago:
      value:
        order:
          method: mercadopago
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: BRL
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: mercadopago
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: BRL
            status: processing
            type: pay
          - method: mercadopago
            id: another_unique_id
            created_at: '2025-12-28 12:00:00'
            amount: 50
            currency: BRL
            status: success
            type: refund
        pay_form:
          return_url: https://example.com/?return
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseMultibanco:
      value:
        order:
          method: multibanco
          order_id: order_abc123
          created_at: '2026-04-23 10:31:44'
          updated_at: '2026-04-23 10:31:44'
          amount: 2490
          currency: EUR
          order_description: 'Order #abc123'
          status: processing
          customer_email: buyer@example.pt
          ip_address: 178.12.34.56
        transactions:
          - method: multibanco
            id: 4a8d40dc-6935-4cd2-bcde-02beab46f46c
            created_at: '2026-04-23 10:31:44'
            amount: 2490
            currency: EUR
            status: processing
            type: pay
          - method: multibanco
            id: b7e2c91a-4f63-48d1-a902-1c8d5e6f7a20
            created_at: '2026-04-24 09:15:00'
            amount: 500
            currency: EUR
            status: success
            type: refund
        payment_type_data:
          type: multibanco
          entity: '24000'
          reference: '256309828'
          reference_expiration: '2026-04-24T10:31:44Z'
        order_metadata:
          coupon_code: PT2026
          partner_id: '123989'
    ExampleApmResponseOxxo:
      value:
        order:
          method: oxxo
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: MXN
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: oxxo
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: MXN
            status: processing
            type: pay
          - method: oxxo
            id: another_transaction_id
            created_at: '2025-12-28 12:00:00'
            amount: 50
            currency: MXN
            status: success
            type: refund
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseOpenbanking:
      value:
        order:
          method: openbanking
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: EUR
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: test@merchant.example
          ip_address: 203.0.113.0
        transactions:
          - method: openbanking
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: EUR
            status: processing
            type: pay
          - method: openbanking
            id: another_transaction_id
            created_at: '2025-12-28 12:00:00'
            amount: 50
            currency: EUR
            status: success
            type: refund
        pay_form:
          return_url: https://payment-provider.example/transaction/abc123
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponsePixQr:
      summary: Pix QR
      value:
        order:
          method: pix-qr
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: BRL
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: pix-qr
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: BRL
            status: processing
            type: pay
          - method: pix-qr
            id: another_unique_id
            created_at: '2025-12-28 12:00:00'
            amount: 50
            currency: BRL
            status: success
            type: refund
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        payment_type_data:
          qr_code_value: 00020101021226890014br.gov.bcb.pix2563pix.example.com/qr/v2/....
          qr_code_expiration_date: '2025-12-28 13:00:00'
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponsePixAutomatico:
      summary: Pix Automático
      value:
        order:
          method: pix-automatico
          order_id: order_1234567890
          created_at: '2026-04-10 11:36:45'
          updated_at: '2026-04-10 11:36:46'
          amount: 1000
          currency: BRL
          order_description: Premium package
          status: processing
          customer_account_id: customer_account_id
          customer_email: example@example.com
          customer_first_name: John
          customer_last_name: Doe
          ip_address: 203.0.113.0
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: ''
        transactions:
          - method: pix-automatico
            id: 175f83e6-665d-49f2-b6f0-836690ea7a1b
            created_at: '2026-04-10 11:36:45'
            amount: 1000
            currency: BRL
            status: processing
            type: pay
        payment_type_data:
          qr_code_value: 00020101021226780014br.gov.bcb.pix2563pix.example.com/qr/v2/cobv/...
          qr_code_expiration_date: '2026-04-10 12:36:45'
    ExampleApmResponsePrzelewy24:
      value:
        order:
          method: przelewy24
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: PLN
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: przelewy24
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: PLN
            status: processing
            type: pay
          - method: przelewy24
            id: another_transaction_id
            created_at: '2025-12-28 12:00:00'
            amount: 50
            currency: PLN
            status: success
            type: refund
        pay_form:
          return_url: https://sandbox.przelewy24.pl/trnRequest/example
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponsePse:
      value:
        order:
          method: pse
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-21 11:21:30'
          updated_at: '2025-12-21 12:00:00'
          amount: 10000
          currency: COP
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: pse
            id: unique_transaction_id_1
            created_at: '2025-12-21 11:21:30'
            amount: 5000
            currency: COP
            status: processing
            type: pay
          - method: pse
            id: unique_transaction_id_2
            created_at: '2025-12-21 11:30:00'
            amount: 5000
            currency: COP
            status: success
            type: refund
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseSencillito:
      value:
        order:
          method: sencillito
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-21 11:21:30'
          updated_at: '2025-12-21 12:00:00'
          amount: 1000
          currency: CLP
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: sencillito
            id: unique_transaction_id_1
            created_at: '2025-12-21 11:21:30'
            amount: 500
            currency: CLP
            status: processing
            type: pay
          - method: sencillito
            id: unique_transaction_id_2
            created_at: '2025-12-21 11:30:00'
            amount: 500
            currency: CLP
            status: success
            type: refund
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseServipag:
      value:
        order:
          method: servipag
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-21 11:21:30'
          updated_at: '2025-12-21 12:00:00'
          amount: 1000
          currency: CLP
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: servipag
            id: unique_transaction_id_1
            created_at: '2025-12-21 11:21:30'
            amount: 500
            currency: CLP
            status: processing
            type: pay
          - method: servipag
            id: unique_transaction_id_2
            created_at: '2025-12-21 11:30:00'
            amount: 500
            currency: CLP
            status: success
            type: refund
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponsePix:
      value:
        order:
          method: pix
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: BRL
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: pix
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: BRL
            status: processing
            type: pay
          - method: pix
            id: another_unique_id
            created_at: '2025-12-28 12:00:00'
            amount: 50
            currency: BRL
            status: success
            type: refund
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseUpi:
      value:
        order:
          method: upi
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: INR
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: upi
            id: 12408499-3c61-402b-9292-fc4d349c86d5
            created_at: '2025-01-23 13:04:13'
            amount: 1020
            currency: INR
            status: processing
            type: pay
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseWebpay:
      value:
        order:
          method: webpay
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-21 11:21:30'
          updated_at: '2025-12-21 12:00:00'
          amount: 1000
          currency: CLP
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
        transactions:
          - method: webpay
            id: unique_transaction_id_1
            created_at: '2025-12-21 11:21:30'
            amount: 500
            currency: CLP
            status: processing
            type: pay
          - method: webpay
            id: unique_transaction_id_2
            created_at: '2025-12-21 11:30:00'
            amount: 500
            currency: CLP
            status: success
            type: refund
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseWechatpay:
      value:
        order:
          method: wechatpay
          order_id: order_20251221_CNY_8901
          created_at: '2025-10-20 16:17:41'
          updated_at: '2025-10-20 16:17:42'
          amount: 8900
          currency: CNY
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: test@merchant.example
          ip_address: 8.8.8.8
        transactions:
          - method: wechatpay
            id: 4a8d40dc-6935-4cd2-b6f0-836690ea7e1e
            created_at: '2025-10-20 16:17:41'
            amount: 8900
            currency: CNY
            status: processing
            type: pay
          - method: wechatpay
            id: b752929e-82b8-5cda-a513-4f8e8e5g1234
            created_at: '2025-10-20 17:30:00'
            amount: 600
            currency: CNY
            status: success
            type: refund
        pay_form:
          return_url: https://simulator-ui-stage.boku.com/redirect/6c1bd3c5-eb17-4c27-be88-b7d0fd849a45
          script_url: https://payment-provider.example/widget/example.js
        order_metadata:
          coupon_code: WX2025
          partner_id: '123989'
    ExampleApmRequestRecurringPaypal:
      value:
        payment_method: paypal-vault
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: EUR
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestRecurringAlipay:
      value:
        payment_method: alipay
        token: ffb850ff6d134cab887fb1da5550cd758f66
        order_id: order_recur_20251221_CNY_001
        amount: 8900
        currency: CNY
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: test@merchant.example
        customer_phone: '+8613812345678'
        language: en
        ip_address: 8.8.8.8
        platform: WEB
        order_metadata:
          coupon_code: CNY2025
          partner_id: '123989'
    ExampleApmRequestRecurringBlik:
      value:
        payment_method: blik
        token: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        order_id: charge_sub_20240501
        amount: 2999
        currency: PLN
        order_description: Monthly Premium Plan - May
        customer_email: customer@example.pl
        ip_address: 178.12.34.56
        platform: WEB
    ExampleApmRequestRecurringGcash:
      value:
        payment_method: gcash
        token: 5hc1041dh9458dhdeee7e13g0e216i22i6dei8gee1g262gi71e73088907hggffhh01317hde8id2f48d662f27i4dg5e63fi522
        order_id: order_recur_20251103_PHP_001
        amount: 2575
        currency: PHP
        order_description: Premium package
        order_date: '2025-11-03 16:10:00'
        customer_account_id: user_id_67890
        customer_email: example.user@example.com
        customer_date_of_birth: '1990-05-15'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          subscription_id: sub_12345
          partner_id: '123989'
    ExampleApmRequestRecurringMbway:
      value:
        payment_method: mbway
        token: ffb850ff6d134cab887fb1da5550cd758f66
        order_id: order_recur_20251221_EUR_001
        amount: 1020
        currency: EUR
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_phone: '+351912345678'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: EUR2025
          partner_id: '123989'
    ExampleApmRequestRecurringMercadopago:
      value:
        payment_method: mercadopagp
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestRecurringPixAutomatico:
      summary: Pix Automático
      value:
        payment_method: pix-automatico
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: BRL
        order_description: Premium package
        order_date: '2026-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: NY2026
          partner_id: '123989'
    ExampleApmRequestRecurringPix:
      summary: SmartPix
      value:
        payment_method: pix
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestRecurringUpi:
      value:
        payment_method: upi
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        currency: INR
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Alejandro
        customer_last_name: Gomez
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestRecurringWechatpay:
      value:
        payment_method: wechatpay
        token: 12e07128df5f4f5faaddaacc89765432
        order_id: order_recur_20251221_CNY_002
        amount: 8900
        currency: CNY
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: test@merchant.example
        customer_phone: '+8613812345678'
        language: en
        ip_address: 8.8.8.8
        order_metadata:
          coupon_code: WX2025
          partner_id: '123989'
    ExampleApmRequestOneTimeProductRecurringPaypal:
      value:
        payment_method: paypal-vault
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: u4v5w6x7-8y9z-01a2-b3c4-567de890fg12
        product_id: v5w6x7y8-z901-a2b3-c456-de789fg012hi
        currency: EUR
        order_description: Exclusive package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          partner_id: '123989'
    ExampleApmRequestOneTimeProductRecurringAlipay:
      value:
        payment_method: alipay
        token: 2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: order_prod_recur_20251221_CNY_001
        product_id: v5w6x7y8-z901-a2b3-c456-de789fg012hi
        currency: CNY
        order_description: Exclusive package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: test@merchant.example
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+8613812345678'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          partner_id: '123989'
    ExampleApmRequestOneTimeProductRecurringBlik:
      value:
        payment_method: blik
        token: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        order_id: charge_sub_product_20240501
        product_id: b2c3d4e5-f6a7-4890-b123-456789abcdef
        currency: PLN
        order_description: Monthly Premium Plan - May
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: customer@example.pl
        ip_address: 178.12.34.56
        platform: WEB
    ExampleApmRequestOneTimeProductRecurringGcash:
      value:
        payment_method: gcash
        token: 2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: order_prod_recur_20251103_PHP_001
        product_id: v5w6x7y8-z901-a2b3-c456-de789fg012hi
        currency: PHP
        order_description: Exclusive package
        order_date: '2025-11-03 15:51:00'
        customer_account_id: user_id_67890
        customer_email: example.user@example.com
        customer_date_of_birth: '1990-05-15'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          partner_id: '123989'
    ExampleApmRequestRecurringOneTimeProductMbway:
      value:
        payment_method: mbway
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: order_recur_otp_20251221_EUR_001
        product_id: b2c3d4e5-f6g7-h8i9-j0k1-234lmn567op8
        currency: EUR
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: example@example.com
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+351912345678'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: EUR2025
          partner_id: '123989'
    ExampleApmRequestOneTimeProductRecurringMercadopago:
      value:
        payment_method: mercadopago
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: u4v5w6x7-8y9z-01a2-b3c4-567de890fg12
        product_id: v5w6x7y8-z901-a2b3-c456-de789fg012hi
        currency: BRL
        order_description: Exclusive package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          partner_id: '123989'
    ExampleApmRequestOneTimeProductRecurringUpi:
      value:
        payment_method: upi
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: u4v5w6x7-8y9z-01a2-b3c4-567de890fg12
        product_id: v5w6x7y8-z901-a2b3-c456-de789fg012hi
        currency: INR
        order_description: Exclusive package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Alejandro
        customer_last_name: Gomez
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          partner_id: '123989'
    ExampleApmRequestOneTimeProductRecurringPixAutomatico:
      summary: Product-based recurring Pix Automático
      value:
        payment_method: pix-automatico
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: BRL
        order_description: Premium package
        order_date: '2026-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          partner_id: '123989'
    ExampleApmRequestOneTimeProductRecurringPix:
      summary: Product-based recurring SmartPix
      value:
        payment_method: pix
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          partner_id: '123989'
    ExampleApmRequestOneTimeProductRecurringWechatpay:
      value:
        payment_method: wechatpay
        token: 3fa0829bf7236bfbcc5c91e8c094g00g4bcg6ecc9e040eg59c51866785feeddff89195fbc6gb0d26b440d05g2be3c41dg300
        order_id: order_prod_recur_20251221_CNY_002
        product_id: v5w6x7y8-z901-a2b3-c456-de789fg012hi
        currency: CNY
        order_description: Exclusive package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: test@merchant.example
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+8613812345678'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          partner_id: '123989'
    ExampleApmRequestSubscriptionPaymentRecurringPaypal:
      value:
        payment_method: paypal-vault
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: EUR
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestSubscriptionPaymentRecurringAlipay:
      value:
        payment_method: alipay
        token: 2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: order_sub_20251221_CNY_001
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: CNY
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: test@merchant.example
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+8613812345678'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestSubscriptionPaymentRecurringBlik:
      value:
        payment_method: blik
        token: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        order_id: charge_sub_product_20240501
        product_id: b2c3d4e5-f6a7-4890-b123-456789abcdef
        currency: PLN
        order_description: Monthly Premium Plan - May
        customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
        customer_email: customer@example.pl
        ip_address: 178.12.34.56
        platform: WEB
    ExampleApmRequestSubscriptionPaymentRecurringGcash:
      value:
        payment_method: gcash
        token: 2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: order_sub_20251103_PHP_001
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: PHP
        order_description: Premium package
        order_date: '2025-11-03 15:51:00'
        customer_account_id: user_id_67890
        customer_email: example.user@example.com
        customer_date_of_birth: '1990-05-15'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: PH2025
          partner_id: '123989'
    ExampleApmRequestRecurringSubscriptionPaymentMbway:
      value:
        payment_method: mbway
        token: 2ea0728af6125aeabb4b80d7b983f99f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: order_sub_recur_20251221_EUR_001
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: EUR
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+351912345678'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: EUR2025
          partner_id: '123989'
    ExampleApmRequestSubscriptionPaymentRecurringMercadopago:
      value:
        payment_method: mercadopago
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestSubscriptionPaymentRecurringPixAutomatico:
      summary: Subscription Pix Automático
      value:
        payment_method: pix-automatico
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: BRL
        order_description: Premium package
        order_date: '2026-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: NY2026
          partner_id: '123989'
    ExampleApmRequestSubscriptionPaymentRecurringPix:
      summary: Subscription SmartPix
      value:
        payment_method: pix
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: BRL
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Nikola
        customer_last_name: Tesla
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestSubscriptionPaymentRecurringUpi:
      value:
        payment_method: upi
        token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: INR
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        customer_first_name: Alejandro
        customer_last_name: Gomez
        customer_date_of_birth: '1988-11-21'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestSubscriptionPaymentRecurringWechatpay:
      value:
        payment_method: wechatpay
        token: 3fa0829bf7236bfbcc5c91e8c094g00g4bcg6ecc9e040eg59c51866785feeddff89195fbc6gb0d26b440d05g2be3c41dg300
        order_id: order_sub_20251221_CNY_002
        product_id: ac43b415-5522-4373-b026-a365462f9657
        currency: CNY
        order_description: Premium package
        order_date: '2025-12-21 11:21:30'
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: test@merchant.example
        customer_date_of_birth: '1988-11-21'
        customer_phone: '+8613812345678'
        language: en
        ip_address: 203.0.113.0
        platform: WEB
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmResponseRecurring:
      value:
        order:
          method: paypal-vault
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: USD
          order_description: Premium package
          status: processing
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        ip_address: 203.0.113.0
        provider_data:
          billing_address:
            country: USA
            state: WA
            city: New York
            zip: '10005'
            line1: 123 Main St.
            line2: Apt. 123
          shipping_address:
            country: USA
            state: NY
            city: Boston
            zip: '91191'
            line1: 777 Main St.
            line2: Apt. 321
          payer:
            first_name: John
            last_name: Doe
            email: example@example.com
          merchant:
            account_id: 78UQ777KUJAQN
        transactions:
          - method: paypal-vault
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: USD
            status: processing
            type: pay
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        payment_type_data:
          amount: 107.51
          currency: BRL
          expiration_date: '2025-06-04'
          image_url: https://payment-provider.example/transaction/abc123
          number: '3419109107005633044159101318002'
          type: CUSTOM
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestRecurringTokenCancellation:
      value:
        token: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
    ExampleApmResponseRecurringTokenCancellationSuccess:
      value:
        status: processing
    ExampleApmResponseRecurringTokenCancellationErrorAuthFailed:
      value:
        error:
          code: '1.01'
          messages:
            - Authentication failed
    ExampleApmResponseRecurringTokenCancellationErrorTokenNotFound:
      value:
        error:
          code: '2.01'
          messages:
            general:
              - recurring token was not found
    ExampleApmResponseRecurringTokenCancellationErrorUnsupportedMethod:
      value:
        error:
          code: '2.01'
          messages:
            general:
              - 'recurring token payment method is mbway, but should be one of the following: alipay, wechatpay'
    ExampleApmResponseRecurringTokenCancellationErrorAlreadyCancelled:
      value:
        error:
          code: '2.01'
          messages:
            general:
              - recurring token is already cancelled
    ExampleApmResponseRecurringTokenCancellationErrorAlreadyProcessing:
      value:
        error:
          code: '2.01'
          messages:
            general:
              - recurring token cancellation is already processing
    ExampleApmResponseRecurringTokenCancellationErrorAlreadyConcurrentlyProcessing:
      value:
        error:
          code: '2.01'
          messages:
            general:
              - recurring token cancellation is already concurrently processing
    ExampleApmResponseRecurringTokenCancellationErrorFailed:
      value:
        error:
          code: '2.01'
          messages:
            general:
              - recurring token cancellation has failed
    ExampleApmRequestRefund:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        amount: 1020
        refund_reason_code: '0022'
    ExampleApmResponseCheckOrderStatus:
      value:
        order:
          method: paypal-vault
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 1020
          currency: USD
          status: processing
          order_description: Premium package
          descriptor: PAYPAL *MERCH TOPSELL
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          ip_address: 203.0.113.0
          provider_data:
            billing_address:
              country: USA
              state: WA
              city: New York
              zip: '10005'
              line1: 123 Main St.
              line2: Apt. 123
            shipping_address:
              country: USA
              state: NY
              city: Boston
              zip: '91191'
              line1: 777 Main St.
              line2: Apt. 321
            payer:
              account_id: Z5WEEM3YYCXBB
              first_name: John
              last_name: Doe
              email: example@example.com
              phone: '+352111222333'
            merchant:
              account_id: 78UQ777KUJAQN
        error:
          code: '5.02'
          messages:
            - Invalid Card Token
          recommended_message_for_user: Invalid Card Token
        transactions:
          - method: paypal-vault
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: USD
            status: processing
            type: pay
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
        pay_form:
          return_url: https://payment-provider.example/return
          script_url: https://payment-provider.example/widget/example.js
        payment_type_data:
          amount: 107.51
          currency: BRL
          expiration_date: '2025-06-04'
          image_url: https://payment-provider.example/transaction/abc123
          number: '3419109107005633044159101318002'
          type: CUSTOM
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleBillingResponseProductListOneTime:
      value:
        data:
          - id: cb43b415-5522-4373-b026-a365462f9114
            name: Luxury product
            type: one-time
            description: This product is the best product all over the world
            public_description: That cool product that you have bought
            status: active
            created_at: '2025-05-31 12:53:12'
            updated_at: '2025-05-31 12:53:13'
            payment_action: auth_settle
            settle_interval: 48
            tax:
              category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
              behavior: included
            metadata:
              access_duration: 30d
              plan_tier: premium
        pagination:
          offset: 20
          limit: 10
          total_count: 150
    ExampleBillingResponseProductListSubscription:
      value:
        data:
          - id: cb43b415-5522-4373-b026-a365462f9114
            name: Luxury product
            type: recurring
            description: This product is the best product all over the world
            public_description: That cool product that you have bought
            status: active
            created_at: '2025-05-31 12:53:12'
            updated_at: '2025-05-31 12:53:13'
            term_length: 20
            payment_action: auth_settle
            settle_interval: 48
            billing_period:
              unit: day
              value: 10
            trial:
              billing_period:
                unit: day
                value: 10
              payment_action: auth_settle
              settle_interval: 48
            retry_mode: static
            retry_strategy_id: db43b415-5522-4373-b026-a365462f9439
            tax:
              category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
              behavior: included
            metadata:
              access_duration: 30d
              plan_tier: premium
        pagination:
          offset: 20
          limit: 10
          total_count: 150
    ExampleBillingRequestProductCreateOneTime:
      value:
        name: Luxury product
        type: one-time
        description: This product is the best product all over the world
        public_description: That cool product which you have bought
        status: active
        payment_action: auth_settle
        settle_interval: 48
        tax:
          category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
          behavior: included
        metadata:
          access_duration: 30d
          plan_tier: premium
    ExampleBillingRequestProductCreateSubscription:
      value:
        name: Luxury product
        type: recurring
        description: This product is the best product all over the world
        public_description: That cool product which you have bought
        status: active
        term_length: 20
        payment_action: auth_settle
        settle_interval: 48
        billing_period:
          unit: day
          value: 10
        trial:
          billing_period:
            unit: day
            value: 10
          payment_action: auth_settle
          settle_interval: 48
        retry_mode: static
        retry_strategy_id: db43b415-5522-4373-b026-a365462f9439
        tax:
          category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
          behavior: included
        metadata:
          access_duration: 30d
          plan_tier: premium
    ExampleBillingResponseProductCreateOneTime:
      value:
        id: ac43b415-5522-4373-b026-a365462f9657
        name: Luxury product
        type: one-time
        description: This product is the best product all over the world
        public_description: That cool product that you have bought
        status: active
        created_at: '2025-05-31 12:53:12'
        updated_at: '2025-05-31 12:53:13'
        payment_action: auth_settle
        settle_interval: 48
        tax:
          category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
          behavior: included
        metadata:
          access_duration: 30d
          plan_tier: premium
    ExampleBillingResponseProductCreateSubscription:
      value:
        id: ac43b415-5522-4373-b026-a365462f9657
        name: Luxury product
        type: recurring
        description: This product is the best product all over the world
        public_description: That cool product that you have bought
        status: active
        created_at: '2025-05-31 12:53:12'
        updated_at: '2025-05-31 12:53:13'
        term_length: 20
        payment_action: auth_settle
        settle_interval: 48
        billing_period:
          unit: day
          value: 10
        trial:
          billing_period:
            unit: day
            value: 10
          payment_action: auth_settle
          settle_interval: 48
        retry_mode: static
        retry_strategy_id: db43b415-5522-4373-b026-a365462f9439
        tax:
          category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
          behavior: included
        metadata:
          access_duration: 30d
          plan_tier: premium
    ExampleBillingResponseProductGetByIdOneTime:
      value:
        id: ac43b415-5522-4373-b026-a365462f9657
        name: Luxury product
        type: one-time
        description: This product is the best product all over the world
        public_description: That cool product that you have bought
        status: active
        created_at: '2025-05-31 12:53:12'
        updated_at: '2025-05-31 12:53:13'
        payment_action: auth_settle
        settle_interval: 48
        tax:
          category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
          behavior: included
        metadata:
          access_duration: 30d
          plan_tier: premium
    ExampleBillingResponseProductGetByIdSubscription:
      value:
        id: ac43b415-5522-4373-b026-a365462f9657
        name: Luxury product
        type: recurring
        description: This product is the best product all over the world
        public_description: That cool product that you have bought
        status: active
        created_at: '2025-05-31 12:53:12'
        updated_at: '2025-05-31 12:53:13'
        term_length: 20
        payment_action: auth_settle
        settle_interval: 48
        billing_period:
          unit: day
          value: 10
        trial:
          billing_period:
            unit: day
            value: 10
          payment_action: auth_settle
          settle_interval: 48
        retry_mode: static
        retry_strategy_id: db43b415-5522-4373-b026-a365462f9439
        tax:
          category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
          behavior: included
        metadata:
          access_duration: 30d
          plan_tier: premium
    ExampleBillingRequestProductUpdateOneTime:
      value:
        name: Luxury product
        description: This product is the best product all over the world
        public_description: That cool product which you have bought
        status: active
        payment_action: auth_settle
        settle_interval: 48
        tax:
          category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
          behavior: included
        metadata:
          access_duration: 30d
          plan_tier: premium
    ExampleBillingRequestProductUpdateSubscription:
      value:
        name: Luxury product
        description: This product is the best product all over the world
        public_description: That cool product which you have bought
        status: active
        term_length: 20
        payment_action: auth_settle
        settle_interval: 48
        billing_period:
          unit: day
          value: 10
        trial:
          billing_period:
            unit: day
            value: 10
          payment_action: auth_settle
          settle_interval: 48
        retry_mode: static
        retry_strategy_id: db43b415-5522-4373-b026-a365462f9439
        tax:
          category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
          behavior: included
        metadata:
          access_duration: 30d
          plan_tier: premium
    ExampleBillingResponseProductUpdateOneTime:
      value:
        id: ac43b415-5522-4373-b026-a365462f9657
        name: Luxury product
        type: one-time
        description: This product is the best product all over the world
        public_description: That cool product that you have bought
        status: active
        created_at: '2025-05-31 12:53:12'
        updated_at: '2025-05-31 12:53:13'
        payment_action: auth_settle
        settle_interval: 48
        tax:
          category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
          behavior: included
        metadata:
          access_duration: 30d
          plan_tier: premium
    ExampleBillingResponseProductUpdateSubscription:
      value:
        id: ac43b415-5522-4373-b026-a365462f9657
        name: Luxury product
        type: recurring
        description: This product is the best product all over the world
        public_description: That cool product that you have bought
        status: active
        created_at: '2025-05-31 12:53:12'
        updated_at: '2025-05-31 12:53:13'
        term_length: 20
        payment_action: auth_settle
        settle_interval: 48
        billing_period:
          unit: day
          value: 10
        trial:
          billing_period:
            unit: day
            value: 10
          payment_action: auth_settle
          settle_interval: 48
        retry_mode: static
        retry_strategy_id: db43b415-5522-4373-b026-a365462f9439
        tax:
          category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
          behavior: included
        metadata:
          access_duration: 30d
          plan_tier: premium
    ExampleBillingResponseProductArchiveOneTime:
      value:
        id: ac43b415-5522-4373-b026-a365462f9657
        name: Luxury product
        type: one-time
        description: This product is the best product all over the world
        public_description: That cool product that you have bought
        status: archived
        created_at: '2025-05-31 12:53:12'
        updated_at: '2025-05-31 12:53:13'
        payment_action: auth_settle
        settle_interval: 48
        tax:
          category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
          behavior: included
        metadata:
          access_duration: 30d
          plan_tier: premium
    ExampleBillingResponseProductArchiveSubscription:
      value:
        id: ac43b415-5522-4373-b026-a365462f9657
        name: Luxury product
        type: recurring
        description: This product is the best product all over the world
        public_description: That cool product that you have bought
        status: archived
        created_at: '2025-05-31 12:53:12'
        updated_at: '2025-05-31 12:53:13'
        term_length: 20
        payment_action: auth_settle
        settle_interval: 48
        billing_period:
          unit: day
          value: 10
        trial:
          billing_period:
            unit: day
            value: 10
          payment_action: auth_settle
          settle_interval: 48
        retry_mode: static
        retry_strategy_id: db43b415-5522-4373-b026-a365462f9439
        tax:
          category_id: taxc_01JJVD231C879QBHVTVCWJ1K2A
          behavior: included
        metadata:
          access_duration: 30d
          plan_tier: premium
    ExampleBillingResponseTaxTransactionalDownload:
      value:
        report_url: https://reports.solidgate.com/api/v1/tax/transactional/report/TAX_250702_140728_CHECKOUT/download
    ExampleBillingResponseTaxSummaryDownload:
      value:
        report_url: https://reports.solidgate.com/api/v1/tax/summary/report/TAX_250702_140728_CHECKOUT/download
    ExampleBillingResponseProductPriceCalculate:
      value:
        product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
        price_id: 61b7f690-242a-498c-99a1-eb191f93f08c
        currency: USD
        total_amount: 100
        tax:
          tax_amount: 20
          taxable_amount: 80
          location: USA
          profile_id: taxp_01JJVD231C879QBHVTVCWJ1K2A
          rate_id: taxr_01JJVD231C879QBHVTVCWJ1K2A
          rate: 25
          is_included: true
        recurring:
          total_amount: 100
          tax:
            tax_amount: 20
            taxable_amount: 80
            location: USA
            rate: 25
            is_included: true
    ExampleBillingResponseEntityNotFound:
      value:
        error:
          code: '2.01'
          message: '{entityName} not found'
    ExampleReportsResponseCardOrders:
      value:
        orders:
          - order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
            order_description: Premium package
            psp_order_id: 854756336423874823bdfsg6743gf5
            provider_payment_id: charge_64789DFS3827563HGF56
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            currency: USD
            processing_amount: 10
            processing_currency: USD
            status: processing
            payment_type: 1-click
            payment_method: card
            type: pay
            is_secured: true
            routing:
              cascade_steps:
                - mid: mid-1
                  mid_descriptor: descriptor-1
                  route_id: pm-1
                  cascade_number: 1
                  segment_id: fps_43bf3b784db24044446e8806723ff5ca
            customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
            customer_email: example@example.com
            customer_first_name: Nikola
            customer_last_name: Tesla
            mid: bank-mid-1
            ip_address: 203.0.113.0
            traffic_source: facebook
            platform: MOB
            geo_country: USA
            error_code: '3.02'
            transactions:
              - id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
                created_at: '2025-12-27 11:45:30'
                updated_at: '2025-12-28 11:45:30'
                amount: 100
                currency: USD
                operation: pay
                status: processing
                authorization_type: final
                descriptor: google.com
                refund_reason: Solidgate - Issuer Fraud Notification
                refund_reason_code: '0022'
                card:
                  bank: JSC UNIVERSAL BANK
                  bin: '444111'
                  brand: VISA
                  card_exp_month: '12'
                  card_exp_year: 2028
                  card_holder: John Snow
                  card_type: CREDIT
                  card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
                  country: USA
                  number: 444111XXXXXX9435
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
        metadata:
          next_page_iterator: eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9
          count: 1
    ExampleReportsResponseApmOrders:
      value:
        orders:
          - order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
            order_description: Premium package
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            method: paypal-vault
            amount: 100
            currency: USD
            processing_amount: 0
            processing_currency: USD
            status: processing
            customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
            customer_email: example@example.com
            ip_address: 203.0.113.0
            geo_country: USA
            error_code: '3.02'
            transactions:
              - id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
                psp_transaction_id: txn_5019d00bb70f82cd42f6bc654cbdfcbd63a9
                created_at: '2025-12-28 11:45:30'
                updated_at: '2025-12-29 11:45:30'
                method: paypal-vault
                amount: 100
                currency: USD
                status: processing
                type: pay
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
        metadata:
          next_page_iterator: eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9
          count: 1
    ExampleReportsResponseSubscriptions:
      value:
        subscriptions:
          <subscription_id_value_#1>:
            id: 64e1c283-17bf-45a7-90ea-2cb938081b2f
            status: cancelled
            updated_at: '2025-06-10 15:42:25'
            started_at: '2025-06-10 15:42:24'
            expired_at: '2025-09-10 16:42:24'
            next_charge_at: '2025-11-26 11:43:52'
            payment_type: paypal-vault
            trial: true
            cancelled_at: '2025-06-26 06:43:58'
            cancel_code: '8.01'
            cancel_message: Card brand is not supported
            customer:
              customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
              customer_email: example@example.com
            product:
              id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
              name: Platinum Audiobook Set
              payment_action: auth_void
              amount: 100
              currency: USD
              trial: true
              trial_period: 1
            invoices:
              <invoice_id_value_#1>:
                id: 4022a203-ace8-415f-9ae7-730014fceb25
                status: fail
                created_at: '2025-12-27 11:45:30'
                updated_at: '2025-12-28 11:45:30'
                amount: 100
                billing_period_started_at: '2025-12-29 11:45:30'
                billing_period_ended_at: '2025-12-30 11:45:30'
                subscription_term_number: 1
                orders:
                  <order_id_value_#1>:
                    id: 1672066481283AlexKho
                    status: processing
                    created_at: '2025-12-27 11:45:30'
                    processed_at: '2025-12-28 11:45:30'
                    operation: pay
                    amount: 100
                    payment_details:
                      invoice_id: 12344333-3ace-415f-9ae7-730014fceb25
                      payer_email: example@example.com
                    retry_attempt: 0
            pause:
              from_date: '2026-01-27 11:26:08'
              to_date: '2026-01-27 11:26:08'
        metadata:
          next_page_iterator: eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9
          count: 1
    ExampleReportsResponseChargebacks:
      value:
        orders:
          - order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
            order_description: Premium package
            created_at: '2025-08-18 09:57:42'
            updated_at: '2025-08-18 09:57:42'
            amount: 100
            currency: USD
            status: settle_ok
            type: pay
            is_secured: false
            customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
            customer_email: example@example.com
            customer_first_name: Nikola
            customer_last_name: Tesla
            ip_address: 203.0.113.0
            platform: WEB
            geo_country: USA
            chargebacks:
              - id: '892140'
                created_at: '2025-08-18 09:57:49'
                updated_at: '2025-08-18 09:57:49'
                dispute_date: '2025-08-18 09:57:49'
                settlement_date: '2025-08-18 09:57:49'
                amount: 100
                currency: USD
                type: 1st_chb
                status: reversed
                reason_group: Fraud
                reason_code: '10.4'
                reason_description: Fraud – Card-Absent Environment
                flows:
                  - id: '1159271'
                    date: '2025-08-18 00:00:00'
                    created_at: '2025-08-18 09:57:48'
                    updated_at: '2025-08-18 09:57:49'
                    settlement_date: '2025-08-18 00:00:00'
                    deadline_date: '2025-08-28 00:00:00'
                    amount: 100
                    dispute_amount: 100
                    currency: USD
                    type: 1st_chb
                    status: in_progress
                    represented_by: merchant
                    arn_code: '24871153022084127852235'
        metadata:
          next_page_iterator: eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9
          count: 1
    ExampleReportsResponsePaypalDisputes:
      value:
        disputes:
          - dispute_id: PP-D-85112454
            order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
            subscription_product_id: ac43b415-5522-4373-b026-a365462f9657
            subscription_service_id: fb603790-1234-1111-9876-ae4d59d5d378
            created_at: '2025-08-23 12:05:28'
            updated_at: '2025-08-23 12:05:28'
            seller_response_due_date: '2025-09-14 16:29:12'
            dispute_amount: 100
            dispute_currency: USD
            dispute_life_cycle_stage: INQUIRY
            dispute_channel: INTERNAL
            dispute_create_time: '2025-07-02 23:39:06'
            dispute_update_time: '2025-07-08 1:40:44'
            dispute_outcome: RESOLVED_WITH_PAYOUT
            reason: MERCHANDISE_OR_SERVICE_NOT_RECEIVED
            status: WAITING_FOR_BUYER_RESPONSE
            represented_by: automation
            customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
            customer_email: example@example.com
        metadata:
          next_page_iterator: eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9
          count: 1
    ExampleReportsResponsePreventionAlertsDownload:
      value:
        report_url: https://reports.solidgate.com/api/v1/prevention_alerts/report/PREVENT_250702_140728_CHECKOUT/download
    ExampleReportsResponseFraudAlerts:
      value:
        alerts:
          - order_id: 923bb4e6-4a5f-41ec-81fb-48eb8a152e55
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-27 11:45:30'
            fraud_amount: 50
            fraud_currency: USD
            fraud_amount_usd: 100
            fraud_report_date: '2025-03-24 14:22:15'
            fraud_type: '6'
            card_scheme: VISA
            reason_code_description: Fraudulent Use of Account Number
        metadata:
          next_page_iterator: eyJzdWJzY3JpcHRpb25faWQiOiI5ODlkCJkYXRlX3RvIjoiMjAyMC0wOS0xNyAxNDoxMDowMCJ9
          count: 1
    ExampleReportsResponseFinancialEntriesDownload:
      value:
        report_url: https://reports.solidgate.com/api/v1/finance/financial_entries/report/FIN_250702_140728_CHECKOUT/download
    ExampleReportsResponseRoutingV2ReportDownload:
      value:
        report_url: https://reports.solidgate.com/api/v1/routing/events/report/ROUTING_250702_140728_CHECKOUT/download
    ExampleRequestRisksFraudPreventionListItemsCreate:
      value:
        items:
          - list_type: pass
            payment_field: card_id
            field_value: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
            expired_at: '2025-12-21 11:21:30'
            description: This is a pass rule
            created_by: email@email.com
          - list_type: reject
            payment_field: ip_address
            field_value: 123.123.123.123
            description: This is a reject rule
    ExampleResponseRisksFraudPreventionListItemsCreate:
      value:
        items:
          - id: '1234567'
            list_type: pass
            payment_field: card_id
            field_value: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
            created_at: '2025-08-20 11:21:30'
            expired_at: '2025-12-21 11:21:30'
            description: This is a pass rule
            created_by: email@email.com
          - id: '1234568'
            list_type: reject
            payment_field: ip_address
            field_value: 123.123.123.123
            created_at: '2025-09-20 11:21:30'
            expired_at: null
            description: This is a reject rule
    ExampleResponseErrorFraudPreventionNotEnabled:
      value:
        error:
          code: '2.01'
          messages:
            - Fraud prevention is not enabled
    ExampleResponseErrorFraudPreventionListItemsDuplicated:
      value:
        error:
          code: '2.01'
          messages:
            - Some fraud prevention list items are duplicated
    ExampleRequestRisksFraudPreventionListItemList:
      value:
        list_type: pass
        payment_field_value:
          payment_field: customer_email
          field_value: test@test.com
        limit: 2000
        include_deleted: true
        created_at_from: '2025-08-15 11:00:00'
        created_at_to: '2025-08-18 11:00:00'
        next_page_iterator: '1234567'
    ExampleResponseRisksFraudPreventionListItemList:
      value:
        items:
          - id: '1234567'
            list_type: pass
            payment_field: customer_email
            field_value: test@test.com
            created_at: '2025-08-20 11:21:30'
            expired_at: '2025-12-21 11:21:30'
            deleted_at: '2025-08-27 11:21:30'
            description: This is a test rule
            created_by: email@email.com
        metadata:
          next_page_iterator: '1234567'
          count: 2000
    ExampleResponseRisksFraudPreventionListItemDelete:
      value:
        id: '1234567'
        list_type: pass
        payment_field: card_id
        field_value: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        created_at: '2025-08-20 11:21:30'
        expired_at: '2025-12-21 11:21:30'
        description: This is a pass rule
        created_by: email@email.com
    ExampleResponseErrorFraudPreventionListItemNotFound:
      value:
        error:
          code: '2.01'
          messages:
            - Item not found
    ExampleRequestRisksDisputeRepresentmentsCreateCard:
      value:
        dispute_type: card
        dispute_id: '123455667'
        evidence_file_id: file_01AAABBBCCC123456
    ExampleRequestRisksDisputeRepresentmentsCreatePayPal:
      value:
        dispute_type: paypal
        dispute_id: PP-D-123456789
        evidence_file_id: file_01AAABBBCCC123456
    ExampleResponseRisksDisputeRepresentmentsCreate:
      value:
        id: repr_10DDDEEEFFF123456
    ExampleResponseErrorRisksDisputeRepresentmentsInvalidData:
      value:
        error:
          code: '2.01'
          constraints:
            dispute_id:
              - code: NotBlank
                message: is required
          message: Validation error
    ExampleResponseErrorRisksDisputeRepresentmentsDisputeNotFound:
      value:
        error:
          code: '2.01'
          message: Dispute not found
    ExampleResponseErrorRisksDisputeRepresentmentsFileNotFound:
      value:
        error:
          code: '2.01'
          message: File not found
    ExampleResponseErrorRisksDisputeRepresentmentsFileNotReady:
      value:
        error:
          code: '2.01'
          message: File not ready
    ExampleResponseErrorRisksDisputeRepresentmentsFileSizeExceeded:
      value:
        error:
          code: '2.01'
          message: File size exceeded
    ExampleResponseErrorRisksDisputeRepresentmentsFileTypeNotSupported:
      value:
        error:
          code: '2.01'
          message: File type not supported
    ExampleResponseErrorRisksDisputeRepresentmentsAlreadyExists:
      value:
        error:
          code: '2.01'
          message: Representment already exists
    ExampleResponseErrorRisksDisputeRepresentmentsNotPossible:
      value:
        error:
          code: '2.01'
          message: Representment not possible
    ExampleRequestRisksDisputeRepresentmentsEnrichCard:
      value:
        dispute_type: card
        dispute_id: '123455667'
        enrichment:
          proof_of_communication:
            - file_id: file_01AAABBBCCC123451
              annotation: Email confirming subscription renewal.
          application_logs:
            - file_id: file_01AAABBBCCC12342
              annotation: User login history for disputed period.
          proof_of_delivery:
            - file_id: file_01AAABBBCCC12343
              annotation: Signed delivery confirmation.
          invoice:
            - file_id: file_01AAABBBCCC12344
              annotation: 'Invoice for order #12345.'
          receipts:
            - file_id: file_01AAABBBCCC12345
              annotation: Payment receipt dated 2024-01-15.
          other:
            - file_id: file_01AAABBBCCC12346
              annotation: Terms of service accepted by customer.
    ExampleRequestRisksDisputeRepresentmentsEnrichPayPal:
      value:
        dispute_type: paypal
        dispute_id: PP-D-123456789
        enrichment:
          proof_of_communication:
            - file_id: file_01AAABBBCCC123451
              annotation: Email confirming subscription renewal.
          application_logs:
            - file_id: file_01AAABBBCCC12342
              annotation: User login history for disputed period.
          proof_of_delivery:
            - file_id: file_01AAABBBCCC12343
              annotation: Signed delivery confirmation.
          invoice:
            - file_id: file_01AAABBBCCC12344
              annotation: 'Invoice for order #12345.'
          receipts:
            - file_id: file_01AAABBBCCC12345
              annotation: Payment receipt dated 2024-01-15.
          other:
            - file_id: file_01AAABBBCCC12346
              annotation: Terms of service accepted by customer.
        submit: false
    ExampleResponseRisksDisputeRepresentmentsEnrich:
      value: {}
    ExampleResponseErrorRisksDisputeRepresentmentsTotalFileSizeExceeded:
      value:
        error:
          code: '2.01'
          message: Total files size exceeded
    ExampleResponseErrorRisksDisputeRepresentmentsEnrichmentNotPossible:
      value:
        error:
          code: '2.01'
          message: Enrichment not possible
    ExampleResponseSuccessFile:
      value:
        file_id: file_01AAABBBCCC123456
        upload_url: https://storage.example.com/file/x?signature=123
    ExampleResponseErrorFileValidationError:
      value:
        error:
          code: '2.01'
          message: Invalid request
          constraints:
            file_size:
              - code: InvalidSize
                message: file_size must be less than 52428800 bytes
            file_type:
              - code: InvalidExtension
                message: file_type extension is not supported
    ExampleWebhooksResponseEndpointList:
      value:
        data:
          - id: 5831596c-ba07-4bb5-b35a-cf08a28b4c3f
            url: https://merchant.example/webhook
            event_types:
              - card_gate.order.updated
              - card_gate.chargeback.received
            name: Order status updates
            status: active
            created_at: '2025-01-01 12:00:00'
            updated_at: '2025-01-02 12:00:00'
          - id: 64033036-34ed-486e-bb0b-3b965560036a
            url: https://merchant.example/webhook
            event_types:
              - card_gate.order.updated
              - card_gate.chargeback.received
            name: Order updates
            status: inactive
            created_at: '2025-01-01 12:00:00'
            updated_at: '2025-01-02 12:00:00'
        pagination:
          offset: 2
          limit: 2
          total_count: 20
    ExampleWebhooksResponseEndpointInvalidLimit:
      value:
        error:
          code: '2.01'
          message: Invalid limit value
    ExampleWebhooksResponseEndpointLimitOutOfRange:
      value:
        error:
          code: '2.01'
          message: Limit must be between 1 and 100
    ExampleWebhooksResponseEndpointInvalidOffset:
      value:
        error:
          code: '2.01'
          message: Invalid offset value
    ExampleWebhooksResponseEndpointNegativeOffset:
      value:
        error:
          code: '2.01'
          message: Offset cannot be negative
    ExampleWebhooksResponseEndpointIDsMaxLen:
      value:
        error:
          code: '2.01'
          message: ID list exceeds maximum length of 50 items
    ExampleWebhooksResponseEndpointEmptyIDInList:
      value:
        error:
          code: '2.01'
          message: Empty ID at position 1
    ExampleWebhooksRequestCreate:
      value:
        url: https://merchant.example/webhook
        event_types:
          - card_gate.order.updated
          - card_gate.chargeback.received
        name: Order status updates
    ExampleWebhooksRequestCreateWithStatus:
      value:
        url: https://merchant.example/webhook
        event_types:
          - card_gate.order.updated
          - card_gate.chargeback.received
        name: Order status updates
        status: active
    ExampleWebhooksResponse:
      value:
        id: 5831596c-ba07-4bb5-b35a-cf08a28b4c3f
        url: https://merchant.example/webhook
        event_types:
          - card_gate.order.updated
          - card_gate.chargeback.received
        name: Order status updates
        status: active
        created_at: '2025-01-01 12:00:00'
        updated_at: '2025-01-02 12:00:00'
    ExampleWebhooksResponseInvalidJSON:
      value:
        error:
          code: '2.01'
          message: Invalid json
    ExampleWebhooksResponseInvalidURL:
      value:
        error:
          code: '2.01'
          constraints:
            url:
              - code: URL
                message: must be a valid value
          message: Validation error
    ExampleWebhooksResponseInvalidEventType:
      value:
        error:
          code: '2.01'
          constraints:
            event_types.0:
              - code: Enum
                message: must be a valid value
          message: Validation error
    ExampleWebhooksResponseInvalidStatus:
      value:
        error:
          code: '2.01'
          constraints:
            status:
              - code: Enum
                message: must be a valid value
          message: Validation error
    ExampleWebhooksResponseEndpointNameLen:
      value:
        error:
          code: '2.01'
          constraints:
            name:
              - code: Length
                message: the length must be no more than 255
          message: Validation error
    ExampleWebhooksResponseEndpointURLLen:
      value:
        error:
          code: '2.01'
          constraints:
            url:
              - code: Length
                message: the length must be no more than 512
          message: Validation error
    ExampleWebhooksResponseEndpointAlreadyExist:
      value:
        error:
          code: '2.01'
          message: Endpoint with the same URL for current channel already exists
    ExampleWebhooksResponseEndpointLimitReached:
      value:
        error:
          code: '2.01'
          message: Maximum endpoints per channel limit reached
    ExampleWebhooksRequestUpdateAll:
      value:
        event_types:
          - card_gate.order.updated
          - subscription.updated
        name: Order status updates
        url: https://merchant.example/webhook-updated
        status: active
    ExampleWebhooksRequestUpdateEventTypes:
      value:
        event_types:
          - card_gate.order.updated
          - subscription.updated
    ExampleWebhooksRequestUpdateStatus:
      value:
        url: https://merchant.example/webhook
        event_types:
          - card_gate.order.updated
          - subscription.updated
        status: active
    ExampleWebhooksRequestUpdateName:
      value:
        name: Order status updates
    ExampleWebhooksRequestUpdateURL:
      value:
        url: https://merchant.example/webhook-updated
    ExampleWebhooksResponseEndpointNotFound:
      value:
        error:
          code: '2.01'
          message: Endpoint not found
    ExampleCardsRequestWebhookOrderStatus:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          order_description: Premium package
          psp_order_id: 854756336423874823bdfsg6743gf5
          provider_payment_id: charge_64789DFS3827563HGF56
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          product_name: Luxury product
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          amount: 100
          currency: USD
          processing_amount: 0
          processing_currency: USD
          marketing_amount: 0
          marketing_currency: USD
          refunded_amount: 0
          authorized_amount: 100
          status: auth_ok
          auth_code: 2w9m8
          payment_type: 1-click
          payment_method: card
          customer_account_id: 93a1c659-288d-4d72-929d-10e241078faa
          customer_email: example@example.com
          descriptor: google.com
          mid: bank-mid-1
          ip_address: 8.8.8.8
          traffic_source: facebook
        error:
          code: '3.08'
          messages:
            - Do not honor
          recommended_message_for_user: Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction
        transaction:
          id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 100
          currency: USD
          marketing_amount: 0
          marketing_currency: USD
          operation: auth
          status: processing
          authorization_type: final
          scheme_transaction_id: MDSCAJVIJ1201
          transaction_link_id: A1bCDefGhijkLmNopQrStu
          descriptor: google.com
          billing_details:
            address: 21 Bedford Ave
            country: USA
            city: Boston
            state: NY
            zip: '91191'
          refund_reason: Solidgate - Issuer Fraud Notification
          refund_reason_code: '0022'
          card_token:
            token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
            original_payment_method: apple-pay
          card:
            bank: JSC UNIVERSAL BANK
            bin: '444111'
            brand: VISA
            card_exp_month: '12'
            card_exp_year: 2028
            card_holder: John Snow
            card_type: CREDIT
            is_reloadable: true
            card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
            country: USA
            number: 444111XXXXXX9435
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
              original_payment_method: apple-pay
          error:
            code: '3.08'
            messages:
              - Do not honor
            recommended_message_for_user: Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction
          payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
          arn_code: '24871153022084127852235'
          rrn_code: '100034876543'
        transactions:
          <transaction_id_value_#1>:
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            currency: USD
            marketing_amount: 0
            marketing_currency: USD
            operation: auth
            status: processing
            authorization_type: final
            scheme_transaction_id: MDSCAJVIJ1201
            transaction_link_id: A1bCDefGhijkLmNopQrStu
            descriptor: google.com
            billing_details:
              address: 21 Bedford Ave
              city: Boston
              country: USA
              state: NY
              zip: '91191'
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
            card_token:
              token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
              original_payment_method: apple-pay
            card:
              bank: JSC UNIVERSAL BANK
              bin: '444111'
              brand: VISA
              card_exp_month: '12'
              card_exp_year: 2028
              card_holder: John Snow
              card_type: CREDIT
              is_reloadable: true
              card_id: 22733af4-f6c6-4368-b7d0-98aeb0253a57
              country: USA
              number: 444111XXXXXX9435
              card_token:
                token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
                original_payment_method: apple-pay
            error:
              code: '3.08'
              messages:
                - Do not honor
              recommended_message_for_user: Advise the customer to contact their card issuer to resolve potential restrictions like blocked cards, insufficient limits, or currency issues before retrying the transaction
              merchant_advice_code: '30'
            payment_account_reference: PAR_1A2B3C4D5E6F7G8H9
            arn_code: '24871153022084127852235'
            rrn_code: '100034876543'
        three_ds:
          eci: '05'
          flow: frictionless
          exception: low_value
        routing:
          cascade_steps:
            - mid: mid-1
              mid_descriptor: descriptor-1
              route_id: pm-1
              cascade_number: 1
              segment_id: fps_43bf3b784db24044446e8806723ff5ca
        antifraud_result:
          pre_auth: review
        verification_result:
          avs_result: matched
          cvv_result: matched
          ani:
            status: performed
            full_name_match: matched
            first_name_match: partially_matched
            last_name_match: not_matched
        chargebacks:
          id: 147712
          dispute_date: '2025-07-11 00:00:00'
          settlement_date: '2025-07-11 00:00:00'
          amount: 100
          currency: USD
          type: 2nd_chb
          status: reversed
          reason_group: Fraud
          reason_code: '10.4'
          reason_description: Fraud – Card-Absent Environment
          chargeback_flow:
            - id: 12345
              date: '2025-07-10 00:00:00'
              updated_date: '2025-07-11 00:00:00'
              settlement_date: '2025-07-10 00:00:00'
              deadline_date: '2025-07-12 00:00:00'
              amount: 100
              dispute_amount: 0
              currency: USD
              type: 2nd_chb
              status: reversed
              arn_code: '24871153022084127852235'
        device_info:
          user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36
        verify_url: https://merchant.example/verify
        redirect_url: https://merchant.example/redirect
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleCardsRequestWebhookNetworkTokenCreated:
      value:
        card_id: 123e4567-e89b-12d3-a456-426614174000
        tokenization_type: vts
        status: INACTIVE
        created_at: '2025-08-17 11:45:30'
        updated_at: '2025-08-17 11:45:30'
    ExampleCardsRequestWebhookNetworkTokenUpdated:
      value:
        card_id: 123e4567-e89b-12d3-a456-426614174000
        tokenization_type: vts
        status: INACTIVE
        created_at: '2025-08-17 11:45:30'
        updated_at: '2025-08-17 11:45:30'
    ExampleCardsRequestWebhookChargeback:
      value:
        order:
          order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          amount: 100
          currency: USD
          status: settle_ok
        chargeback:
          id: 147712
          dispute_date: '2025-07-11 00:00:00'
          settlement_date: '2025-07-11 00:00:00'
          amount: 100
          currency: USD
          type: 1st_chb
          status: in_progress
          reason_group: Fraud
          reason_code: '10.4'
          reason_description: Fraud – Card-Absent Environment
          available_actions:
            - enrich_evidence
            - provide_evidence
        chargeback_flow:
          - id: 12345
            date: '2025-07-10 00:00:00'
            updated_date: '2025-07-11 00:00:00'
            settlement_date: '2025-07-10 00:00:00'
            deadline_date: '2025-07-12 00:00:00'
            amount: 100
            dispute_amount: 0
            currency: USD
            type: 1st_chb
            status: in_progress
            represented_by: automation
            arn_code: '24871153022084127852235'
    ExampleCardsRequestWebhookPreventAlert:
      value:
        order:
          id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          amount: 100
          currency: USD
          status: approved
        alert:
          id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          amount: 200
          currency: EUR
          provider_name: ethoca
          alert_date: '2025-12-29 11:01:03'
          created_at: '2025-12-29 11:03:30'
          updated_at: '2025-12-29 11:03:31'
          alert_type: init-refund
          outcome: reversed
    ExampleCardsRequestWebhookFraudAlert:
      value:
        id: 9147712
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        created_at: '2025-03-24 14:22:19'
        updated_at: '2025-03-24 14:22:19'
        fraud_amount: 2575
        fraud_currency: USD
        fraud_amount_usd: 12367
        fraud_type: '6'
        fraud_report_day: '2025-03-24 14:22:18'
        card_scheme: VISA
        reason_code_description: Fraudulent use of account number
    ExampleBillingWebhookTaxCalculated:
      value:
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        product_id: 1538344f-9e1a-4ad0-9a1e-7e6e4669775a
        total_amount: 1000
        currency: USD
        action: sale
        payment_category: card-payment
        transaction_date: '2025-12-06 15:18:40'
        tax_included: true
        tax:
          tax_amount: 91
          taxable_amount: 909
          rate: 10
          currency: USD
          location:
            country: USA
            state: MD
          legal_entity: Tech Solutions
    ExampleApmRequestWebhookOrderStatus:
      value:
        order:
          method: paypal-vault
          order_id: dce52ec4-2ee3-45f8-8333-cfbb7ac2ee49
          subscription_id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          token: baf2ff5c5a125aeabb4b80d7b983f66f3abf5dbb8d939df48b40755674eddceee78084eab5fa9c15a339c94f1ad2b30cf299
          created_at: '2025-12-27 11:45:30'
          updated_at: '2025-12-28 11:45:30'
          amount: 100
          currency: USD
          order_description: Premium package
          descriptor: PAYPAL *MERCH TOPSELL
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
          status: processing
          ip_address: 203.0.113.0
          provider_data:
            billing_address:
              country: USA
              state: WA
              city: New York
              zip: '10005'
              line1: 123 Main St.
              line2: Apt. 123
            shipping_address:
              country: USA
              state: NY
              city: Boston
              zip: '91191'
              line1: 777 Main St.
              line2: Apt. 321
            payer:
              account_id: Z5WEEM3YYCXBB
              first_name: John
              last_name: Doe
              email: example@example.com
              phone: '+352111222333'
            merchant:
              account_id: 78UQ777KUJAQN
        error:
          code: '5.02'
          messages:
            - Invalid Card Token
          recommended_message_for_user: Invalid Card Token
        transactions:
          - method: paypal-vault
            id: 5019d00bb70f82cd42f6bc654cbdfcbd63a9b5b1dbd6a
            created_at: '2025-12-27 11:45:30'
            amount: 100
            currency: USD
            status: processing
            type: pay
            refund_reason: Solidgate - Issuer Fraud Notification
            refund_reason_code: '0022'
        order_metadata:
          coupon_code: NY2025
          partner_id: '123989'
    ExampleApmRequestWebhookPaypalDispute:
      value:
        dispute_id: PP-D-85112454
        order_id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        subscription_product_id: ac43b415-5522-4373-b026-a365462f9657
        subscription_service_id: fb603790-1234-1111-9876-ae4d59d5d378
        created_at: '2025-08-23 12:05:28'
        updated_at: '2025-08-23 12:05:28'
        seller_response_due_date: '2025-09-14 16:29:12'
        dispute_amount: 100
        dispute_currency: USD
        dispute_life_cycle_stage: CHARGEBACK
        dispute_channel: INTERNAL
        dispute_create_time: '2025-07-02 23:39:06'
        dispute_update_time: '2025-07-08 1:40:44'
        dispute_outcome: RESOLVED_WITH_PAYOUT
        reason: MERCHANDISE_OR_SERVICE_NOT_RECEIVED
        status: WAITING_FOR_SELLER_RESPONSE
        represented_by: merchant
        customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
        customer_email: example@example.com
        available_actions:
          - enrich_evidence
          - provide_evidence
    ExampleApmRequestWebhookPreventAlert:
      value:
        order:
          id: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
          created_at: '2025-12-27 11:45:30'
          amount: 100
          currency: USD
          status: approved
        alert:
          id: 83b19018-cbc4-4df0-899a-dda84fd2705e
          amount: 200
          currency: EUR
          provider_name: ethoca
          alert_date: '2025-12-29 11:01:03'
          created_at: '2025-12-29 11:03:30'
          updated_at: '2025-12-29 11:03:31'
          alert_type: inquiry
          outcome: reversed
    ExampleApmRequestWebhookRevokedRecurringToken:
      value:
        token: 923bb4e6-4a5f-41ec-81fb-28eb8a152e55
        initial_order_id: 22738n
        cancelled_at: '2024-12-21 11:21:30'
    ExampleBillingWebhookExtendedCreate:
      value:
        callback_type: create
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: pending
          updated_at: '2025-09-08 12:37:25'
          payment_type: card
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: processing
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: processing
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                amount: 100
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedExpire:
      value:
        callback_type: expire
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: expired
          updated_at: '2025-09-08 12:37:25'
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: fail
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: auth_failed
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedPaymentAttempt:
      value:
        callback_type: payment_attempt
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: pending
          updated_at: '2025-09-28 11:45:25'
          payment_type: paypal-vault
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-09-27 11:45:10'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            billing_period_started_at: '2025-09-27 11:45:30'
            billing_period_ended_at: '2025-09-28 11:45:40'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: auth_ok
                created_at: '2025-09-27 11:45:25'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-28 11:45:25'
                amount: 100
                discount:
                  created_at: '2025-05-31 12:53:12'
                  coupon_code: SUMMER25OFF
                  coupon:
                    name: Summer 25% OFF
                    description: 25% off for 3 months
                    type: percentage
                    value: 25
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedActive:
      value:
        callback_type: active
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          next_charge_at: '2025-09-12 12:37:24'
          payment_type: card
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            billing_period_started_at: '2025-09-29 11:45:30'
            billing_period_ended_at: '2025-09-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: approved
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-28 11:45:30'
                amount: 100
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedRenew:
      value:
        callback_type: renew
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          next_charge_at: '2025-09-12 12:37:24'
          payment_type: card
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            billing_period_started_at: '2025-09-29 11:45:30'
            billing_period_ended_at: '2025-09-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: auth_ok
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-28 11:45:30'
                amount: 100
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedSwitchProduct:
      value:
        callback_type: switch_product
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-10-01 15:30:00'
          expired_at: '2025-10-08 12:37:24'
          next_charge_at: '2025-11-08 12:37:24'
          payment_type: paypal-vault
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: b62cba1d-4e8f-42f9-a9d1-cef09831f7ae
          name: Premium Audiobook Collection
          amount: 150
          currency: USD
          trial: false
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-10-01 15:30:00'
            updated_at: '2025-10-01 15:31:00'
            amount: 150
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            billing_period_started_at: '2025-10-08 12:37:24'
            billing_period_ended_at: '2025-11-08 12:37:24'
            subscription_term_number: 2
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-10-01 15:30:00'
                updated_at: '2025-10-01 15:30:00'
                processed_at: '2025-10-01 15:31:00'
                amount: 150
                failed_reason: '3.02'
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: approved
                created_at: '2025-10-02 15:30:00'
                updated_at: '2025-10-02 15:30:00'
                processed_at: '2025-10-02 15:31:00'
                amount: 150
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443340'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedUpdateOrder:
      value:
        callback_type: order_update
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          next_charge_at: '2025-08-26 11:43:52'
          payment_type: card
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            billing_period_started_at: '2025-09-29 11:45:30'
            billing_period_ended_at: '2025-09-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: auth_ok
                created_at: '2025-09-28 11:50:30'
                updated_at: '2025-09-28 11:50:30'
                processed_at: '2025-09-29 11:50:30'
                amount: 100
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedPause:
      value:
        callback_type: pause
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: paused
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          next_charge_at: '2025-09-28 07:48:15'
          payment_type: paypal-vault
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
          pause:
            from_date: '2025-09-11 11:26:08'
            to_date: '2025-09-27 11:26:08'
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            billing_period_started_at: '2025-09-29 11:45:30'
            billing_period_ended_at: '2025-09-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: approved
                created_at: '2025-09-28 11:50:30'
                updated_at: '2025-09-28 11:50:30'
                processed_at: '2025-09-29 11:50:30'
                amount: 100
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443340'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedCreatePauseSchedule:
      value:
        callback_type: pause_schedule.create
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          next_charge_at: '2025-09-24 07:48:15'
          payment_type: card
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
          pause:
            from_date: '2025-09-11 11:26:08'
            to_date: '2025-09-27 11:26:08'
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            billing_period_started_at: '2025-09-29 11:45:30'
            billing_period_ended_at: '2025-09-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: auth_ok
                created_at: '2025-09-28 11:50:30'
                updated_at: '2025-09-28 11:50:30'
                processed_at: '2025-09-29 11:50:30'
                amount: 100
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedUpdatePauseSchedule:
      value:
        callback_type: pause_schedule.update
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          next_charge_at: '2025-09-28 11:48:15'
          payment_type: paypal-vault
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: true
          pause:
            from_date: '2025-09-11 11:26:08'
            to_date: '2025-09-27 11:26:08'
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            billing_period_started_at: '2025-09-29 11:45:30'
            billing_period_ended_at: '2025-09-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: approved
                created_at: '2025-09-28 11:50:30'
                updated_at: '2025-09-28 11:50:30'
                processed_at: '2025-09-29 11:50:30'
                amount: 100
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443340'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedDeletePauseSchedule:
      value:
        callback_type: pause_schedule.delete
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          next_charge_at: '2025-09-12 12:37:24'
          payment_type: card
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            billing_period_started_at: '2025-09-29 11:45:30'
            billing_period_ended_at: '2025-09-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: auth_ok
                created_at: '2025-09-28 11:50:30'
                updated_at: '2025-09-28 11:50:30'
                processed_at: '2025-09-29 11:50:30'
                amount: 100
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedResume:
      value:
        callback_type: resume
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          next_charge_at: '2025-09-12 12:37:24'
          payment_type: paypal-vault
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            billing_period_started_at: '2025-09-29 11:45:30'
            billing_period_ended_at: '2025-09-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: auth_ok
                created_at: '2025-09-28 11:50:30'
                updated_at: '2025-09-28 11:50:30'
                processed_at: '2025-09-29 11:50:30'
                amount: 100
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443340'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedRecurring:
      value:
        callback_type: recurring
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          next_charge_at: '2025-09-12 12:37:24'
          payment_type: card
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: approved
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                amount: 100
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedRestore:
      value:
        callback_type: restore
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          next_charge_at: '2025-09-12 12:37:24'
          payment_type: paypal-vault
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            billing_period_started_at: '2025-09-29 11:45:30'
            billing_period_ended_at: '2025-09-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: auth_ok
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedCancel:
      value:
        callback_type: cancel
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: cancelled
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          payment_type: card
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
          cancelled_at: '2025-09-12 19:37:24'
          cancellation_requested_at: '2025-09-11 19:37:24'
          cancel_code: '8.09'
          cancel_message: Cancellation after redemption period
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: fail
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            billing_period_started_at: '2025-09-29 11:45:30'
            billing_period_ended_at: '2025-09-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedScheduleCancellation:
      value:
        callback_type: scheduled_for_cancellation
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          payment_type: upi
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
          cancelled_at: '2025-09-12 19:37:24'
          cancellation_requested_at: '2025-09-11 19:37:24'
          cancel_code: '8.09'
          cancel_message: Cancellation after redemption period
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            billing_period_started_at: '2025-09-29 11:45:30'
            billing_period_ended_at: '2025-09-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: auth_ok
                created_at: '2025-09-28 11:50:30'
                updated_at: '2025-09-28 11:50:30'
                processed_at: '2025-09-29 11:50:30'
                amount: 100
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedRedemption:
      value:
        callback_type: redemption
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: redemption
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          next_charge_at: '2025-10-08 11:43:52'
          payment_type: paypal-vault
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: retry
            created_at: '2025-09-08 11:45:25'
            updated_at: '2025-09-08 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-09-08 11:45:25'
                updated_at: '2025-09-08 11:45:25'
                processed_at: '2025-09-08 11:45:30'
                amount: 1000
                failed_reason: '3.02'
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedRetry:
      value:
        callback_type: retry
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: redemption
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          payment_type: card
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: retry
            created_at: '2025-09-27 11:45:30'
            updated_at: '2025-09-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                processed_at: '2025-09-27 07:55:41'
                amount: 1000
                failed_reason: '3.02'
                retry_attempt: 1
              1772066481453AlexKhy:
                id: 1772066481453AlexKhy
                status: processing
                created_at: '2025-09-27 11:45:30'
                updated_at: '2025-09-27 11:45:30'
                amount: 1000
                retry_attempt: 2
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookExtendedScheduleRetry:
      value:
        callback_type: scheduled_for_retry
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: redemption
          started_at: '2025-09-08 12:37:24'
          updated_at: '2025-09-08 12:37:25'
          expired_at: '2025-09-12 12:37:24'
          next_charge_at: '2025-09-12 12:37:24'
          payment_type: paypal-vault
          discount:
            created_at: '2025-05-31 12:53:12'
            coupon_code: SUMMER25OFF
            coupon:
              name: Summer 25% OFF
              description: 25% off for 3 months
              type: percentage
              value: 25
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: retry
            created_at: '2025-09-08 12:45:30'
            updated_at: '2025-09-08 12:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            discount:
              created_at: '2025-05-31 12:53:12'
              coupon_code: SUMMER25OFF
              coupon:
                name: Summer 25% OFF
                description: 25% off for 3 months
                type: percentage
                value: 25
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-09-08 12:45:30'
                updated_at: '2025-09-08 12:45:30'
                processed_at: '2025-09-08 12:45:41'
                amount: 1000
                failed_reason: '3.02'
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
              1772066481453AlexKhy:
                id: 1772066481453AlexKhy
                status: declined
                created_at: '2025-09-10 11:45:30'
                updated_at: '2025-09-10 11:45:30'
                processed_at: '2025-09-10 12:45:41'
                amount: 1000
                failed_reason: '3.02'
                retry_attempt: 2
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookInit:
      value:
        callback_type: init
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-12-08 12:37:24'
          updated_at: '2025-12-08 12:37:25'
          expired_at: '2025-12-12 12:37:24'
          next_charge_at: '2025-11-26 11:43:52'
          payment_type: paypal-vault
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            billing_period_started_at: '2025-12-29 11:45:30'
            billing_period_ended_at: '2025-12-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: approved
                created_at: '2025-12-27 11:45:30'
                updated_at: '2025-12-27 11:45:30'
                processed_at: '2025-12-28 11:45:30'
                amount: 100
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookRenew:
      value:
        callback_type: renew
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-12-08 12:37:24'
          updated_at: '2025-12-08 12:37:25'
          expired_at: '2025-12-12 12:37:24'
          next_charge_at: '2025-12-12 12:37:24'
          payment_type: card
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            billing_period_started_at: '2025-12-29 11:45:30'
            billing_period_ended_at: '2025-12-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: auth_ok
                created_at: '2025-12-27 11:45:30'
                updated_at: '2025-12-27 11:45:30'
                processed_at: '2025-12-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookUpdate:
      value:
        callback_type: update
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: cancelled
          started_at: '2025-12-08 12:37:24'
          updated_at: '2025-12-08 12:37:25'
          expired_at: '2025-12-12 12:37:24'
          next_charge_at: '2025-11-26 11:43:52'
          payment_type: paypal-vault
          trial: false
          cancelled_at: '2025-12-12 12:37:20'
          cancellation_requested_at: '2025-12-12 12:37:20'
          cancel_code: '8.09'
          cancel_message: Cancellation after redemption period
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            billing_period_started_at: '2025-12-29 11:45:30'
            billing_period_ended_at: '2025-12-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: approved
                created_at: '2025-12-27 11:45:30'
                updated_at: '2025-12-27 11:45:30'
                processed_at: '2025-12-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookCancel:
      value:
        callback_type: cancel
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: cancelled
          started_at: '2025-12-08 12:37:24'
          updated_at: '2025-12-08 12:37:25'
          expired_at: '2025-12-12 12:37:24'
          payment_type: card
          trial: false
          cancelled_at: '2025-12-12 19:37:24'
          cancellation_requested_at: '2025-12-11 19:37:24'
          cancel_code: '8.09'
          cancel_message: Cancellation after redemption period
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: fail
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            billing_period_started_at: '2025-12-29 11:45:30'
            billing_period_ended_at: '2025-12-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-12-27 11:45:30'
                updated_at: '2025-12-27 11:45:30'
                processed_at: '2025-12-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookPause:
      value:
        callback_type: pause
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: paused
          started_at: '2025-12-08 12:37:24'
          updated_at: '2025-12-08 12:37:25'
          expired_at: '2025-12-12 12:37:24'
          next_charge_at: '2025-12-28 07:48:15'
          payment_type: paypal-vault
          trial: false
          pause:
            from_date: '2025-12-11 11:26:08'
            to_date: '2025-12-27 11:26:08'
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            billing_period_started_at: '2025-12-29 11:45:30'
            billing_period_ended_at: '2025-12-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-12-27 11:45:30'
                updated_at: '2025-12-27 11:45:30'
                processed_at: '2025-12-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: approved
                created_at: '2025-12-28 11:50:30'
                updated_at: '2025-12-28 11:50:30'
                processed_at: '2025-12-29 11:50:30'
                amount: 100
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443340'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookResume:
      value:
        callback_type: resume
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-12-08 12:37:24'
          updated_at: '2025-12-08 12:37:25'
          expired_at: '2025-12-12 12:37:24'
          next_charge_at: '2025-12-12 12:37:24'
          payment_type: card
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            billing_period_started_at: '2025-12-29 11:45:30'
            billing_period_ended_at: '2025-12-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-12-27 11:45:30'
                updated_at: '2025-12-27 11:45:30'
                processed_at: '2025-12-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: approved
                created_at: '2025-12-28 11:50:30'
                updated_at: '2025-12-28 11:50:30'
                processed_at: '2025-12-28 11:50:35'
                amount: 100
                retry_attempt: 1
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookCreatePauseSchedule:
      value:
        callback_type: pause_schedule.create
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-12-08 12:37:24'
          updated_at: '2025-12-08 12:37:25'
          expired_at: '2025-12-12 12:37:24'
          payment_type: paypal-vault
          trial: false
          pause:
            from_date: '2025-12-11 11:26:08'
            to_date: '2025-12-27 11:26:08'
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            billing_period_started_at: '2025-12-29 11:45:30'
            billing_period_ended_at: '2025-12-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-12-27 11:45:30'
                updated_at: '2025-12-27 11:45:30'
                processed_at: '2025-12-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: approved
                created_at: '2025-12-28 11:50:30'
                updated_at: '2025-12-28 11:50:30'
                processed_at: '2025-12-29 11:50:30'
                amount: 100
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443340'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookUpdatePauseSchedule:
      value:
        callback_type: pause_schedule.update
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: paused
          started_at: '2025-12-08 12:37:24'
          updated_at: '2025-12-08 12:37:25'
          expired_at: '2025-12-12 12:37:24'
          next_charge_at: '2025-12-28 11:48:15'
          payment_type: paypal-vault
          trial: false
          pause:
            from_date: '2025-12-11 11:26:08'
            to_date: '2025-12-27 11:26:08'
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            billing_period_started_at: '2025-12-29 11:45:30'
            billing_period_ended_at: '2025-12-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-12-27 11:45:30'
                updated_at: '2025-12-27 11:45:30'
                processed_at: '2025-12-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: approved
                created_at: '2025-12-28 11:50:30'
                updated_at: '2025-12-28 11:50:30'
                processed_at: '2025-12-29 11:50:30'
                amount: 100
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443340'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
    ExampleBillingWebhookDeletePauseSchedule:
      value:
        callback_type: pause_schedule.delete
        subscription:
          id: 9e252e9f-c5a3-4dca-93df-4c9fcf54267e
          status: active
          started_at: '2025-12-08 12:37:24'
          updated_at: '2025-12-08 12:37:25'
          expired_at: '2025-12-12 12:37:24'
          next_charge_at: '2025-12-12 12:37:24'
          payment_type: paypal-vault
          trial: false
        product:
          product_id: a51ba9fd-3be1-4ef9-b00f-bb85157597f5
          name: Platinum Audiobook Set
          payment_action: auth_void
          amount: 100
          currency: USD
          trial: true
          trial_period: 1440
          trial_amount: 99
          trial_currency: USD
        customer:
          customer_account_id: 93a1c659-288d-4d62-929d-10e241078faa
          customer_email: example@example.com
        invoices:
          4022a203-ace8-415f-9ae7-730014fceb25:
            id: 4022a203-ace8-415f-9ae7-730014fceb25
            status: success
            created_at: '2025-12-27 11:45:30'
            updated_at: '2025-12-28 11:45:30'
            amount: 100
            price_product_id: 61b7f690-242a-498c-99a1-eb191f93f08c
            billing_period_started_at: '2025-12-29 11:45:30'
            billing_period_ended_at: '2025-12-30 11:45:30'
            subscription_term_number: 1
            orders:
              1672066481283AlexKho:
                id: 1672066481283AlexKho
                status: declined
                created_at: '2025-12-27 11:45:30'
                updated_at: '2025-12-27 11:45:30'
                processed_at: '2025-12-28 11:45:30'
                amount: 100
                failed_reason: '3.02'
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443334'
                  payer_email: example@example.com
              1692066491293AlexKho:
                id: 1692066491293AlexKho
                status: approved
                created_at: '2025-12-28 11:50:30'
                updated_at: '2025-12-28 11:50:30'
                processed_at: '2025-12-29 11:50:30'
                amount: 100
                retry_attempt: 1
                payment_details:
                  invoice_id: '123443340'
                  payer_email: example@example.com
            order_metadata:
              coupon_code: NY2025
              partner_id: '123989'
x-tagGroups:
  - name: Payments
    tags:
      - Card payments
      - Alternative payment methods
  - name: Billing
    tags:
      - Products and prices
      - Taxes
      - Manage subscriptions
      - Retrieve subscription data
  - name: Risks
    tags:
      - Fraud prevention
      - Dispute representment
  - name: Checkout solutions
    tags:
      - Payment page
      - Payment link
  - name: Webhooks
    tags:
      - Manage webhooks
  - name: Reporting
    tags:
      - Reports
  - name: Files
    tags:
      - Files upload
  - name: ―――――――――――――――――
    tags:
      - Changelog
