openapi: 3.0.3
info:
  title: Trade Finance API Specification - Buyer Loans
  description: |
    <hr>
    <section>
      <h3>API Security at HSBC</h3>
      <p>HSBC considers API security as our highest priority and are constantly monitoring advancements in technology to improve our protection where possible.</p>
      <p>The diagram below illustrates how Authentication, Authorisation, TLS and Message Level Encryption combined, stack up to provide you with world class API Security.</p>
      <img src="https://develop.hsbc.com/sites/default/files/inline-images/HSBC_Diagram1_v6.png">
      <p>Find out more from <a href="https://develop.hsbc.com/knowledge-article/api-security-hsbc" target="blank">API Security at HSBC</a></p>
      <section>
        <h4>Guidance on Authentication/ Authorisation</h4>
        <ol>
          <li>All our APIs confirm the identity of all requesters, this is Authentication.</li>
          <li>All our APIs are called and activated only by trusted systems, this is Authorisation.</li>
          <li>Both of the above are handled during the initial exchange between the Client Application and HSBC's API Gateway.</li>
        </ol>
        <img src="https://develop.hsbc.com/sites/default/files/inline-images/D4_messaageFlowUpdated.PNG">
        <p>Find out more from <a href="https://develop.hsbc.com/node/665#apidoccontentid-1394" target="blank">Making an API Request</a></p>
        <section>
          <h5 id="authentication">Authentication</h5>
          <p>Your <code>Digital Identity</code>, which is a <strong>private-key-signed</strong> <code>bearer token</code> generated <strong>per request</strong>, must be sent via <code>Authorization</code> in the request <code>header</code>.</p>
          <details>
            <summary>
              <strong>View details</strong>
            </summary>
            <ul>
              <li>
                <a href="https://develop.hsbc.com/node/665#apidoccontentid-928" target="blank">What is Bearer Token (JWS) and it's structure</a>
              </li>
              <li>
                <h6>What is API Connection Profile?</h6>
                <p>It is required to establish your <code>API Connection Profile</code>, an unique ID generated from <strong>HSBC</strong>, for token generation.</p>
                <p>
                  For testing in the <a href="https://develop.hsbc.com/node/813" target="blank">Sandbox Environment</a>, create your test project and API Connection Profile via
                  <a href="https://develop.hsbc.com/dev-hub/user-project-list" target="blank">Dev Hub</a>.<br>
                  <a href="https://develop.hsbc.com/node/813#generating-credentials-via-dev-hub" target="blank">
                    <sub>How to generate test API Connection Profile?</sub>
                  </a>
                </p>
              </li>
            </ul>
          </details>
        </section>
        <section>
          <h5 id="authorisation">Authorisation</h5>
          <p>It is required to specify customer's identity in all request in the <code>request body</code>.</p>
          <details>
            <summary>
              <strong>View details</strong>
            </summary>
              <h6>Customer Identity:</h6>
                <p>Customer's identity is represented by <code>extnlCustomerId</code> in the request payload</p>
              <h6>Customer's transaction account:</h6>
                <p>Corresponding customer's <strong>HSBC</strong> transaction account, i.e. <code>tradeAccountNumber</code> must be sent in all requests.</p>
            </section>
          </details>
        </section>
        <section>
          <h5>Types of connections</h5>
            <p>Depending on your use case, two types of Auth-N/ Auth-Z options you can consider:</P>
            <table>
              <tr>
                <th>Type</th>
                <th>Description</th>
                <th>API Profile ID</th>
                <th>Credentials</th>
                <th>Customer ID</th>
                <th>Account</th>
              </tr>
              <tr>
                <td>Direct Connection (B2B)</td>
                <td>The API request represents an end customer/ client, with its own set of credentials.</td>
                <td>End Customer</td>
                <td>End Customer</td>
                <td>End Customer</td>
                <td>End Customer</td>
              </tr>
              <tr>
                <td>On-behalf of (B2B2B)</td>
                <td>The API request is sent via a partner to HSBC on-behalf of its' customers. HSBC perform Auth-N validation based on partner's credential</td>
                <td>Partner</td>
                <td>Partner</td>
                <td>End Customer</td>
                <td>End Customer</td>
              </tr>
            </table>
            <details>
              <summary>View example:</summary>
              <table>
                <tr>
                  <th>Type</th>
                  <th>Bearer Token</th>
                  <th>Request Body</th>
                </tr>
                <tr>
                  <td>Direct Connection (B2B)</td>
                  <td>"sub": <code>endCustomerAPIProfileId</code></td>
                  <td>
                    "extnlCustomerId": <code>endCustomerAPIProfileId,</code>
                    "tradeAccountNumber": <code>endCustomerAccountNumber</code>
                  </td>  
                </tr>
                <tr>
                  <td>On-behalf of (B2B2B)</td>
                  <td>"sub": <code>partnerAPIProfileId</code>
                  </td>
                  <td>
                      "extnlCustomerId": <code>endCustomerAPIProfileId</code>,
                      "tradeAccountNumber": <code>endCustomerAccountNumber</code>
                  </td>  
                </tr>
              </table>
            </details>
        </section>
      </section>
      <section>
      <h4>Guidance on Message Encryption and Message Content</h4>
      <p>The API specification generally provides two definitions for request and responses messages - <code>Unencrypted</code> and <code>Encrypted</code> using a <code>oneOf</code> structure.</p>
    </section>
    </section>
    <hr>
    <section>
      <h3>Guidance on Request Structure</h3>
      <ol>
        <li>Parameter(s) which are <strong>non-mandatory</strong> are specified with <code>minLength: 0</code>, e.g. <code>"paramKey001": ""</code>.</li>
        <li>Array List(s) which are <strong>non-mandatory</strong> are specified with <code>minItems: 0</code>, e.g. <code>"arrayKey001": []</code>.</li>
      </ol>
    <hr>
    <section>
      <h3>Version History</h3>
        <table>
          <tr>
            <th>Current Version</th>
            <th>Date</th>
            <th>Descriptions</th>
          </tr>
          <tr>
            <td>1.0.1</td>
            <td>2023-04-27</td>
            <td>Updates on parameters</td>
          </tr>
        </table>
        <details>
          <summary>View changes</summary>
          <table>
            <tr>
              <th>Version</th>
              <th>Date</th>
              <th>Descriptions</th>
            </tr>
            <tr>
              <td>1.0.0</td>
              <td>2022-04-30</td>
              <td>First Release</td>
            </tr>
            <tr>
              <td>1.0.1</td>
              <td>2023-04-27</td>
              <td>
                <ol>
                  <li>Updated<code>beneficiaryDetails</code> to <code>beneficiaryDetail</code></li>
                  <li>Removed <code>beneficiaryDetail.beneficiaryReferenceNumber</code></li>
                  <li>Removed <code>beneficiaryDetail.beneficiaryBankBranchName</code></li>
                </ol>
              </td>
            </tr>
          </table>
        </details>  
  contact:
    name: develop.hsbc
    url: https://develop.hsbc.com/contact-us
  version: '1.0.1'
servers:
- url: https://sandbox.corporate-api.hsbc.com/mock/twc/v1
- url: https://sandbox.corporate-api.hsbc.com/twc/v1
externalDocs:
  description: Trade Finance - Buyer Loans API Doucmentation
  url: https://develop.hsbc.com/node/665
tags:
- name: Buyer Loans
  description: Request Trade loan for buyers
- name: Common Services
  description: General Purpose APIs
paths:
  /buyer-loans/standard:
    post:
      tags:
      - Buyer Loans
      summary: Submit Buyer Loan Application
      description: >- 
        <p>Enables a buyer to directly submit a standard loan request to HSBC.</p>
        <details>
          <summary><strong>View Pre-requisites</strong>:</summary>
          <ol>
            <li>
              <strong>API Connection Profile</strong> has been created.
              <a href="https://develop.hsbc.com/knowledge-article/get-started-corporate-banking-apis#securing-a-connection" target="blank"><sub>What is an API Connection Profile?</sub></a>
              <ol type="i">
                <li>
                  For testing in the <a href="https://develop.hsbc.com/node/813" target="blank">Sandbox Environment</a>, create your test project and API Connection Profile via
                  <a href="https://develop.hsbc.com/dev-hub/user-project-list" target="blank">Dev Hub</a>.<br />
                  <a href="https://develop.hsbc.com/node/813#generating-credentials-via-dev-hub" target="blank"><sub>How to generate test API Connection Profile?</sub></a>
                </li>
              </ol>
            </li>
            <li>Loan applicant possesses valid <strong>transaction account</strong> in <strong>HSBC</strong>.</li>
            <li>
              (Optional) <strong>Supporting documents</strong> have been submitted successfully via <code>Submit Supporting Documents API</code>. <a href="#operation/upload-supporting-documents"><sub>View Endpoint</sub></a>
            </li>
          </ol>
        </details>
        <details>
          <summary><strong>View Post-conditions</strong>:</summary>
          <ol>
            <li><code>loanNumber</code> and <code>applicationId</code> are generated for the loan application <code>Submitted</code> to <strong>HSBC</strong>.</li>
            <li>
              It is possible to perform the following for this loan:
              <ol type="i">
                <li>
                  Enquires <strong>status of this and many other loans</strong> that have been submitted via <code>Request Trade Loan Status API</code>. <a href="#operation/list-trade-loan-status"><sub>View Endpoint</sub></a>
                </li>
                <li>
                  Enquires <strong>details of this loan</strong> of it via <code>Request Trade Loan Details API</code>. <a href="#operation/get-trade-loan-details"><sub>View Endpoint</sub></a>
                </li>
              </ol>
            </li>
          </ol>
        </details>
      operationId: create-standard-buyer-loan-applications
      security:
      - BearerTokenJWS: []
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/requestTime'
      - $ref: '#/components/parameters/requestId'
      - $ref: '#/components/parameters/countryCode'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/schemaVersion'
      requestBody:
        $ref: '#/components/requestBodies/CreateStandardBuyerLoanRequest'
      responses:
        '200':
          $ref: '#/components/responses/CreateLoanApplicationResponse'
        '400':
          $ref: '#/components/responses/RESPONSE_400_TAAS'
        '401':
          $ref: '#/components/responses/RESPONSE_401_TAAS'
        '403':
          $ref: '#/components/responses/RESPONSE_403_TAAS'
        '404':
          $ref: '#/components/responses/RESPONSE_404_TAAS'
        '500':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '502':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '503':
          $ref: '#/components/responses/RESPONSE_503_TAAS'
  # /buyer-loans/advanced:
    # post:
      # tags:
      # - Buyer Loans
      # summary: Submit Buyer Loan Application (Advanced)
      # description: >- 
        # Enables a buyer to directly submit a standard loan request to HSBC.
          # <details>
            # <summary><strong>View Pre-requisites</strong>:</summary>
            # <ol>
              # <li><strong>API Connection Profile</strong> has been created. <a href="https://develop.hsbc.com/knowledge-article/get-started-corporate-banking-apis#securing-a-connection" target="blank"><sub>What is an API Connection Profile?</sub></a>
              # <ol type="i">
                # <li>For testing in the <a href="https://develop.hsbc.com/node/813" target="blank">Sandbox Environment</a>, create your test project and API Connection Profile via <a href="https://develop.hsbc.com/dev-hub/user-project-list" target="blank">Dev Hub</a>.<br>
                # <a href="https://develop.hsbc.com/node/813#generating-credentials-via-dev-hub" target="blank"><sub>How to generate test API Connection Profile?</sub></a>
                # </li>               
              # </ol>
              # </li>
              # <li>Loan applicant possesses valid <strong>transaction account</strong> in <strong>HSBC</strong>.</li>
              # <li>(Optional) <strong>Supporting documents</strong> have been submitted successfully via <code>Submit Supporting Documents API</code>. <a href="#operation/upload-supporting-documents"><sub>View Endpoint</sub></a></li>
           # </ol>
          # </details>
          # <details>
            # <summary><strong>View Post-conditions</strong>:</summary>
            # <ol>
              # <li><code>loanNumber</code> and <code>applicationId</code> are generated for the loan application <code>Submitted</code> to <strong>HSBC</strong>.</li>
              # <li>It is possible to perform the following for this loan:
              # <ol type="i">
                # <li>Extends it's <strong>duration</strong> via <code>Submit Buyer Loan Extension Request API</code>. <a href="#operation/extend-standard-buyer-loans"><sub>View Endpoint</sub></a></li>
                # <li>Performs <strong>settlement</strong> via <code>Submit Buyer Loan Settlement Request API</code>. <a href="#operation/settle-standard-buyer-loans"><sub>View Endpoint</sub></a></li>
                # <li>Enquires <strong>status of this and many other loans</strong> that have been submitted via <code>Request Trade Loan Status API</code>. <a href="#operation/list-trade-loan-status"><sub>View Endpoint</sub></a></li>
                # <li>Enquires <strong>details of this loan</strong> of it via <code>Request Trade Loan Details API</code>. <a href="#operation/get-trade-loan-details"><sub>View Endpoint</sub></a></li>
              # </ol>
              # </li>
            # </ol>
          # </details>
      # operationId: create-advanced-buyer-loan-applications
      # security:
      # - BearerTokenJWS: []
      # parameters:
      # - $ref: '#/components/parameters/Authorization'
      # - $ref: '#/components/parameters/requestTime'
      # - $ref: '#/components/parameters/requestId'
      # - $ref: '#/components/parameters/countryCode'
      # - $ref: '#/components/parameters/Content-Type'
      # - $ref: '#/components/parameters/schemaVersion'
      # requestBody:
        # $ref: '#/components/requestBodies/CreateAdvancedBuyerLoanRequest'
      # responses:
        # '200':
          # $ref: '#/components/responses/CreateLoanApplicationResponse'
        # '400':
          # $ref: '#/components/responses/RESPONSE_400_TAAS'
        # '401':
          # $ref: '#/components/responses/RESPONSE_401_TAAS'
        # '403':
          # $ref: '#/components/responses/RESPONSE_403_TAAS'
        # '404':
          # $ref: '#/components/responses/RESPONSE_404_TAAS'
        # '500':
          # $ref: '#/components/responses/RESPONSE_500_TAAS'
        # '502':
          # $ref: '#/components/responses/RESPONSE_500_TAAS'
        # '503':
          # $ref: '#/components/responses/RESPONSE_503_TAAS'
  /buyer-loans/standard/extension:
    post:
      tags:
      - Buyer Loans
      summary: Submit Buyer Loan Extension Request
      description: >-
        <p>Enables a buyer to directly submit a loan extension request.</p>
        <details>
          <summary><strong>View Pre-requisites</strong>:</summary>
          <ol>
            <li>
              <strong>API Connection Profile</strong> has been created.
              <a href="https://develop.hsbc.com/knowledge-article/get-started-corporate-banking-apis#securing-a-connection" target="blank"><sub>What is an API Connection Profile?</sub></a>
              <ol type="i">
                <li>
                  For testing in the <a href="https://develop.hsbc.com/node/813" target="blank">Sandbox Environment</a>, create your test project and API Connection Profile via
                  <a href="https://develop.hsbc.com/dev-hub/user-project-list" target="blank">Dev Hub</a>.<br />
                  <a href="https://develop.hsbc.com/node/813#generating-credentials-via-dev-hub" target="blank"><sub>How to generate test API Connection Profile?</sub></a>
                </li>
              </ol>
            </li>
            <li>Loan applicant possesses valid <strong>transaction account</strong> in <strong>HSBC</strong>.</li>
            <li>Corresponding loan's status is <code>Disbursed</code>.</li>
          </ol>
        </details>
        <details>
          <summary><strong>View Post-conditions</strong>:</summary>
          <ol>
            <li>Corresponding loan <code>status</code> changed to <code>Extension Submitted</code>.</li>
            <li><code>Status</code> will be updated to <code>Disbursed</code> upon the extension is approved, along with the updated <code>loanMaturityDate</code>.</li>
            <li>
              It is possible to perform the following for this loan:
              <ol type="i">
                <li>
                  Enquires <strong>status of this and many other loans</strong> that have been submitted via <code>Request Trade Loan Status API</code>. <a href="#operation/list-trade-loan-status"><sub>View Endpoint</sub></a>
                </li>
                <li>
                  Enquires <strong>details of this loan</strong> of it via <code>Request Trade Loan Details API</code>. <a href="#operation/get-trade-loan-details"><sub>View Endpoint</sub></a>
                </li>
              </ol>
            </li>
          </ol>
        </details>
      operationId: extend-standard-buyer-loans
      security:
      - BearerTokenJWS: []
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/requestTime'
      - $ref: '#/components/parameters/requestId'
      - $ref: '#/components/parameters/countryCode'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/schemaVersion'
      requestBody:
        $ref: '#/components/requestBodies/ExtendTradeLoanRequest'
      responses:
        '200':
          $ref: '#/components/responses/ExtendTradeLoanResponse'
        '400':
          $ref: '#/components/responses/RESPONSE_400_TAAS'
        '401':
          $ref: '#/components/responses/RESPONSE_401_TAAS'
        '403':
          $ref: '#/components/responses/RESPONSE_403_TAAS'
        '404':
          $ref: '#/components/responses/RESPONSE_404_TAAS'
        '500':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '502':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '503':
          $ref: '#/components/responses/RESPONSE_503_TAAS'
  /buyer-loans/standard/settlement:
    post:
      tags:
        - Buyer Loans 
      summary: Submit Buyer Loan Settlement Request          
      description: >-
        <p>Enables a buyer to directly submit a loan settlement request.</p>
        <details>
          <summary> <strong>View Pre-requisites</strong>:</summary>
          <ol>
            <li>
              <strong>API Connection Profile</strong> has been created.
              <a href="https://develop.hsbc.com/knowledge-article/get-started-corporate-banking-apis#securing-a-connection" target="blank">
                <sub>What is an API Connection Profile?</sub>
              </a>
              <ol type="i">
                <li>
                  For testing in the <a href="https://develop.hsbc.com/node/813" target="blank">Sandbox Environment</a>, create your test project and API Connection Profile via
                  <a href="https://develop.hsbc.com/dev-hub/user-project-list" target="blank">Dev Hub</a>.<br />
                  <a href="https://develop.hsbc.com/node/813#generating-credentials-via-dev-hub" target="blank">
                    <sub>How to generate test API Connection Profile?</sub>
                  </a>
                </li>
              </ol>
            </li>
            <li>Loan applicant possesses valid <strong>transaction account</strong> in <strong>HSBC</strong>.</li>
            <li>Corresponding loan is valid for settlement.</li>
          </ol>
        </details>
        <details>
          <summary> <strong>View Post-conditions</strong>:</summary>
          <ol>
            <li>Corresponding loan <code>status</code> changed to <code>Settlement Submitted</code>.</li>
            <li><code>Status</code> will be updated to <code>Disbursed</code> upon the settlement is completed, along with the updated <code>outStadningAmount</code>.</li>
            <li>
              It is possible to perform the following for this loan:
              <ol type="i">
                <li>
                  Enquires <strong>status of this and many other loans</strong> that have been submitted via <code>Request Trade Loan Status API</code>.
                  <a href="#operation/list-trade-loan-status">
                    <sub>View Endpoint</sub>
                  </a>
                </li>
                <li>
                  Enquires <strong>details of this loan</strong> of it via <code>Request Trade Loan Details API</code>.
                  <a href="#operation/get-trade-loan-details">
                    <sub>View Endpoint</sub>
                  </a>
                </li>
              </ol>
            </li>
          </ol>
        </details>
      operationId: settle-standard-buyer-loans
      security:
      - BearerTokenJWS: []
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/requestTime'
      - $ref: '#/components/parameters/requestId'
      - $ref: '#/components/parameters/countryCode'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/schemaVersion'
      requestBody:
        $ref: '#/components/requestBodies/SettleTradeLoanRequest'
      responses:
        '200':
          $ref: '#/components/responses/SettleTradeLoanResponse'
        '400':
          $ref: '#/components/responses/RESPONSE_400_TAAS'
        '401':
          $ref: '#/components/responses/RESPONSE_401_TAAS'
        '403':
          $ref: '#/components/responses/RESPONSE_403_TAAS'
        '404':
          $ref: '#/components/responses/RESPONSE_404_TAAS'
        '500':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '502':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '503':
          $ref: '#/components/responses/RESPONSE_503_TAAS'
  /trade-loans/list:
    post:
      tags:
      - Buyer Loans
      summary: Request Trade Loan Status
      description: >-
        <p>Request a status update on one or many trade loans.</p>
        <details>
          <summary><strong>View Pre-requisites</strong>:</summary>
          <ol>
            <li>
              <strong>API Connection Profile</strong> has been created. <a href="https://develop.hsbc.com/knowledge-article/get-started-corporate-banking-apis#securing-a-connection" target="blank"><sub>What is an API Connection Profile?</sub></a>
              <ol type="i">
                <li>
                  For testing in the <a href="https://develop.hsbc.com/node/813" target="blank">Sandbox Environment</a>, create your test project and API Connection Profile via
                  <a href="https://develop.hsbc.com/dev-hub/user-project-list" target="blank">Dev Hub</a>.<br />
                  <a href="https://develop.hsbc.com/node/813#generating-credentials-via-dev-hub" target="blank"><sub>How to generate test API Connection Profile?</sub></a>
                </li>
              </ol>
            </li>
            <li>Loan applicant possesses valid <strong>transaction account</strong> in <strong>HSBC</strong>.</li>
            <li>Loan requests that have been processed/ updated via following APIs, with corresponding <code>loanNumber</code> generated.
            <ol type="i">
              <li>
                <code>Submit Buyer Loan Application Request API</code>. <a href="#operation/create-standard-buyer-loans"><sub>View Endpoint</sub></a>
              </li>
              <li>
                <code>Submit Buyer Loan Extension Request API</code>. <a href="#operation/extend-standard-buyer-loans"><sub>View Endpoint</sub></a>
              </li>
              <li>
                <code>Submit Buyer Loan Settlement Request API</code>. <a href="#operation/settle-standard-buyer-loans"><sub>View Endpoint</sub></a>
              </li>
            </ol>
            </li>
          </ol>
        </details>
        <details>
          <summary><strong>View Post-conditions</strong>:</summary>
          <ol>
            <li>A list of loans <strong>matches specified filtering criteria</strong> is retrieved.</li>
          </ol>
        </details>
      operationId: list-trade-loan-status
      security:
      - BearerTokenJWS: []
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/requestTime'
      - $ref: '#/components/parameters/requestId'
      - $ref: '#/components/parameters/countryCode'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/schemaVersion'
      requestBody:
        $ref: '#/components/requestBodies/ListTradeLoanStatusRequest'
      responses:
        '200':
          $ref: '#/components/responses/ListTradeLoanStatusResponse'
        '400':
          $ref: '#/components/responses/RESPONSE_400_TAAS'
        '401':
          $ref: '#/components/responses/RESPONSE_401_TAAS'
        '403':
          $ref: '#/components/responses/RESPONSE_403_TAAS'
        '404':
          $ref: '#/components/responses/RESPONSE_404_TAAS'
        '500':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '502':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '503':
          $ref: '#/components/responses/RESPONSE_503_TAAS'
  /trade-loans/detail:
    post:
      tags:
      - Buyer Loans
      summary: Request Trade Loan Details
      description: >-
        <p>Request full details on a specific loan in real-time.</p>
        <details>
          <summary> <strong>View Pre-requisites</strong>:</summary>
          <ol>
            <li>
              <strong>API Connection Profile</strong> has been created.
              <a href="https://develop.hsbc.com/knowledge-article/get-started-corporate-banking-apis#securing-a-connection" target="blank">
                <sub>What is an API Connection Profile?</sub>
              </a>
              <ol type="i">
                <li>
                  For testing in the <a href="https://develop.hsbc.com/node/813" target="blank">Sandbox Environment</a>, create your test project and API Connection Profile via
                  <a href="https://develop.hsbc.com/dev-hub/user-project-list" target="blank">Dev Hub</a>.<br />
                  <a href="https://develop.hsbc.com/node/813#generating-credentials-via-dev-hub" target="blank">
                    <sub>How to generate test API Connection Profile?</sub>
                  </a>
                </li>
              </ol>
            </li>
            <li>Loan applicant possesses valid <strong>transaction account</strong> in <strong>HSBC</strong>.</li>
            <li>Loan requests that have been processed/ updated via following APIs, with corresponding <code>loanNumber</code> generated.
            <ol type="i">
              <li>
                <code>Submit Buyer Loan Application Request API</code>. <a href="#operation/create-standard-buyer-loans"><sub>View Endpoint</sub></a>
              </li>
              <li>
                <code>Submit Buyer Loan Extension Request API</code>. <a href="#operation/extend-standard-buyer-loans"><sub>View Endpoint</sub></a>
              </li>
              <li>
                <code>Submit Buyer Loan Settlement Request API</code>. <a href="#operation/settle-standard-buyer-loans"><sub>View Endpoint</sub></a>
              </li>
            </ol>
            </li>
          </ol>
        </details>
        <details>
          <summary><strong>View Post-conditions</strong>:</summary>
          <ol>
            <li>Details of specified Loan is retrieved.</li>
          </ol>
        </details>
      operationId: get-trade-loan-details
      security:
      - BearerTokenJWS: []
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/requestTime'
      - $ref: '#/components/parameters/requestId'
      - $ref: '#/components/parameters/countryCode'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/schemaVersion'
      requestBody:
        $ref: '#/components/requestBodies/GetTradeLoanDetailRequest'
      responses:
        '200':
          $ref: '#/components/responses/GetTradeLoanDetailResponse'  
        '400':
          $ref: '#/components/responses/RESPONSE_400_TAAS'
        '401':
          $ref: '#/components/responses/RESPONSE_401_TAAS'
        '403':
          $ref: '#/components/responses/RESPONSE_403_TAAS'
        '404':
          $ref: '#/components/responses/RESPONSE_404_TAAS'
        '500':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '502':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '503':
          $ref: '#/components/responses/RESPONSE_503_TAAS'
  /documents:
    post:
      tags:
      - Document Management
      summary: Submit Supporting documents
      description: >-
        <p>Enables an applicant to directly submit one or many supporting documents.
        <details>
            <summary><strong>View Pre-requisites</strong>:</summary>
            <ol>
              <li><strong>API Connection Profile</strong> has been created. <a href="https://develop.hsbc.com/knowledge-article/get-started-corporate-banking-apis#securing-a-connection" target="blank"><sub>What is an API Connection Profile?</sub></a>
              <ol type="i">
                <li>For testing in the <a href="https://develop.hsbc.com/node/813" target="blank">Sandbox Environment</a>, create your test project and API Connection Profile via <a href="https://develop.hsbc.com/dev-hub/user-project-list" target="blank">Dev Hub</a>.<br>
                <a href="https://develop.hsbc.com/node/813#generating-credentials-via-dev-hub" target="blank"><sub>How to generate test API Connection Profile?</sub></a></li>            
              </ol>
              </li>
              <li>Loan applicant possesses valid <strong>transaction account</strong> in <strong>HSBC</strong>.</li>
              </ol>
          </details>
          <details>
            <summary><strong>View Post-conditions</strong>:</summary>
            <ol>
              <li>Supporting documents are being uploaded. Status shall be enquired via <code>Request Supporting Document Status API</code>. <a href="#operation/list-supporting-document-status"><sub>View Endpoint</sub></a></li>
            </ol>
          </details>
      operationId: upload-supporting-documents
      security:
      - BearerTokenJWS: []
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/requestTime'
      - $ref: '#/components/parameters/requestId'
      - $ref: '#/components/parameters/countryCode'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/schemaVersion'
      requestBody:
        $ref: '#/components/requestBodies/UploadSupportingDocumentRequest'
      responses:
        '200':
          $ref: '#/components/responses/UploadSupportingDocumentResponse'
        '400':
          $ref: '#/components/responses/RESPONSE_400_TAAS'
        '401':
          $ref: '#/components/responses/RESPONSE_401_TAAS'
        '403':
          $ref: '#/components/responses/RESPONSE_403_TAAS'
        '404':
          $ref: '#/components/responses/RESPONSE_404_TAAS'
        '500':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '502':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '503':
          $ref: '#/components/responses/RESPONSE_503_TAAS'
  /documents/details:
    post:
      tags:
      - Document Management
      summary: Request Supporting Document Status
      description:  >-
        <p>Request a status update on one or many supporting documents.</p>
          <details>
            <summary><strong>View Pre-requisites</strong>:</summary>
            <ol>
              <li><strong>API Connection Profile</strong> has been created. <a href="https://develop.hsbc.com/knowledge-article/get-started-corporate-banking-apis#securing-a-connection" target="blank"><sub>What is an API Connection Profile?</sub></a>
              <ol type="i">
                <li>For testing in the <a href="https://develop.hsbc.com/node/813" target="blank">Sandbox Environment</a>, create your test project and API Connection Profile via <a href="https://develop.hsbc.com/dev-hub/user-project-list" target="blank">Dev Hub</a>.<br>
                <a href="https://develop.hsbc.com/node/813#generating-credentials-via-dev-hub" target="blank"><sub>How to generate test API Connection Profile?</sub></a></li>            
              </ol>
              </li>
              <li>Supporting documents submitted via <code>Submit Supporting Documents API</code>. <a href="#operation/upload-supporting-documents"><sub>View Endpoint</sub></a>
          </details>
          <details>
            <summary><strong>View Post-conditions</strong>:</summary>
            <ol>
              <li>Document with associated details are responded.</li>
              <li>It is possible to perform the following:
              <ol type="i">
                <li>Submit Loan Application via <code>Submit Buyer Loan Application Request API</code> with the supporting documents information retrieved. <a href="#operation/create-standard-buyer-loan-applications"><sub>View Endpoint</sub></a></li>
              </ol>
              </li>
            </ol>
          </details>
      operationId: list-supporting-document-status
      security:
      - BearerTokenJWS: []
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/requestTime'
      - $ref: '#/components/parameters/requestId'
      - $ref: '#/components/parameters/countryCode'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/schemaVersion'
      requestBody:
        $ref: '#/components/requestBodies/ListSupportingDocumentStatusRequest'
      responses:
        '200':
          $ref: '#/components/responses/ListSupportingDocumentStatusResponse'
        '400':
          $ref: '#/components/responses/RESPONSE_400_TAAS'
        '401':
          $ref: '#/components/responses/RESPONSE_401_TAAS'
        '403':
          $ref: '#/components/responses/RESPONSE_403_TAAS'
        '404':
          $ref: '#/components/responses/RESPONSE_404_TAAS'
        '500':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '502':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '503':
          $ref: '#/components/responses/RESPONSE_503_TAAS'
  /probe/health:
    get:
      tags:
      - Common Services
      summary: Trade Finance API Health Status
      description: Enquire Trade Finance API Health Status
      operationId: get-health
      security:
       - BearerTokenJWS: []
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/requestTime'
      - $ref: '#/components/parameters/requestId'
      - $ref: '#/components/parameters/countryCode'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/schemaVersion'
      responses:
        '200':
          $ref: '#/components/responses/GetHealth_RESPONSE_200_TAAS'
        '400':
          $ref: '#/components/responses/RESPONSE_400_TAAS'
        '401':
          $ref: '#/components/responses/RESPONSE_401_TAAS'
        '403':
          $ref: '#/components/responses/RESPONSE_403_TAAS'
        '404':
          $ref: '#/components/responses/RESPONSE_404_TAAS'
        '500':
          $ref: '#/components/responses/RESPONSE_500_TAAS'
        '503':
          $ref: '#/components/responses/RESPONSE_503_TAAS'
components: 
  schemas:
    BankSwiftCode_TAAS:
      description: Bank swift code (First 8 characters)
      type: string
      minLength: 8
      maxLength: 8
      pattern: ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}$
    ISOCountryCode:
      description: "[ISO 3166 Alpha-2 Country Code](https://www.iso.org/obp/ui/#search)"
      type: string
      maxLength: 2
      pattern: ^$|^(A(D|E|F|G|I|L|M|N|O|R|S|T|Q|U|W|X|Z)|B(A|B|D|E|F|G|H|I|J|L|M|N|O|R|S|T|V|W|Y|Z)|C(A|C|D|F|G|H|I|K|L|M|N|O|R|U|V|X|Y|Z)|D(E|J|K|M|O|Z)|E(C|E|G|H|R|S|T)|F(I|J|K|M|O|R)|G(A|B|D|E|F|G|H|I|L|M|N|P|Q|R|S|T|U|W|Y)|H(K|M|N|R|T|U)|I(D|E|Q|L|M|N|O|R|S|T)|J(E|M|O|P)|K(E|G|H|I|M|N|P|R|W|Y|Z)|L(A|B|C|I|K|R|S|T|U|V|Y)|M(A|C|D|E|F|G|H|K|L|M|N|O|Q|P|R|S|T|U|V|W|X|Y|Z)|N(A|C|E|F|G|I|L|O|P|R|U|Z)|OM|P(A|E|F|G|H|K|L|M|N|R|S|T|W|Y)|QA|R(E|O|S|U|W)|S(A|B|C|D|E|G|H|I|J|K|L|M|N|O|R|T|V|Y|Z)|T(C|D|F|G|H|J|K|L|M|N|O|R|T|V|W|Z)|U(A|G|M|S|Y|Z)|V(A|C|E|G|I|N|U)|W(F|S)|Y(E|T)|Z(A|M|W))$
    ISOCurrencyCode:
      description: "[ISO 4217 Currency Code](https://en.wikipedia.org/wiki/ISO_4217)"
      type: string
      maxLength: 3
      pattern: ^$|^(?:AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|UYI|UYU|UYW|UZS|VES|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XOF|XPD|XPF|XPT|XSU|XTS|XUA|XXX|YER|ZAR|ZMW|ZWL)$    
    ISODate:
      description: "Full-date notation as defined by RFC 3339, section 5.6"
      type: string
      format: date
    ISODateTime:
      description: "The date-time notation as defined by RFC 3339, section 5.6"
      type: string
      format: date-time
    ISOEmail:
      description: "Email Address"
      type: string
      maxLength: 255
      format: email
    ISOHostName:
      description: "Host name"
      type: string
      maxLength: 255
      format: hostname
    ISOIpv4:
      description: "IP Address v4"
      type: string
      maxLength: 255
      format: ipv4
    ISOIpv6:
      description: "IP Address v6"
      type: string
      maxLength: 255
      format: ipv6
    ISOUri:
      description: "Resource URI"
      type: string
      maxLength: 255
      format: uri
    ISOUuid:
      description: >
        [Universal Unique Identifier] (https://en.wikipedia.org/wiki/Universally_unique_identifier)
      type: string
      format: uuid
    Date_TAAS:
      description: "Date, UTC, (YYYY-MM-DD)" 
      type: string
      maxLength: 10
      pattern: ^$|^202[0-9]{1}-(((0[13578]|(10|12))-(0[1-9]|[1-2][0-9]|3[0-1]))|(02-(0[1-9]|[1-2][0-9]))|((0[469]|11)-(0[1-9]|[1-2][0-9]|30)))$
    AddtionalRemark_TAAS:
      description: "Additional Remark"
      type: string
      maxLength: 100
      example: "Something"
    DateTime_TAAS:
      description: "DateTime, UTC, (YYYY-MM-DD hh:mm:ss)"
      type: string
      minLength: 19
      maxLength: 19
      pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) (2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]$   
    DateTime_TAAS_OPT:
      oneOf:
      - $ref: '#/components/schemas/DateTime_TAAS'
      - $ref: '#/components/schemas/EmptyString_TAAS'
    CustomerReference_TAAS:
      description: >-
        Reference number for tracing of transactions, specified by customer or generate by partner's platform, if required.
      type: string
      maxLength: 30
      example: CRHK230101_01
    EmptyArray_TAAS:
      description: "Accepts empty array"
      type: array
      maxItems: 0
      items:
        type: string
    EmptyString_TAAS:
      description: '.'
      type: string
      minLength: 0
      pattern: ^$
      enum: 
      - ''
    EmptyEnum_TAAS:
      type: string
      minLength: 0
      enum:
      - ''
    ExtnlCustomerId_TAAS:      
      description: >-
        Your customer's id on your platform, used for [**authorisation**](#authorisation).
        <details>
          <ol>
            <li>If you are making the request <strong>on-behalf</strong> of your customer, specify your customer's id on your platform.</li>
            <li>If you are making the request as a <strong>direct client</strong>, specify the <code>HSBC Profile ID</code> assigned by HSBC during on-boarding.
              <ol type="i">
              <li>
                <strong>Note for sandbox testers</strong>:
                <p>To perform testing on Sandbox Environment, specify the <strong>HSBC Profile ID</strong> you retrieved from the dev hub project</p>
              </li>
              </ol>
            </li>
        </details>
      type: string
      minLength: 1
      maxLength: 255      
      example: "PLT-CUSTID-001"
    AccountNumberIBAN:
      type: string
      description: Account number of the Bank
      maxLength: 35
      pattern: ^([A-Z]{2}[ \-]?[0-9]{2})(?=(?:[ \-]?[A-Z0-9]){9,30}$)((?:[ \-]?[A-Z0-9]{3,5}){2,7})([ \-]?[A-Z0-9]{1,3})?$
    FaxNumber_TAAS:
      description: "Fax Number"
      type: string
      maxLength: 255
      pattern: ^$|^[\+]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$
    Amount_HUB:
      description: "Numeric string, maximum 9 integer with optional decimal up to 3 places."
      type: string  
      maxLength: 15
      pattern: ^$|^(0|[1-9]\d{0,10})(\.\d{1,3})?$
      example: '1000.00'
    Amount_TRADE_TRACKER:      
      description: "Numeric string, maximum 17 integer with optional decimal up to 3 places."
      type: string
      minLength: 1
      maxLength: 20
      pattern: ^(([1-9]\d{0,16})|([1-9]\d{0,16}\.\d)|([1-9]\d{0,16}\.\d{2})|([1-9]\d{0,16}\.\d{3})|(0\.\d{2}[1-9])|(0\.\d[1-9])|(0\.[1-9]))$      
    MiscStates_TAAS:
      description: >-
        Leave **blank** unless other additional information needs to be specified. Must be in `stringify JSON`.
      type: string
      minLength: 0
      maxLength: 4000
      example: "{\"additionalInfo\":\"something\"}"
    Percentage_TAAS:
      description: "Percentage, 2 decimal places."
      type: string
      pattern: ^(0|[1-9]\d{0,1})(\.\d{1,3})?([%])$
    PhoneNumber_TAAS:
      description: "Phone Number"
      type: string
      maxLength: 255
      pattern: ^$|^[\+]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$
    TradeAccountNumber_TAAS:
      description: >-
        **HSBC** Trade Account Number of the customer (corporate).
        
          <details>
            <summary>Note for sandbox testers:</summary>
            You may specify any account number which matches the specified <code>string pattern</code>.
          </details>
      type: string
      minLength: 18
      maxLength: 18
      pattern: ^([A-Z ]{6})([0-9]{12})$
      example: 'SGHSBC123456789123'
    TradeAccountNumbers_TAAS:
      description: "List of HSBC Trade Account Number of the customer (corporate)."
      type: array
      maxItems: 10
      items:
        allOf:
        - $ref: '#/components/schemas/TradeAccountNumber_TAAS'
        - minLength: 0
    TradeDcn_TAAS:
      description: "HSBC Domestic Customer Number of the customer (corporate)."
      type: string
      minLength: 15
      maxLength: 15
      pattern: ^$|^([A-Z ]{6})([0-9]{9})$
      example: 'HKHSBC123456789'
    Uuid_TAAS:
      title: Uuid_TAAS
      description: "[UUID](https://www.rfc-editor.org/rfc/rfc4122#section-4) without hyphen"
      type: string
      maxLength: 32
      pattern: ^[0-9a-fA-F]{8}[0-9a-fA-F]{4}[0-9a-fA-F]{4}[0-9a-fA-F]{4}[0-9a-fA-F]{12}$
      example: "efbf054e8f9c477493bfb3d2a19781b2"
    FileId_FileNet:
      description: 'Document id, returned by File Net. Doc id for the file upload to HSBC'
      type: string
      minLength: 40
      maxLength: 40
      pattern: ^[a-zA-Z]{3}_[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
      example: 'idd_10349C86-0000-C515-AB9B-65B893B9744B'
    EncryptedAndBase64Encoded_TAAS:
      description: >-
        Message body you **send** to/ **receive** from the `endpoint`. It is a `base64` encoded `string` consists of content **encrypted** by `Public Key` of the receiver. <a href="https://develop.hsbc.com/node/668"><sub>How to perform message level en/ decryption?</sub>.</a>
      type: string
      format: byte
      example: LS0tLS1CRUdJTiBQR1AgTUVTU0FHRS0t...
    GetHealth_RESPONSE_200_TAAS:
      allOf:
      - $ref: '#/components/schemas/RESPONSE_200_TAAS'   
    PaginationModel_TAAS:
      required:
      - pageNumber
      - pageSize
      type: object
      properties:
        pageSize:
          type: string
          description: "Number of records to return per page. (1-1000)"
          minLength: 1
          maxLength: 4
          pattern: ^([1-9]|[1-9][0-9]{1,2}|1000)$
          example: 10
        pageNumber:
          type: string
          description: "Page index of the first record to return. (1-1000000000)"
          minLength: 1
          maxLength: 10
          pattern: ^([1-9]|[1-9][0-9]{1,8}|1000000000)$
          example: 1
    LIST_MODEL_REQUEST_TAAS:
      allOf:
      - $ref: '#/components/schemas/PaginationModel_TAAS'
      - required:
        - extnlCustomerId
        type: object
        properties:
          extnlCustomerId:
            allOf:
            - minLength: 1
            - $ref: '#/components/schemas/ExtnlCustomerId_TAAS' 
    LIST_MODEL_WITH_DATE_TIME_FILTER_REQUEST_TAAS:
      allOf:
      - $ref: '#/components/schemas/LIST_MODEL_RESPONSE_TAAS'
      - $ref: '#/components/schemas/DATE_TIME_FILTER_MODEL'
    UploadSupportingDocumentRequest:
      required:
      - attachDocument
      type: object
      properties:
        attachDocument:
          description: >-
            Document the client want to upload to HSBC.
            <details>
              <summary>Formats supported:</summary>
              <ol>
                <li>Total size of all uploaded documents less than `30MB`.</li>
                <li>Support document type: bmp, doc, docx, gif, htm, html, jpeg, jpg, msg, odp, ods, odt, oxps, pdf, png, ppt, pptx, rtf, tif, tiff, txt, vsd, xls, xlsx, xps, zip.</li>
              </ol>
            </details>
          type: array
          minItems: 1
          maxItems: 2
          items:
            type: string
            format: binary
            example: '"\C":"\test.tiff'
    ListSupportingDocumentStatusRequest:
      allOf:
      - $ref: '#/components/schemas/DocumentListModel'
      - type: object
        properties:
          attachDocument:
            readOnly: true
    LIST_MODEL_RESPONSE_TAAS:
      required:
      - totalCount
      allOf:
      - type: object
        properties:
          totalCount:
            type: string
            minLength: 1
            maxLength: 255
            pattern: ^\d{1,255}$
            description: Total number of records returned.
            example: "3"
      - $ref: '#/components/schemas/PaginationModel_TAAS'
    DATE_TIME_FILTER_MODEL:
      required:
      - startDateAndTime
      - endDateAndTime
      type: object
      properties:
        startDateAndTime:
          description: "Start DateTime of filtering range."
          allOf:
          - minLength: 0
          - $ref: '#/components/schemas/DateTime_TAAS'
        endDateAndTime:
          description: "End DateTime of filtering range."        
          allOf:
          - minLength: 0
          - $ref: '#/components/schemas/DateTime_TAAS'
    RESPONSE_200_TAAS:
      required:
      - code
      - message
      - repliedTime
      - correlationId
      - responseData
      - errorDetails
      type: object
      properties:
        code:
          description: "HSBC Trade-Finance API Response Code."
          type: string
          minLength: 7
          maxLength: 7
          enum:
          - "EMKT102"
          - "EMKT103"
          - "EMKT105"
          - "EMKT106"
          - "EMKT107"
          - "EMKT123"
          - "EMKT200"
          - "EMKT400"
          default: "EMKT200"
          example: "EMKT200"
        message:
          type: string
          description: HSBC Trade-Finance API Response Message.
          minLength: 1
          maxLength: 255
          enum:
          - "INTERNAL_SERVER_ERROR"
          - "DECRYPTION FAILURE"
          - "Authentication check failed!"
          - "GATEWAY_TIMEOUT"
          - "Bad request payload"
          - "Success"
          default: "Success"
          example: "Success"
        repliedTime:
          allOf:
          - $ref: '#/components/schemas/DateTime_TAAS'
          description: "Time-stamp of HSBC Trade-Finance API responses."
          example: "2023-04-01 00:00:43"
        correlationId:
          allOf:
          - $ref: '#/components/schemas/Uuid_TAAS'
          - minLength: 32
          nullable: true
          description: "UUID of the response instance."
        responseData:
          description: "Key Information responded from bank are contained in this object."
          type: object
          nullable: true
        errorDetails:
          description: "List of errors and details responded from bank."
          type: array
          nullable: true
          default: null
          items: 
            $ref: '#/components/schemas/RESPONSE_200_TAAS_ERRORS'
    RESPONSE_200_TAAS_ERRORS:
      type: object
      required:
      - code
      - message
      properties:
        code:
          description: "Fulfilment error codes."
          type: string
          pattern: ^EMKT(102|103|105|106|107|123|400)-(\d{3})$
          enum:
          - 'EMKT102'
          - 'EMKT103'
          - 'EMKT105'
          - 'EMKT106'
          - 'EMKT107'
          - 'EMKT111'
          - 'EMKT123'
          - 'EMKT400'
        message:
          type: string
          description: "Fulfilment error descriptions."
          maxLength: 255
          enum:
          - 'INTERNAL_SERVER_ERROR'
          - 'Capture a Non-MKT error!'
          - 'DECRYPTION_FAILURE'
          - 'Internal exchange failed!'
          - 'GATEWAY_TIMEOUT'
          - 'Unsupported Media Type'
          - 'Bad request payload'
          example: "The extnlCustomerId must not be blank."

    LoanEntityContactText:
      type: string
      maxLength: 31
      description: Address Line Text
      example: 'Address Line 1'
    LoanCurrency:
      allOf:
      - $ref: '#/components/schemas/ISOCurrencyCode'
      description: 'Currency of loan.'
      example: 'SGD'
    LoanAmountLoanCurrency:
      allOf:
      - $ref: '#/components/schemas/Amount_HUB'
      description: >-
        **Net Loan Amount** to borrow, in `loanCurrency`
      example: '1000.00'
    LoanAmountInPaymentCurrency:
      allOf:
      - $ref: '#/components/schemas/LoanAmountLoanCurrency'
    SellerOrderCurrency:
      allOf:
      - $ref: '#/components/schemas/ISOCurrencyCode'
      description: >-
        Currency used in **seller's orders/ invoices/ supporting documents**.
      example: 'USD'
    SellerOrderAmount:
      allOf:
      - $ref: '#/components/schemas/Amount_HUB'
      description: >-
        Amount in Currency used in **seller's orders/ invoices/ supporting documents**
      example: '750.00'
    LoanRepaymentAmount:
      allOf:
      - $ref: '#/components/schemas/Amount_HUB'
      description: >-
        Amount to be settled, in `loanCurrency`.
      example: '750.00'
    LoanEntityName:
      type: string
      maxLength: 35
      description: 'Name of Entity.'
      example: Corporate Ltd.
    BuyerName:
      allOf:
      - $ref: '#/components/schemas/LoanEntityName'
      description: 'Name of buyer.'
      example: 'BUY-US001 Holdings Plc.'
    BuyerCountry:
      allOf:
      - $ref: '#/components/schemas/ISOCountryCode'
      description: 'Country Code of buyer.'
      example: 'US'
    BuyerAddressLine1:
      allOf:
      - $ref: '#/components/schemas/LoanEntityContactText'
      description: 'Address line 1 of buyer.'
      example: 'BUY-US001 Tower #01-01'
    BuyerAddressLine2:
      allOf:
      - $ref: '#/components/schemas/LoanEntityContactText'
      description: 'Address line 2 of buyer. .'
      example: '1 BUY-US001 Street'
    BuyerAddressLine3:
      allOf:
      - $ref: '#/components/schemas/LoanEntityContactText'
      description: 'Address line 3 of buyer. .'
      example: 'USA'
    BeneficiaryName:
      allOf:
      - $ref: '#/components/schemas/LoanEntityName'
      description: 'Name of beneficiary'
      example: 'BEN-SG001 Holdings Plc.'
    BeneficiaryReferenceNumber:
      type: string
      maxLength: 255
      description: 'Reference Number of beneficiary.'
      example: '12232322'
    BeneficiaryCountry:
      allOf:
      - $ref: '#/components/schemas/ISOCountryCode'
      description: 'Country/ market of beneficiary.'
      example: 'SG'
    BeneficiaryAddressLine1:
      allOf:
      - $ref: '#/components/schemas/LoanEntityContactText'
      description: 'Address line 1 of beneficiary.'
      example: 'BEN-SG001 Tower #01-01'
    BeneficiaryAddressLine2:
      allOf:
      - $ref: '#/components/schemas/LoanEntityContactText'
      description: 'Address line 2 of beneficiary. .'
      example: '1 BEN-SG001 Street'
    BeneficiaryAddressLine3:
      allOf:
      - $ref: '#/components/schemas/LoanEntityContactText'
      description: 'Address line 3 of beneficiary. .'
      example: 'SINGAPORE 12345'
    BeneficiaryBankAccount:
      type: string
      maxLength: 34
      description: 'Bank account of beneficiary.'
      example: AC-BEN-SG001
    BeneficiaryBankName:
      allOf:
      - $ref: '#/components/schemas/LoanEntityName'
      description: "Name of beneficiary's bank."
      example: 'BANK-SG001 Holdings Plc.'
    BeneficiaryBankBranchName:
      type: string
      maxLength: 35
      example: ''
    BeneficiaryBankCountry:
      allOf:
      - $ref: '#/components/schemas/ISOCountryCode'
      description: "Country Code of beneficiary's bank."
      example: 'SG'
    BeneficiaryBankAddressLine1:
      allOf:
      - $ref: '#/components/schemas/LoanEntityContactText'
      description: "Address line 1 of beneficiary's bank."
      example: 'BANK-SG001 Tower #01-01'
    BeneficiaryBankAddressLine2:
      allOf:
      - $ref: '#/components/schemas/LoanEntityContactText'
      description: "Address line 2 of beneficiary's bank. ."
      example: '1 BANK-SG001 Street'
    BeneficiaryBankAddressLine3:
      allOf:
      - $ref: '#/components/schemas/LoanEntityContactText'
      description: "Address line 3 of beneficiary's bank. ."
      example: 'SINGAPORE 12345'
    BeneficiaryBankSwiftBicBranchCode:
      allOf:
      - $ref: '#/components/schemas/LoanEntityBankSwiftBicBranchCode'
      description: >-
        `branch`/ `BIC` / `SWIFT` code of beneficiary's bank.
      example: 'HSBCSGS2001'
    LoanEntityBankSwiftBicBranchCode:
      type: string
      minLength: 8
      maxLength: 11
      pattern: ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}(?:[0-9]{3})?$
      description: >-
        `branch`/ `BIC` / `SWIFT` code of bank.
      example: 'HSBCHKH2001'
    LoanInterestCalculationPreference:
      type: string
      maxLength: 1
      enum:
        - 'S'
        - 'N'
        - 'D'
        - 'W'
        - 'M'
        - ''
      default: ''
      description: >- 
        Interest calculation preference.  
        
        Possible values: 
          - `S`: **Reset-Half-yearly**
          - `N`: **Fixed**
          - `D`: **Floating**
          - `W`: **Reset-Weekly**
          - `M`: **Reset-Monthly**
    LoanInterestCollectionFrequency:
      type: string
      maxLength: 1
      enum:
        - 'S'
        - 'W'
        - 'A'
        - 'Q'
        - 'Y'
        - ''
      default: ''
      description: >-
        Interest collection frequency.
        
        Possible values: 
          - `S`: **Half-yearly**
          - `W`: **Weekly**
          - `A`: **Monthly**
          - `Q`: **Quarterly**
          - `Y`: **Yearly**
    LoanOutstandingAmount:
      allOf:
        - $ref: '#/components/schemas/Amount_HUB'
      description: >-
        `outStadningAmount` = **Net Loan Amount** - sum of `repaymentAmount`.
      example: '750.00'
    LoanTypeOfGoods:
      type: string
      maxLength: 8
      enum:
      - 'GOODS'
      - 'SERVICES'
      - 'EXPENSES'
      description: >-
        Type of goods.
        
        Possible values are `GOODS`, `SERVICE` and `EXPENSES`.
    LoanRepaymentAccount:
      type: string
      maxLength: 255
      description: Loan repayment Account
      example: 'SGHSBC123456789123'
    LoanInterestRepaymentAccount:
      allOf:
      - $ref: '#/components/schemas/LoanRepaymentAccount'
      description: >-
        Bank account number used to pay interest.
      example: 'SGHSBC123456789123'
    LoanChargesRepaymentAccount:
      allOf:
      - $ref: '#/components/schemas/LoanRepaymentAccount'
      description: >-
        Bank account number used to pay charges. Must be the same as `interestRepaymentAccount`.
      example: 'SGHSBC123456789123'
    TradeLoanDataModel:
      allOf:
      - required:
        - extnlCustomerId
        - tradeAccountNumber
        - customerReference
        - applicationId
        - productType
        - typeOfGoods
        - goodsShipped
        - invoiceNumberBillReference
        - loanStartDate
        - tenor
        - loanExtensionTenor
        - loanMaturityDate
        - loanExtensionMaturityDate
        - reasonForLoanExtension
        - loanCurrency
        - repaymentDate
        - paymentCurrency
        - paymentAmount
        - repaymentAmount
        - totalSupportingDocumentCurrency
        - totalSupportingDocumentAmount
        - shortFallCurrency
        - shortFallAmount
        - shortFallDebitAccount
        - status
        - loanAmount
        - loanAmountLoanCurrency
        - loanAmountInPaymentCurrency
        - outstandingCurrency
        - outstandingAmount
        - loanAmountOutstanding
        - totalInterestPaid
        - interestOutstanding
        - fixedOrVariableRateLoan
        - currentInterestRate
        - interestCalculationPreferenceCode
        - interestCollectionFrequencyCode
        - interestCalculationPreference
        - interestCollectionFrequency
        - loanRepaymentAccount
        - interestRepaymentAccount
        - interestAccountNumber
        - repaymentAccountNumber
        - chargesRepaymentAccount
        - chargesAccountNumber
        - goodsDescription
        - buyerDetails
        - beneficiaryName
        - beneficiaryDetails
        - paymentDetails
        - applicationOfFunds
        - foreignExchangeDetails
        - instructionsToBank
        - supportingDocuments
        - miscStates
        - creationDateAndTime
        - dateRecorded
        type: object
        properties:
          extnlCustomerId:
            allOf:
            - $ref: '#/components/schemas/ExtnlCustomerId_TAAS'
            writeOnly: true
          tradeAccountNumber:
            allOf:
            - $ref: '#/components/schemas/TradeAccountNumber_TAAS'
            example: 'SGHSBC123456789123'
          productType:
            type: string
            minLength: 10
            maxLength: 11
            enum:
            - Buyer Loan
            - Seller Loan
            description: Loan product type, include two values seller loan, Seller Loan
            readOnly: true
          loanNumber:
            type: string
            description: Loan Number
            maxLength: 255
            example: 'LNSG23040102'
          applicationId:
            type: string
            maxLength: 30
            description: application ID, generated by HSBC system
            example: 46338647WB6V
          beneficiaryName:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryName'
          customerReference:
            allOf:
            - $ref: '#/components/schemas/CustomerReference_TAAS'
            - minLength: 0
            example: 'CRSG23040101'
          status:
            description: "Status of Loan."
            type: string
            maxLength: 20
            enum:
              - 'Submitted'
              - 'Cancelled'
              - 'Disbursed'
              - 'Extension Submitted'
              - 'Settlement Submitted'
              - 'Settled'
              - ''
          typeOfGoods:
            allOf:
            - $ref: '#/components/schemas/LoanTypeOfGoods'
          goodsShipped:
            type: string
            minLength: 1
            maxLength: 1
            enum:
            - Y
            - N
            description: Ship the Goods or not.
            example: Y
            writeOnly: true
          invoiceNumberBillReference:
            description: Invoice number or bill reference
            type: string
            minLength: 0
            maxLength: 255
            example: '81921021'
            writeOnly: true
          loanStartDate:
            allOf:
            - $ref: '#/components/schemas/Date_TAAS'
            description: Loan Start Date
            example: '2023-04-01'
          tenor:
            type: string
            minLength: 1
            maxLength: 3
            pattern: ^([1-9]|[1-9][0-9]|[12][0-9]{2}|3[0-5][0-9]|360)$
            example: '30'
            description: >- 
              Tenor days, only allow number from `1` to `360`.
          loanMaturityDate:
            allOf:
            - $ref: '#/components/schemas/Date_TAAS'
            description: >-
              Loan due date. If this value is not specified, system shall calculate the `loanMaturityDate` by `loanStartDate` + `tenor`.
            example: '2023-04-30'
          loanExtensionTenor:
            type: string
            description: >-
              To-be tenor days. (Up to `999`)
            minLength: 1
            maxLength: 3
            pattern: ^([1-9]|[1-9][0-9]{1,2})$
            example: '30'
            writeOnly: true
          loanExtensionMaturityDate: 
            allOf:
            - $ref: '#/components/schemas/Date_TAAS'
            - writeOnly: true
            - minLength: 0
            description:  >-
              Loan due date after extension. If this value is not specified, system shall caculate the `loanMaturityDate` by `loanStartDate` + `loanExtensionTenor`.
            example: '2023-04-30'
          reasonForLoanExtension:           
            type: string
            minLength: 1
            maxLength: 255
            writeOnly: true           
            example: 'extend loan date'
          repaymentDate: 
            allOf:
            - $ref: '#/components/schemas/Date_TAAS'
            description: Loan Repayment date
            example: '2023-03-30'
          paymentCurrency:
            allOf:
            - $ref: '#/components/schemas/SellerOrderCurrency'
          paymentAmount:
            allOf:
            - $ref: '#/components/schemas/SellerOrderAmount'
          repaymentAmount:
            allOf:
            - $ref: '#/components/schemas/LoanRepaymentAmount'
            - writeOnly: true
          loanAmountInPaymentCurrency:
            allOf:
            - $ref: '#/components/schemas/LoanAmountInPaymentCurrency'
          totalSupportingDocumentCurrency:
            allOf: 
            - $ref: '#/components/schemas/SellerOrderCurrency'
            - writeOnly: true
            description: >-
              Currency of payment, can be different with `loanCurrency`.
          totalSupportingDocumentAmount:
            allOf:
            - $ref: '#/components/schemas/LoanRepaymentAmount'
            - writeOnly: true
          loanCurrency:
            allOf:
            - $ref: '#/components/schemas/LoanCurrency'
          shortFallCurrency:
            allOf:
            - $ref: '#/components/schemas/SellerOrderCurrency'
            - minLength: 0
            - writeOnly: true
            description: >-
              Same currency as `paymentCurrency`. **Must not be empty** if `shortFallAmount` **=/=** `0`.
            example: ''
          shortFallAmount:
            allOf:
            - $ref: '#/components/schemas/Amount_HUB'
            - minLength: 0
            - writeOnly: true
            description: >-
              Shortfall amount, i.e.`paymentAmount` - `loanAmountInPaymentCurrency`. **Must not be empty** if this value **=/=** `0`.
            example: ''
          shortFallDebitAccount:
            description: >-
              Debit account to cover shortfall. **Must not be empty** if `shortFallAmount` **=/=** `0`.
            type: string
            minLength: 1
            maxLength: 255
            example: ''
            writeOnly: true
          loanAmount:
            allOf:
            - $ref: '#/components/schemas/LoanAmountLoanCurrency'
            - writeOnly: true
          loanAmountLoanCurrency:
            allOf:
            - $ref: '#/components/schemas/LoanAmountLoanCurrency'
          outstandingCurrency:
            allOf:
            - $ref: '#/components/schemas/LoanCurrency'
            - readOnly: true
          outstandingAmount:
            allOf:
            - $ref: '#/components/schemas/LoanOutstandingAmount'
            nullable: true
            readOnly: true
          loanAmountOutstanding:
            allOf:
            - $ref: '#/components/schemas/LoanOutstandingAmount'
            nullable: true
            example: '0.00'
            readOnly: true
          currentInterestRate:
            allOf:
            - $ref: '#/components/schemas/Percentage_TAAS'
            description: Current interest rate 
            readOnly: true
          fixedOrVariableRateLoan:
            type: string
            enum:
            - Fixed
            - Variable
            description: Fixed or Variable Rate for the loan
            example: Fixed
            readOnly: true
          interestOutstanding:
            allOf:
            - $ref: '#/components/schemas/Amount_HUB'
            - readOnly: true
          totalInterestPaid:
            type: string
            pattern: ^(AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTN|BWP|BYN|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|UYI|UYU|UYW|UZS|VES|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XOF|XPD|XPF|XPT|XSU|XTS|XUA|XXX|YER|ZAR|ZMW|ZWL) (0|[1-9]\d{0,10})(\.\d{1,3})?$
            description: 'Total paid interest '
            readOnly: true
            example: 'SGD 0.00'
          interestCalculationPreferenceCode:
            allOf:
            - $ref: '#/components/schemas/LoanInterestCalculationPreference'
            - minLength: 0
          interestCollectionFrequencyCode:
            allOf:
            - $ref: '#/components/schemas/LoanInterestCollectionFrequency'
            - minLength: 0
          interestCalculationPreference:
            allOf:
            - $ref: '#/components/schemas/LoanInterestCalculationPreference'
            - minLength: 0
            - readOnly: true
          interestCollectionFrequency:
            allOf:
            - $ref: '#/components/schemas/LoanInterestCollectionFrequency'
            - minLength: 0
            - readOnly: true
          loanRepaymentAccount:
            allOf:
            - $ref: '#/components/schemas/LoanRepaymentAccount'
            - minLength: 0
            example: ''
          repaymentAccountNumber:
            allOf:
            - $ref: '#/components/schemas/LoanRepaymentAccount'
            - writeOnly: true
            example: 'SGHSBC123456789123'
          interestRepaymentAccount:
            allOf:
            - $ref: '#/components/schemas/LoanInterestRepaymentAccount'
          interestAccountNumber:
            allOf:
            - $ref: '#/components/schemas/LoanInterestRepaymentAccount'
          chargesRepaymentAccount:
            allOf:
            - $ref: '#/components/schemas/LoanChargesRepaymentAccount'
          chargesAccountNumber:
            allOf:
            - $ref: '#/components/schemas/LoanChargesRepaymentAccount'
          goodsDescription:
            maxLength: 34
            minLength: 1
            type: string
            description: Description of the goods
            example: T-shirt
          buyerDetails:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/BuyerDetailModel'
          beneficiaryDetails:
            type: array
            minItems: 1
            items:
              allOf:
              - $ref: '#/components/schemas/BeneficiaryDetailModel'
          paymentDetails:
            allOf:
            - $ref: '#/components/schemas/PaymentDetailModel'
            writeOnly: true
          applicationOfFunds:
            type: array
            minItems: 0
            items:
              $ref: '#/components/schemas/FundApplicationModel'
            writeOnly: true
          foreignExchangeDetails:
            type: array
            minItems: 0
            items:
              $ref: '#/components/schemas/ForeignExchangeDetailsModel'
            writeOnly: true
          invoiceDetail:
              type: array
              minItems: 0
              items:
                $ref: '#/components/schemas/InvoiceDetailModel'
          supportingDocuments:
            description: >-
              <p>Specify documents that have been submitted prior to your application. Supports <strong>multiple</strong> documents.</p>
              <details>
                <summary>Details of supporting documents</summary>
                <ol>
                  <li>
                    Required only if you have submitted supporting documents for this loan application via <code>Submit Supporting Documents API</code>. <a href="#operation/upload-supporting-documents"><sub>View Endpoint</sub></a>.
                  </li>
                  <li>
                    <code>docId</code> and <code>documentName</code> can be retrieved from <code>Request Supporting Document Status API</code>. <a href="#operation/list-supporting-document-status"><sub>View Endpoint</sub></a>.
                  </li>
                </ol>
              </details>
            type: array
            minItems: 0
            items:
              $ref: '#/components/schemas/SupportingDocumentModel'
            writeOnly: true
            nullable: true
          instructionsToBank:
            type: string
            minLength: 0
            maxLength: 255
            example: "message for your bank"
            writeOnly: true
          miscStates:
            allOf:
            - $ref: '#/components/schemas/MiscStates_TAAS'
            - minLength: 0
            - writeOnly: true
          dateRecorded:
            allOf:
            - $ref: '#/components/schemas/Date_TAAS'
            - readOnly: true
            example: '2023-03-01'
          creationDateAndTime:
            allOf:
            - $ref: '#/components/schemas/DateTime_TAAS'
            - readOnly: true
            example: ''
    CreateBuyerLoanRequest:
      allOf:
      - $ref: '#/components/schemas/TradeLoanDataModel'
      - type: object
        properties:
          loanNumber:
            minLength: 0
          customerReference:
            minLength: 0
          loanStartDate:
            minLength: 0
          paymentCurrency:
            minLength: 3
          paymentAmount:
            minLength: 1
          loanCurrency:
            minLength: 3
          beneficiaryName:
            readOnly: true
          loanAmount:
            readOnly: true
          loanAmountInPaymentCurrency:
            minLength: 1
          interestRepaymentAccount:
            minLength: 1
          chargesRepaymentAccount:
            minLength: 1
          totalSupportingDocumentCurrency:
            readOnly: true
          totalSupportingDocumentAmount:
            readOnly: true
          status:
            readOnly: true
          applicationId:
            readOnly: true
          loanExtensionTenor:
            readOnly: true
          loanMaturityDate:
            minLength: 0
          loanExtensionMaturityDate:
            readOnly: true
          reasonForLoanExtension:
            readOnly: true
          repaymentDate:
            readOnly: true
          repaymentAmount:
            readOnly: true
          shortFallCurrency:
            minLength: 0
          shortFallAmount:
            minLength: 0
          shortFallDebitAccount:
            minLength: 0
          outstandingCurrency:
            readOnly: true
          interestAccountNumber:
            readOnly: true
          repaymentAccountNumber:
            readOnly: true
          chargesAccountNumber:
            readOnly: true
          loanAmountInLoanCurrency:
            readOnly: true
          interestCalculationPreference:
            readOnly: true
          interestCollectionFrequency:
            readOnly: true
          beneficiaryDetails:
            readOnly: true
          buyerDetails:
            readOnly: true
          paymentDetails:
            readOnly: true
          applicationOfFunds:
            readOnly: true
          foreignExchangeDetails:
            readOnly: true
          invoiceDetail:
            readOnly: true
    UpdateLoanRequest:
      allOf:
      - $ref: '#/components/schemas/TradeLoanDataModel'
      - required:
        - loanNumber
        properties:  
          productType:
            readOnly: true
          typeOfGoods:
            readOnly: true
          goodsShipped:
            readOnly: true
          invoiceNumberBillReference:
            readOnly: true          
          loanAmount:
            readOnly: true          
          supportingDocuments:
            readOnly: true 
          loanStartDate:
            readOnly: true
          tenor:
            readOnly: true
          loanMaturityDate:
            readOnly: true
          paymentCurrency:
            readOnly: true
          paymentAmount:
            readOnly: true
          loanAmountInPaymentCurrency:
            readOnly: true
          loanCurrency:
            readOnly: true
          loanAmountLoanCurrency:
            readOnly: true
          outstandingCurrency:
            readOnly: true
          outstandingAmount:
            readOnly: true
          creationDateAndTime:
            readOnly: true
          totalSupportingDocumentCurrency:
            readOnly: true
          totalSupportingDocumentAmount:
            readOnly: true
          shortFallCurrency:
            readOnly: true
          shortFallAmount: 
            readOnly: true
          shortFallDebitAccount:
            readOnly: true
          loanAmountOutstanding:
            readOnly: true
          totalInterestPaid:
            readOnly: true
          interestOutstanding:
            readOnly: true
          fixedOrVariableRateLoan:
            readOnly: true
          currentInterestRate:
            readOnly: true
          interestCalculationPreferenceCode:
            readOnly: true
          interestCollectionFrequencyCode:
            readOnly: true
          interestCalculationPreference:
            readOnly: true
          interestCollectionFrequency:
            readOnly: true
          loanRepaymentAccount:
            readOnly: true
          interestRepaymentAccount:
            readOnly: true
          chargesRepaymentAccount:
            readOnly: true
          goodsDescription:
            readOnly: true
          buyerDetails:
            readOnly: true
          paymentDetails:
            readOnly: true
          beneficiaryDetail:
            readOnly: true
          beneficiaryDetails:
            readOnly: true
          applicationOfFunds:
            readOnly: true
          foreignExchangeDetails:
            readOnly: true
          invoiceDetail:
            readOnly: true
    UpdateLoanResponse:
      allOf:
      - $ref: '#/components/schemas/TradeLoanDataModel'
      - type: object
        required:
        - loanNumber
        properties:  
          loanNumber:
            minLength: 1
            nullable: true
          applicationId:
            minLength: 1
          status:
            minLength: 7
            nullable: true
          tradeAccountNumber:
            writeOnly: true
          productType:
            writeOnly: true
          typeOfGoods:
            writeOnly: true
          loanStartDate:
            writeOnly: true
          tenor:
            writeOnly: true
          loanMaturityDate:
            writeOnly: true
          loanExtensionMaturityDate:
            writeOnly: true
          repaymentDate:
            writeOnly: true
          paymentCurrency:
            writeOnly: true
          paymentAmount:
            writeOnly: true
          loanCurrency:
            writeOnly: true
          loanAmountInPaymentCurrency:
            writeOnly: true
          outstandingCurrency:
            writeOnly: true
          outstandingAmount:
            writeOnly: true
          beneficiaryName:
            writeOnly: true
          creationDateAndTime:
            writeOnly: true
          totalSupportingDocumentCurrency:
            writeOnly: true
          totalSupportingDocumentAmount:
            writeOnly: true
          shortFallCurrency:
            writeOnly: true
          shortFallAmount: 
            writeOnly: true
          shortFallDebitAccount:
            writeOnly: true
          loanAmountLoanCurrency:
            writeOnly: true
          loanAmountOutstanding:
            writeOnly: true
          totalInterestPaid:
            writeOnly: true
          interestOutstanding:
            writeOnly: true
          fixedOrVariableRateLoan:
            writeOnly: true
          currentInterestRate:
            writeOnly: true
          interestCalculationPreferenceCode:
            writeOnly: true
          interestCollectionFrequencyCode:
            writeOnly: true
          interestCalculationPreference:
            writeOnly: true
          interestCollectionFrequency:
            writeOnly: true
          loanRepaymentAccount:
            writeOnly: true
          interestRepaymentAccount:
            writeOnly: true
          chargesRepaymentAccount:
            writeOnly: true
          interestAccountNumber:
            writeOnly: true
          chargesAccountNumber:
            writeOnly: true
          goodsDescription:
            writeOnly: true
          buyerDetails:
            writeOnly: true
          beneficiaryDetail:
            writeOnly: true
          beneficiaryDetails:
            writeOnly: true
          applicationOfFunds:
            writeOnly: true
          foreignExchangeDetails:
            writeOnly: true
          invoiceDetail:
            writeOnly: true
          dateRecorded:
            writeOnly: true
    EnquireLoanRequest:
      allOf:
      - $ref: '#/components/schemas/UpdateLoanRequest'
      - type: object
        properties:
          loanNumber:
            minLength: 0
          applicationId:
            minLength: 0
          loanExtensionTenor:
            readOnly: true
          loanExtensionMaturityDate:
            readOnly: true
          reasonForLoanExtension:
            readOnly: true
          repaymentDate:
            readOnly: true
          repaymentAmount:
            readOnly: true
          repaymentAccountNumber:
            readOnly: true
          interestAccountNumber:
            readOnly: true
          chargesAccountNumber:
            readOnly: true
          instructionsToBank:
            readOnly: true
          miscStates:
            readOnly: true
    BeneficiaryDetailModel: 
      allOf:
      - required:
        - paymentMethod
        - amountCurrency
        - amount
        - beneficiaryName
        - beneficiaryReferenceNumber
        - beneficiaryCountry
        - beneficiaryAddressLine1
        - beneficiaryAddressLine2
        - beneficiaryAddressLine3
        - beneficiaryBankAccount
        - beneficiaryBankSwiftBicBranchCode
        - beneficiaryBankAddressLine1
        - beneficiaryBankAddressLine2
        - beneficiaryBankAddressLine3
        - beneficiaryBankCountry
        - beneficiaryBankName
        - beneficiaryBankBranchName
        type: object
        properties:
          paymentMethod:
            type: string
            minLength: 1
            maxLength: 255
            example: 'local payment'
          amountCurrency:
            allOf:
            - $ref: '#/components/schemas/ISOCurrencyCode'
            example: 'SGD'
          amount:
            allOf:
            - $ref: '#/components/schemas/Amount_HUB'
          beneficiaryName:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryName'
            - minLength: 1
          beneficiaryReferenceNumber:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryReferenceNumber'
            - minLength: 1
          beneficiaryCountry:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryCountry'
            - minLength: 2
          beneficiaryAddressLine1:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryAddressLine1'
            - minLength: 1
          beneficiaryAddressLine2:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryAddressLine2'
            - minLength: 0
          beneficiaryAddressLine3:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryAddressLine3'
            - minLength: 0
          beneficiaryBankAccount:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryBankAccount'
            - minLength: 1
          beneficiaryBankName:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryBankName'
            - minLength: 1
          beneficiaryBankSwiftBicBranchCode:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryBankSwiftBicBranchCode'
          beneficiaryBankBranchName:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryBankBranchName'
            - minLength: 0
          beneficiaryBankCountry:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryBankCountry'
            - minLength: 2
          beneficiaryBankAddressLine1:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryBankAddressLine1'
            - minLength: 1
          beneficiaryBankAddressLine2:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryBankAddressLine2'
            - minLength: 0
          beneficiaryBankAddressLine3:
            allOf:
            - $ref: '#/components/schemas/BeneficiaryBankAddressLine3'
            - minLength: 0
    PaymentDetailModel:
      allOf:
      - $ref: '#/components/schemas/BeneficiaryDetailModel'
      - type: object
        properties:
          paymentMethod:
            readOnly: true
          beneficiaryReferenceNumber:
            readOnly: true
          amountCurrency:
            readOnly: true
          amount:
            readOnly: true
    BuyerInvoiceListModel:
      title: BuyerInvoiceListModel
      type: array      
      items:
        allOf:
        - $ref: '#/components/schemas/InvoiceDetailModel'
        - properties:
            buyerName:
              readOnly: true
            buyerCountry:
              readOnly: true
            buyerAddressLine1:
              readOnly: true
            buyerAddressLine2:
              readOnly: true
            buyerAddressLine3:
              readOnly: true
    InvoiceDetailModel:
      title: InvoiceDetailModel
      type: object
      oneOf:
      - title: BuyerInvoiceModel
        not:
          required:
          - buyerName
          - buyerCountry
          - buyerAddressLine1
          - buyerAddressLine2
          - buyerAddressLine3
      - $ref: '#/components/schemas/BuyerDetailModel'
      required:
      - invoiceAmount
      - invoiceCurrency
      - invoiceNumber
      - invoiceDate
      - lineItemDetails
      properties:
        invoiceNumber:
          type: string
          minLength: 1
          maxLength: 255
          description: Invoice number or bill reference
          example: 'INV23030101'
        invoiceCurrency:
          allOf:
          - $ref: '#/components/schemas/ISOCurrencyCode'
          description: Currency of the invoice
          example: 'SGD'
        invoiceAmount:
          allOf:
          - $ref: '#/components/schemas/Amount_HUB'
          description: 'Amount value of the invoice'
          example: '1000.00'
        invoiceDate:
          allOf:
          - $ref: '#/components/schemas/Date_TAAS'
          description: 'Date of invoice'
          example: '2023-03-01'
        invoiceOutstandingAmount:
          allOf:
          - $ref: '#/components/schemas/Amount_HUB'
          description: 'outstanding amount of invoice.'
          example: '1000.00'
        invoiceTaxAmount:
          description: Tax amount. Input 0 if not involved.
          allOf:
          - $ref: '#/components/schemas/Amount_HUB'
          example: '0.00'
        invoiceAdjustmentAmount:
          type: string
          description: 'Adjustment amount. Can be positive or negative.'
          pattern: ^(0|([-])?[1-9]\d{0,10})(\.\d{1,3})?$
          example: '0.00'
        lineItemDetails:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/LineItemDetailModel'
    LineItemDetailModel:
      required:
        - itemLineDescription
        - itemLineName
        - itemLineNumber
        - itemLineQuantity
        - itemLineUnitPrice
      type: object
      properties:
        itemLineNumber:
          type: string
          description: Number of the item line, start from 1
          minLength: 0
          maxLength: 5
          pattern: ^$|^([1-9]|[0-9]\d{1,4})$
          example: '1'
        itemLineName:
          description: Name for the item
          type: string
          minLength: 0
          maxLength: 255
          example: 'T-shirt'
        itemLineUnitPrice:
          allOf:
          - $ref: '#/components/schemas/Amount_HUB'
          description: Unit Price for the item
          example: '100.00'
        itemLineQuantity:
          type: string
          minLength: 0
          maxLength: 255
          pattern: ^$|^[1-9]\d{0,254}$
          description: Quantity for the item
          example: '10'
        itemLineDescription:
          type: string
          minLength: 1
          maxLength: 255
          description: Description of the item line.
          example: 'Made in Singapore'
        typeOfItem:
          allOf:
          - $ref: '#/components/schemas/LoanTypeOfGoods'
        itemLineTotal:
          allOf:
          - $ref: '#/components/schemas/Amount_HUB' 
          - minLength: 0
          description: >-
            The total value for the item. The value equal to `itemLineUnitPrice` * `itemLineQuantity`.
          example: '1000.00'
    TradeLoanDetailModel:
      allOf:
      - $ref: '#/components/schemas/TradeLoanDataModel'
      - type: object
        required: 
        - loanNumber
        properties:  
          productType:
            minLength: 10
          status:
            minLength: 7
          loanNumber:
            minLength: 1
          loanStartDate:
            minLength: 10
          tenor:
            minLength: 3
          loanMaturityDate:
            minLength: 10
          loanCurrency:
            minLength: 3
          loanAmountLoanCurrency:
            minLength: 0
          outstandingCurrency:
            minLength: 3  
          loanAmountOutstanding:
            minLength: 1
          loanAmountInPaymentCurrency:
            minLength: 0
          beneficiaryName:
            minLength: 0
          creationDateAndTime:
            minLength: 0
          paymentCurrency:
            minLength: 0
          paymentAmount:
            minLength: 0
          interestCalculationPreference:
            minLength: 0
          interestCollectionFrequency:
            minLength: 0
          loanRepaymentAccount:
            minLength: 1
          chargesRepaymentAccount:
            minLength: 0
          interestRepaymentAccount:
            minLength: 0
          applicationId:
            writeOnly: true
          loanExtensionMaturityDate:
            writeOnly: true
          invoiceDetail:
            writeOnly: true
          totalSupportingDocumentCurrency:
            writeOnly: true
          totalSupportingDocumentAmount:
            writeOnly: true
          shortFallCurrency:
            writeOnly: true
          shortFallAmount: 
            writeOnly: true
          shortFallDebitAccount:
            writeOnly: true
          repaymentDate:
            writeOnly: true
          goodsDescription:
            writeOnly: true
          outstandingAmount:
            minLength: 1
          interestCalculationPreferenceCode:
            writeOnly: true
          interestCollectionFrequencyCode:
            writeOnly: true
          interestAccountNumber:
            writeOnly: true
          chargesAccountNumber:
            writeOnly: true
          buyerDetails:
            writeOnly: true
          applicationOfFunds:
            writeOnly: true
          foreignExchangeDetails:
            writeOnly: true
    BuyerDetailModel:
      required:
      - buyerName
      - buyerCountry
      - buyerAddressLine1
      - buyerAddressLine2
      - buyerAddressLine3
      type: object
      properties:
        buyerName:
          allOf:
          - $ref: '#/components/schemas/BuyerName'
          - minLength: 1
        buyerCountry:
          allOf:
          - $ref: '#/components/schemas/BuyerCountry'
          - minLength: 2
        buyerAddressLine1:
          allOf:
          - $ref: '#/components/schemas/BuyerAddressLine1'
          - minLength: 1
        buyerAddressLine2:
          allOf:
          - $ref: '#/components/schemas/BuyerAddressLine2'
          - minLength: 0
        buyerAddressLine3:
          allOf:
          - $ref: '#/components/schemas/BuyerAddressLine3'
          - minLength: 0
      description: 'Details of buyer.'
    FundApplicationModel:
      required:
      - accountNumberIBAN
      - bankAddressLine1
      - bankAddressLine2
      - bankAddressLine3
      - bankBranchName
      - nameOfBank
      - payeeBankCountryTerritory
      - payeeBankSwiftBicBranchCode
      - paymentCurrency
      type: object
      properties:
        paymentCurrency:
          allOf:
          - $ref: '#/components/schemas/SellerOrderCurrency'
          - minLength: 3
        accountNumberIBAN:
          allOf:
          - $ref: '#/components/schemas/AccountNumberIBAN'
          - minLength: 1
        payeeBankCountryTerritory:
          allOf:
          - $ref: '#/components/schemas/BeneficiaryCountry'
          - minLength: 2
        payeeBankSwiftBicBranchCode:
          allOf:
          - $ref: '#/components/schemas/BeneficiaryBankSwiftBicBranchCode'
        nameOfBank:
          allOf:
          - $ref: '#/components/schemas/BeneficiaryBankName'
          - minLength: 0
          - maxLength: 31
        bankBranchName:
          allOf:
          - $ref: '#/components/schemas/BeneficiaryBankBranchName'
          - minLength: 0
          - maxLength: 31
        bankAddressLine1:
          allOf:
          - $ref: '#/components/schemas/BeneficiaryAddressLine1'
          - minLength: 1
        bankAddressLine2:
          allOf:
          - $ref: '#/components/schemas/BeneficiaryAddressLine2'
          - minLength: 0
        bankAddressLine3:
          allOf:
          - $ref: '#/components/schemas/BeneficiaryAddressLine3'
          - minLength: 0
    ForeignExchangeDetailsModel:
      required:
      - amountToBeUtilised
      - contractReferenceNumber
      - currency
      type: object
      properties:
        contractReferenceNumber:
          type: string
          minLength: 0
          maxLength: 16          
          example: FXLNSG23040102
          description: 'Contract Reference number for exchange rate that client and bank make an agreement.'
        currency:
          allOf:
          - $ref: '#/components/schemas/LoanCurrency'
          description: >-
            Currency agreed in the contract, same as `loanCurrency`.
        amountToBeUtilised:
          allOf:
          - $ref: '#/components/schemas/LoanAmountLoanCurrency'
          - minLength: 0
          description: >-
            Amount in the contract defined to be exchanged. Less than `loanAmount`.
    DocumentListModel:
      type: object
      required:
      - accountNumber
      - docUploadRequestId
      - attachDocument
      - docDetails
      properties:
        accountNumber:
          type: string
          description: >-
            Customer's `tradeAccountNumber` used for loan applications.
          example: 'SGHSBC123456789123'
        docUploadRequestId:
          description: 'Batch id of uploaded document(s)'
          allOf:
          - $ref: '#/components/schemas/Uuid_TAAS'
        attachDocument:
          description: >-
            Select file(s) for submission to HSBC as supporting documents.
            <details>
              <summary><strong>Formats supported</strong>:</summary>
              <ol>
                <li>Total size of all uploaded documents less than <code>30MB</code>.</li>
                <li>Support document type: <strong>bmp, doc, docx, gif, htm, html, jpeg, jpg, msg, odp, ods, odt, oxps, pdf, png, ppt, pptx, rtf, tif, tiff, txt, vsd, xls, xlsx, xps, zip</strong>.</li>
              </ol>
            </details>
          type: array
          minItems: 1
          maxItems: 10
          items:
            type: string
            format: binary
            example: '"\C":"\test.tiff'
          writeOnly: true
        docId:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/FileId_FileNet'
          writeOnly: true
        docDetails:
          type: array
          items:
            $ref: '#/components/schemas/SupportingDocumentModel'
          readOnly: true
    SupportingDocumentModel:
      required:
      - formType
      - docId
      - documentName
      - docName
      - numPages
      - imageFormat
      - imageBytes
      - hash
      - docStatus
      - docCategory
      type: object
      properties:
        formType:
          type: string
          enum:
          - p
          example: 'P'
          readOnly: true
        docId:
          allOf:
          - $ref: '#/components/schemas/FileId_FileNet'
        documentName:
          description: 'Document Name the document uploaded by the client'
          type: string
          minLength: 0
          maxLength: 255
          example: 'test.tif'
          readOnly: true
        docName:
          description: 'Document Name the document uploaded by the client'
          type: string
          minLength: 1
          maxLength: 255
          example: 'test.tif'
        docCategory:
          description: Document category
          type: string
          minLength: 3
          maxLength: 3
          enum:
          - APP
          - DCT
          - INV
          - OTH
          - PCO
          - PFM
          - POE
          - SCT
          - SPD
          - TRC
          writeOnly: true
        docStatus:
          description: 'Document upload status when upload the SupportingDocument to FileNet API. For the uploaded document with Virus Scan failed, cannot search out.'
          type: string
          minLength: 6
          maxLength: 11
          enum:
          - 'In Progress'
          - 'Failed'
          - 'Uploaded'
          nullable: true
          readOnly: true
          example: 'In Progress'
        numPages:
          description: 'Number of the document page'
          type: string
          minLength: 1
          maxLength: 255
          pattern: ^[1-9]\d{0,254}$
          nullable: true
          readOnly: true
          example: 1
        imageFormat:
          description: 'Document format for the uploaded document'
          type: string
          minLength: 3
          maxLength: 4
          enum:
          - BMP
          - DOC
          - DOCX
          - GIF
          - HTM
          - HTML
          - JPEG
          - JPG
          - MSG
          - ODP
          - ODS
          - ODT
          - OXPS
          - PDF
          - PNG
          - PPT
          - PPTX
          - RTF
          - TIF
          - TIFF
          - TXT
          - VSD
          - XLS
          - XLSX
          - XPS
          - ZIP
          readOnly: true
        imageBytes:
          description: 'Document size within Bytes'
          type: string
          minLength: 0
          maxLength: 255
          pattern: ^\d{1,255}$
          readOnly: true
          example: 409844
        hash:
          description: 'Hash value for the uploaded document'
          type: string
          minLength: 0
          maxLength: 255
          readOnly: true
          example: 'F4318B5E707877F3B1DC3BE48708E532'
  requestBodies:
    CreateStandardBuyerLoanRequest:
      description: >-          
        <ol>
        <li>
          <strong>Linked Operations</strong>: 
          <ol type="i">
           <li>
           <code>Request Supporting document detail API</code> if you have submitted supporting documents for this loan application. <a href="#operation/list-supporting-documents"><sub>View Endpoint</sub></a> 
           </li>
           </ol>
           </li>
        <li><strong>To make a request</strong>:           
          <ol type="i">
          <li>
              <strong>Prepares</strong> the <code>Unencrypted Request</code> body as per <code>CreateStandardBuyerLoanRequest</code> schema.
              </li>
            <li>
              <strong>Encrypts</strong> the <code>Unencrypted Request</code> body and <code>Base64</code> encodes it as per <code>EncryptedAndBase64Encoded_TAAS</code> schema.<br /> <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"> <sub>View guidance on Message Level Encryption</sub></a>
            </li>
            </ol>
            </li>
           <p><sub>Full example -</sub> <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>How to Submit Loan Application Request via API in Sandbox Environment?</sub></a></p>
          </li>
          </ol>
      content:
        application/json:
          schema:
            oneOf:
            - title: CreateStandardBuyerLoanRequest
              allOf:
              - $ref: '#/components/schemas/CreateBuyerLoanRequest'
              - type: object
                properties:
                  loanAmountLoanCurrency:
                    readOnly: true
                  interestCalculationPreferenceCode:
                    readOnly: true
                  interestCollectionFrequencyCode:
                    readOnly: true
                  shortFallCurrency:
                    readOnly: true
                  shortFallAmount:
                    readOnly: true
                  shortFallDebitAccount:
                    readOnly: true
                  buyerDetails:
                    readOnly: true
                  beneficiaryDetail:
                    allOf:
                    - $ref: '#/components/schemas/BeneficiaryDetailModel'
                    - properties:
                        paymentMethod:
                          readOnly: true
                        amountCurrency:
                          readOnly: true
                        amount:
                          readOnly: true
                        beneficiaryReferenceNumber:
                          readOnly: true
                        beneficiaryBankBranchName:
                          readOnly: true
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            UnencryptedRequest:
              description: >-
                <p>You <strong>as a/ on-behalf of</strong> your customer <code>PLT-CUSTID-001</code>, request a loan application valued <code>SGD 1000.00</code> that will be due in <code>30</code> days.<br />  
                <ol>
                  <li>Loan applicant requested loan to be repaid, valued<code>USD 750.00</code>.</li>
                  <li>Loan applicant possesses a transaction account in <strong>HSBC</strong>. e.g. <code>"tradeAccountNumber": "SGHSBC123456789123"</code></li>
                </ol>
                <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>Full example - How to Submit Loan Application Request via API in Sandbox Environment?</sub></a></p>
              value:
                extnlCustomerId: PLT-CUSTID-001
                tradeAccountNumber: SGHSBC123456789123
                loanNumber: ''
                customerReference: CRSG23040101
                typeOfGoods: GOODS
                goodsShipped: 'Y'
                invoiceNumberBillReference: '81921021'
                loanStartDate: '2023-04-01'
                tenor: '30'
                loanMaturityDate: '2023-04-30'
                paymentCurrency: USD
                paymentAmount: '750.00'
                loanAmountInPaymentCurrency: '1000.00'
                loanCurrency: SGD
                loanRepaymentAccount: ''
                interestRepaymentAccount: SGHSBC123456789123
                chargesRepaymentAccount: SGHSBC123456789123
                goodsDescription: T-shirt
                beneficiaryDetail:
                  beneficiaryName: BEN-SG001 Holdings Plc.
                  beneficiaryCountry: SG
                  beneficiaryAddressLine1: 'BEN-SG001 Tower #01-01'
                  beneficiaryAddressLine2: 1 BEN-SG001 Street
                  beneficiaryAddressLine3: SINGAPORE 12345
                  beneficiaryBankAccount: AC-BEN-SG001
                  beneficiaryBankName: BANK-SG001 Holdings Plc.
                  beneficiaryBankSwiftBicBranchCode: HSBCSGS2001
                  beneficiaryBankCountry: SG
                  beneficiaryBankAddressLine1: 'BANK-SG001 Tower #01-01'
                  beneficiaryBankAddressLine2: 1 BANK-SG001 Street
                  beneficiaryBankAddressLine3: SINGAPORE 12345
                supportingDocuments:
                  - docId: idd_10349C86-0000-C515-AB9B-65B893B9744B
                    docName: test.tif
                    docCategory: APP
                instructionsToBank: message for your bank
                miscStates: '{"additionalInfo":"something"}'
                
      required: true
    CreateAdvancedBuyerLoanRequest:
      description: >-          
        <ol>
        <li>
          <strong>Linked Operations</strong>: 
          <ol type="i">
           <li>
           <code>Request Supporting document detail API</code> if you have submitted supporting documents for this loan application. <a href="#operation/list-supporting-documents"><sub>View Endpoint</sub></a> 
           </li>
           </ol>
           </li>
        <li><strong>To make a request</strong>:           
          <ol type="i">
          <li>
              <strong>Prepares</strong> the <code>Unencrypted Request</code> body as per <code>CreateAdvancedBuyerLoanRequest</code> schema.
              </li>
            <li>
              <strong>Encrypts</strong> the <code>Unencrypted Request</code> body and <code>Base64</code> encodes it as per <code>EncryptedAndBase64Encoded_TAAS</code> schema.<br /> <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"> <sub>View guidance on Message Level Encryption</sub></a>
            </li>
            </ol>
            </li>
           <p><sub>Full example -</sub> <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>How to Submit Loan Application Request via API in Sandbox Environment?</sub></a></p>
          </li>
          </ol>
      content:
        application/json:
          schema:
            oneOf:
            - title: CreateAdvancedBuyerLoanRequest
              allOf:
              - $ref: '#/components/schemas/CreateBuyerLoanRequest'
              - type: object
                properties:
                  invoiceNumberBillReference:
                    readOnly: true
                  beneficiaryDetail:
                    allOf:
                    - type: array
                      minItems: 1
                      items:
                        allOf:
                        - $ref: '#/components/schemas/BeneficiaryDetailModel'
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            UnencryptedRequest:
              description: >-
                <p>You <strong>as a/ on-behalf of</strong> your customer <code>PLT-CUSTID-001</code>, request a loan application valued <code>SGD 1000.00</code> that will be due in <code>30</code> days.</p>  
                <ol>
                  <li>Loan applicant requested loan to be repaid, valued<code>USD 750.00</code>.</li>
                  <li>Loan applicant possesses a transaction account in <strong>HSBC</strong>. e.g. <code>"tradeAccountNumber": "SGHSBC123456789123"</code></li>
                </ol>
                <p><a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>Full example - How to Submit Loan Application Request via API in Sandbox Environment?</sub></a></p>
              value:
                extnlCustomerId: PLT-CUSTID-001
                tradeAccountNumber: SGHSBC123456789123
                loanNumber: ''
                customerReference: CRSG23040101
                typeOfGoods: GOODS
                goodsShipped: 'Y'
                loanStartDate: '2023-04-01'
                tenor: '30'
                loanMaturityDate: '2023-04-30'
                paymentCurrency: USD
                paymentAmount: '750.00'
                loanAmountInPaymentCurrency: '750.00'
                loanCurrency: SGD
                shortFallCurrency: ''
                shortFallAmount: ''
                shortFallDebitAccount: ''
                interestCalculationPreferenceCode: ''
                interestCollectionFrequencyCode: ''
                loanRepaymentAccount: ''
                interestRepaymentAccount: SGHSBC123456789123
                chargesRepaymentAccount: SGHSBC123456789123
                goodsDescription: T-shirt
                beneficiaryDetail:
                  - beneficiaryName: BEN-SG001 Holdings Plc.
                    beneficiaryReferenceNumber: '12232322'
                    beneficiaryCountry: SG
                    beneficiaryAddressLine1: 'BEN-SG001 Tower #01-01'
                    beneficiaryAddressLine2: 1 BEN-SG001 Street
                    beneficiaryAddressLine3: SINGAPORE 12345
                    beneficiaryBankAccount: AC-BEN-SG001
                    beneficiaryBankName: BANK-SG001 Holdings Plc.
                    beneficiaryBankSwiftBicBranchCode: HSBCSGS2001
                    beneficiaryBankBranchName: ''
                    beneficiaryBankCountry: SG
                    beneficiaryBankAddressLine1: 'BANK-SG001 Tower #01-01'
                    beneficiaryBankAddressLine2: 1 BANK-SG001 Street
                    beneficiaryBankAddressLine3: SINGAPORE 12345
                supportingDocuments:
                  - docId: idd_10349C86-0000-C515-AB9B-65B893B9744B
                    docName: test.tif
                    docCategory: APP
                instructionsToBank: message for your bank
                miscStates: '{"additionalInfo":"something"}'
            Encrypted Request (Base64):
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS'
      required: true
    ExtendTradeLoanRequest:
      description: >-          
        <section>
          <h6>Linked Operations:</h6>
          <ol>
            <li>Corresponding <code>loanNumber</code> retrieved via <code>Submit Buyer Loan Application Request API</code>. <a href="#operation/create-standard-buyer-loans"><sub>View Endpoint</sub>.</a></li>
            <li>Corresponding loan's status is <code>Disbursed</code>.</li>
          </ol>
        </section>
        <section>
          <h6>To make a request:</h6>
          <ol>
            <li>
              <strong>Prepares</strong> the <code>Unencrypted Request</code> body as per <code>ExtendTradeLoanRequest</code> schema.
              <ol type="i">
                <li>An example is available under <code>Request samples</code>/ <code>Example</code>/ <code>Unencrypted Request</code>.</li>
                <li>You may try a <code>Mock Request</code> via <code>Try it now</code> with the above example selected. <a href="https://develop.hsbc.com/node/812#making-an-api-request-via-open-api-specifications" target="_blank"><sub>Making an API Request via Mock Sandbox</sub></a></li>
              </ol>
            </li>
            <li>
              <strong>Encrypts</strong> the <code>Unencrypted Request</code> body and <code>Base64</code> encodes it as per <code>EncryptedAndBase64Encoded_TAAS</code> schema.
              <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"><sub>View guidance on Message Level Encryption</sub></a>
              <ol type="i">
                <li>An example is available under <code>Request samples</code>/ <code>Example</code>/ <code>Encrypted Body - Base64 encoding</code>.</li>
              <li>You may experience the full request journey via <strong>Smart Sandbox</strong>. <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>How to Submit Loan Extension Request via API in Sandbox Environment?</sub></a></li>
              </ol>
            </li>
          </ol>
        </section>
      content:
        application/json:
          schema:
            oneOf:
            - title: ExtendTradeLoanRequest
              allOf:
              - $ref: '#/components/schemas/UpdateLoanRequest'
              - properties:  
                  loanNumber:
                    minLength: 1
                  applicationId:
                    readOnly: true
                  customerReference:
                    readOnly: true
                  beneficiaryName:
                    readOnly: true
                  repaymentDate:
                    readOnly: true 
                  repaymentAmount:
                    readOnly: true
                  interestAccountNumber:
                    readOnly: true 
                  repaymentAccountNumber:
                    readOnly: true 
                  chargesAccountNumber:
                    readOnly: true
                  status:
                    readOnly: true
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            Unencrypted Request:
              description: >-
                <section>
                <p>You <strong>as a/ on-behalf of</strong> your customer <code>PLT-CUSTID-001</code>, request for extension of <code>LNSG23040102</code> from <code>30</code> days to <code>60</code> days. Hence, the new due date, i.e. <code>loanExtensionMaturityDate</code> to be changed from <code>2023-04-15</code> to <code>2023-05-14</code>.</p>
                <ol>
                  <li>Loans extension will only be processed if associated loan's <code>status</code> is <code>Disbursed</code> and the original <code>loanMaturityDate</code> is <code>>=</code> <code>Current Date</code>.</li>
                  <li>Specify the <strong>Authroisation</strong> value pair per <code>LNSG23040102</code>, i.e.<code>"extnlCustomerId": "PLT-CUSTID-001"</code> and <code>"tradeAccountNumber": "SGHSBC123456789012"</code>.</li>
                </ol>
                </section>
                <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>Full example - How to Submit Loan Extension Request via API in Sandbox Environment?</sub></a>
              value:
                extnlCustomerId: PLT-CUSTID-001
                tradeAccountNumber: SGHSBC123456789123
                loanNumber: LNSG23040102
                loanExtensionTenor: '30'
                loanExtensionMaturityDate: '2023-04-30'
                reasonForLoanExtension: extend loan date
                instructionsToBank: message for your bank
                miscStates: '{"additionalInfo":"something"}'
            Encrypted Request (Base64):
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS'
      required: true
    SettleTradeLoanRequest:
      description: >-          
        <section>
          <h6>Linked Operations:</h6>
          <ol>
            <li>Corresponding <code>loanNumber</code> retrieved via <code>Submit Buyer Loan Application Request API</code>. <a href="#operation/create-standard-buyer-loans"><sub>View Endpoint</sub>.</a></li>
            <li>Corresponding loan's <code>"status": "Disbursed"</code>.</li>
          </ol>
        </section>
        <section>
          <h6>To make a request:</h6>
          <ol>
            <li>
              <strong>Prepares</strong> the <code>Unencrypted Request</code> body as per <code>SettleTradeLoanRequest</code> schema.
              <ol type="i">
                <li>An example is available under <code>Request samples</code>/ <code>Example</code>/ <code>Unencrypted Request</code>.</li>
                <li>You may try a <code>Mock Request</code> via <code>Try it now</code> with the above example selected. <a href="https://develop.hsbc.com/node/812#making-an-api-request-via-open-api-specifications" target="_blank"><sub>Making an API Request via Mock Sandbox</sub></a></li>
              </ol>
            </li>
            <li>
              <strong>Encrypts</strong> the <code>Unencrypted Request</code> body and <code>Base64</code> encodes it as per <code>EncryptedAndBase64Encoded_TAAS</code> schema.
              <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"><sub>View guidance on Message Level Encryption</sub></a>
              <ol type="i">
                <li>An example is available under <code>Request samples</code>/ <code>Example</code>/ <code>Encrypted Body - Base64 encoding</code>.</li>
              <li>You may experience the full request journey via <strong>Smart Sandbox</strong>. <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>How to Submit Loan Settlement Request via API in Sandbox Environment?</sub></a></li>
              </ol>
            </li>
          </ol>
        </section>
      content:
        application/json:
          schema:
            oneOf:
            - title: SettleTradeLoanRequest
              allOf:
              - $ref: '#/components/schemas/UpdateLoanRequest'
              - type: object
                properties:  
                  loanNumber:
                    minLength: 1
                  repaymentDate:
                    minLength: 10
                  repaymentAmount:
                    minLength: 1
                  repaymentAccountNumber:
                    minLength: 1
                  interestAccountNumber:
                    minLength: 0
                  chargesAccountNumber:
                    minLength: 0
                  applicationId:
                    readOnly: true
                  customerReference:
                    readOnly: true
                  beneficiaryName:
                    readOnly: true
                  loanExtensionTenor:
                    readOnly: true
                  loanMaturityDate:
                    readOnly: true
                  loanExtensionMaturityDate:
                    readOnly: true
                  reasonForLoanExtension:
                    readOnly: true
                  status:
                    readOnly: true
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            Unencrypted Request:
              description: >-
                <section>
                <p>You <strong>as a/ on-behalf of</strong> your customer <code>PLT-CUSTID-001</code>, request for settlement of an existing loan.</p>  
                <ol>
                  <li>Loans settlement will only be processed if the loan's <code>status</code> is <code>Disbursed</code>.</li>
                  <li>Specify the <strong>Authroisation</strong> value pair per <code>LNSG23040102</code>, i.e.<code>"extnlCustomerId": "PLT-CUSTID-001"</code> and <code>"tradeAccountNumber": "SGHSBC123456789012"</code>.</li>
                </ol>
                </section>
                <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>Full example - How to Submit Loan Settlement Request via API in Sandbox Environment?</sub></a>
              value:
                extnlCustomerId: PLT-CUSTID-001
                tradeAccountNumber: SGHSBC123456789123
                loanNumber: LNSG23040102
                repaymentDate: '2023-03-30'
                repaymentAmount: '750.00'
                repaymentAccountNumber: SGHSBC123456789123
                interestAccountNumber: SGHSBC123456789123
                chargesAccountNumber: SGHSBC123456789123
                instructionsToBank: message for your bank
                miscStates: '{"additionalInfo":"something"}'
            Encrypted Request (Base64):
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS' 
      required: true
    ListTradeLoanStatusRequest:
      description: >-          
        <section>
          <h6>Linked Operations:</h6>
          <p>Loan requests that have been processed/ updated via following APIs, with corresponding <code>loanNumber</code> generated.</p>
          <ol>
            <li>
              <code>Submit Buyer Loan Application Request API</code>. <a href="#operation/create-standard-buyer-loans"><sub>View Endpoint</sub></a>
            </li>
            <li>
              <code>Submit Buyer Loan Extension Request API</code>. <a href="#operation/extend-standard-buyer-loans"><sub>View Endpoint</sub></a>
            </li>
            <li>
              <code>Submit Buyer Loan Settlement Request API</code>. <a href="#operation/settle-standard-buyer-loans"><sub>View Endpoint</sub></a>
            </li>
          </ol>
        </section>
        <section>
          <h6>To make a request:</h6>
          <ol>
            <li>
              <strong>Prepares</strong> the <code>Unencrypted Request</code> body as per <code>ListTradeLoanSummaryRequest</code> schema.
              <ol type="i">
                <li>An example is available under <code>Request samples</code>/ <code>Example</code>/ <code>Unencrypted Request</code>.</li>
                <li>
                  You may try a <code>Mock Request</code> via <code>Try it now</code> with the above example selected.
                  <a href="https://develop.hsbc.com/node/812#making-an-api-request-via-open-api-specifications" target="_blank"><sub>Making an API Request via Mock Sandbox</sub></a>
                </li>
              </ol>
            </li>
            <li>
              <strong>Encrypts</strong> the <code>Unencrypted Request</code> body and <code>Base64</code> encodes it as per <code>EncryptedAndBase64Encoded_TAAS</code> schema.
              <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"><sub>View guidance on Message Level Encryption</sub></a>
              <ol type="i">
                <li>An example is available under <code>Request samples</code>/ <code>Example</code>/ <code>Encrypted Body - Base64 encoding</code>.</li>
                <li>
                  You may experience the full request journey via <strong>Smart Sandbox</strong>.
                  <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>How to Request Trade Loan Status via API in Sandbox Environment?</sub></a>
                </li>
              </ol>
            </li>
          </ol>
        </section>
      content:
        application/json:
          schema:
            oneOf:
            - title: ListTradeLoanStatusRequest
              allOf:
              - $ref: '#/components/schemas/PaginationModel_TAAS'
              - $ref: '#/components/schemas/EnquireLoanRequest'
              - type: object
                properties:
                  applicationId:
                    readOnly: true
                  customerReference:
                    minLength: 0
                  status:
                    minLength: 0
                  beneficiaryName:
                    minLength: 0
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            Unencrypted Request:
              description: >-
                <section>
                  <p>You <strong>as a/ on-behalf of</strong> your customer <code>PLT-CUSTID-001</code>, request status of one or many loans that have been submitted to <strong>HSBC</strong></p>
                  <section>
                    <h6>Authorisation:</h6>
                      <p>Specify the value pair per <code>LNSG23040102</code>, i.e.<code>"extnlCustomerId": "PLT-CUSTID-001"</code> and <code>"tradeAccountNumber": "SGHSBC123456789012"</code>.</p>
                  </section>
                  <section>
                    <h6>Paginations:</h6>
                      <p>Specify how you would like transaction(s) matching filtering criteria to be retrieved.</p>
                      <ol>
                        <li>Assume that the enquiry page on your platform will be displaying <strong>up to 10</strong> transactions (loans), set the <code>"pageSize": "10"</code>.</li>
                        <li>Here, set <code>"pageNumber": "1"</code> so as to receive a response with the <strong>first 10 transactions</strong> matching all filtering criteria.</li>                      
                    </ol>
                  </section>
                  <section>
                    <h6>Filtering Criteria</h6>
                    <p>It is optional to specify <code>customerReference</code>, <code>loanNumber</code>, <code>status</code> and <code>beneficiaryName</code>.</p>
                  </section>
                </section>
                <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>Full example - How to Request Trade Loan Status via API in Sandbox Environment?</sub>.</a>             
              value:
                pageSize: '10'
                pageNumber: '1'
                extnlCustomerId: PLT-CUSTID-001
                tradeAccountNumber: SGHSBC123456789123
                loanNumber: ''
                beneficiaryName: ''
                customerReference: ''
                status: ''
            Encrypted Request (Base64):
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS' 
      required: true
    GetTradeLoanDetailRequest:
      description: >-          
        <section>
          <h6>Linked Operations:</h6>
          <p>Loan requests that have been processed/ updated via following APIs, with corresponding <code>loanNumber</code> generated.</p>
          <ol>
            <li>
              <code>Submit Buyer Loan Application Request API</code>. <a href="#operation/create-standard-buyer-loans"><sub>View Endpoint</sub></a>
            </li>
            <li>
              <code>Submit Buyer Loan Extension Request API</code>. <a href="#operation/extend-standard-buyer-loans"><sub>View Endpoint</sub></a>
            </li>
            <li>
              <code>Submit Buyer Loan Settlement Request API</code>. <a href="#operation/settle-standard-buyer-loans"><sub>View Endpoint</sub></a>
            </li>
          </ol>
        </section>
        <section>
          <h6>To make a request:</h6>
          <ol>
            <li>
              <strong>Prepares</strong> the <code>Unencrypted Request</code> body as per <code>GetTradeLoanDetailRequest</code> schema.
              <ol type="i">
                <li>An example is available under <code>Request samples</code>/ <code>Example</code>/ <code>Unencrypted Request</code>.</li>
                <li>
                  You may try a <code>Mock Request</code> via <code>Try it now</code> with the above example selected.
                  <a href="https://develop.hsbc.com/node/812#making-an-api-request-via-open-api-specifications" target="_blank"><sub>Making an API Request via Mock Sandbox</sub></a>
                </li>
              </ol>
            </li>
            <li>
              <strong>Encrypts</strong> the <code>Unencrypted Request</code> body and <code>Base64</code> encodes it as per <code>EncryptedAndBase64Encoded_TAAS</code> schema.
              <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"><sub>View guidance on Message Level Encryption</sub></a>
              <ol type="i">
                <li>An example is available under <code>Request samples</code>/ <code>Example</code>/ <code>Encrypted Body - Base64 encoding</code>.</li>
                <li>
                  You may experience the full request journey via <strong>Smart Sandbox</strong>.
                  <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>How to Request Trade Loan Details via API in Sandbox Environment?</sub></a>
                </li>
              </ol>
            </li>
          </ol>
        </section>
      content:
        application/json:
          schema:
            oneOf:
            - title: GetTradeLoanDetailRequest
              allOf:
              - $ref: '#/components/schemas/EnquireLoanRequest'
              - type: object
                properties:
                  customerReference:
                    readOnly: true
                  status:
                    readOnly: true
                  beneficiaryName:
                    readOnly: true
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            Unencrypted Request:
              description: >-
                <section>
                  <p>You <strong>as a/ on-behalf of</strong> your customer <code>PLT-CUSTID-001</code>, request details of a specific loans that have been submitted to <strong>HSBC</strong></p>
                  <section>
                    <h6>Authorisation:</h6>
                    <ol>  
                      <li>Specify the value pair per the specific loan, i.e.<code>"extnlCustomerId": "PLT-CUSTID-001"</code> and <code>"tradeAccountNumber": "SGHSBC123456789012"</code>.</li>
                      <li>Specify the specific loanNumber or applicationId, i.e.<code>"loanNumber": "LNSG23040102"</code> or <code>"applicationId": "20230401SG02"</code>.</li>
                  </section>
                </section>
                <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>Full example - How to Request Trade Loan details via API in Sandbox Environment?</sub></a>
              value:
                extnlCustomerId: PLT-CUSTID-001
                tradeAccountNumber: SGHSBC123456789123
                loanNumber: LNSG23040102
                applicationId: ''
            Encrypted Request (Base64):
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS' 
      required: true
    UploadSupportingDocumentRequest:
      description: >-
        <section>
          <h6>Linked Operations:</h6>
          <ol>
            <li>Nil</li>
          </ol>
        </section>
        <section>
          <h6>To make a request:</h6>
          <ol>
            <li>
              <strong>Prepares</strong> the <code>Unencrypted Request</code> body as per <code>ListSupportingDocumentStatusRequest</code> schema.
              <ol type="i">
                <li>An example is available under <code>Request samples</code>/ <code>Example</code>/ <code>Unencrypted Request</code>.</li>
                <li>
                  You may try a <code>Mock Request</code> via <code>Try it now</code> with the above example selected.
                  <a href="https://develop.hsbc.com/node/812#making-an-api-request-via-open-api-specifications" target="_blank"><sub>Making an API Request via Mock Sandbox</sub></a>
                </li>
                <li>
                  You may experience the full request journey via <strong>Smart Sandbox</strong>. <sub>Coming soon</sub></a>
                </li>
              </ol>
            </li>
            <li><strong>Encryption is not required.</strong></li>             
          </ol>
        </section>
      content:
        multipart/form-data:
          schema:
            title: UploadSupportingDocumentRequest
            allOf:
            - $ref: '#/components/schemas/DocumentListModel'
            - type: object
              properties:
                accountNumber:
                  readOnly: true
                docUploadRequestId:
                  readOnly: true
                docId:
                  readOnly: true
          examples:
            Unencrypted Request:
              value:
                attachDocument: 
                - 'test.tif'  
      required: true
    ListSupportingDocumentStatusRequest:
      description: >-          
        <section>
          <h6>Linked Operations:</h6>
          <ol>
            <li>Retrieve the <code>docUploadRequestId</code> or <code>docId</code> for documents submitted via <code>Submit Supporting Documents API</code>. <a href="#operation/upload-supporting-documents"><sub>View Endpoint</sub></a></li>
          </ol>
        </section>
        <section>
          <h6>To make a request:</h6>
          <ol>
            <li>
              <strong>Prepares</strong> the <code>Unencrypted Request</code> body as per <code>ListTradeLoanSummaryRequest</code> schema.
              <ol type="i">
                <li>An example is available under <code>Request samples</code>/ <code>Example</code>/ <code>Unencrypted Request</code>.</li>
                <li>
                  You may try a <code>Mock Request</code> via <code>Try it now</code> with the above example selected.
                  <a href="https://develop.hsbc.com/node/812#making-an-api-request-via-open-api-specifications" target="_blank"><sub>Making an API Request via Mock Sandbox</sub></a>
                </li>
              </ol>
            </li>
            <li>
              <strong>Encrypts</strong> the <code>Unencrypted Request</code> body and <code>Base64</code> encodes it as per <code>EncryptedAndBase64Encoded_TAAS</code> schema.
              <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"><sub>View guidance on Message Level Encryption</sub></a>
              <ol type="i">
                <li>An example is available under <code>Request samples</code>/ <code>Example</code>/ <code>Encrypted Body - Base64 encoding</code>.</li>
                <li>
                  You may experience the full request journey via <strong>Smart Sandbox</strong>.
                  <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>How to Request Supporting Document Status via API in Sandbox Environment?</sub></a>
                </li>
              </ol>
            </li>
          </ol>
        </section>
      content:
        application/json:
          schema:
            oneOf:
            - title: ListSupportingDocumentStatusRequest
              allOf:
              - $ref: '#/components/schemas/DocumentListModel'
              - type: object
                properties:
                  attachDocument:
                    readOnly: true
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            Unencrypted Request:
              value:
                accountNumber: SGHSBC123456789123
                docUploadRequestId: efbf054e8f9c477493bfb3d2a19781b2
                docId:
                  - idd_10349C86-0000-C515-AB9B-65B893B9744B
            Encrypted Request (Base64):
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS' 
      required: true
  responses:
  ## Trade Loan reusable responses
    CreateLoanApplicationResponse:
      description: >-
        <strong>Success</strong>
        <section>
          <h6>To process the response:</h6>          
            <ol>
              <li>
              <strong>Receives response</strong> as per <code>EncryptedAndBase64Encoded_TAAS</code> schema. <strong>Decodes</strong> and <strong>decrypts</strong> it.
              <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"><sub>View guidance on Message Level Encryption</sub></a>
              <ol type="i">
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Encrypted Body - Base64 encoding</code>.</li>
                <li>
                  You may experience the full response journey via <strong>Smart Sandbox</strong>.
                  <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="_blank"><sub>How to Submit Buyer Loan Application Request via API in Sandbox Environment?</sub></a>
                </li>
              </ol>
              </li>
              <li>
                <strong>Upon response is decrypted successful</strong>, you shall be able to obtain the <code>Unencrypted response</code> in <code>JSON</code> structure, as per <code>CreateLoanApplicationResponse</code> schema.
                <ol type="i">               
                <li>Upon a loan application is generated successfully, a <code>loanNumber</code> and <code>applicationId</code> will be generated. These values are input for other <code>linked operations</code>.</li>
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Unencrypted Response</code>.</li>
               </ol>
              </li>
            </ol>
        </section>
        <section>
          <h6>Linked Operations:</h6> 
          <ol>
            <li>
              Extends it's <strong>duration</strong> via <code>Submit Buyer Loan Extension Request API</code>. <a href="#operation/extend-standard-buyer-loans"><sub>View Endpoint</sub></a>
            </li>
            <li>
              Performs <strong>settlement</strong> via <code>Submit Buyer Loan Settlement Request API</code>. <a href="#operation/settle-standard-buyer-loans"><sub>View Endpoint</sub></a>
            </li>
            <li>
              Enquires <strong>status of this and many other loans</strong> that have been submitted via <code>Request Trade Loan Status API</code>. <a href="#operation/list-trade-loan-status"><sub>View Endpoint</sub></a>
            </li>
            <li>
              Enquires <strong>details of this loan</strong> of it via <code>Request Trade Loan Details API</code>. <a href="#operation/get-trade-loan-details"><sub>View Endpoint</sub></a>
            </li>
          </ol>
        </section>
      content:
        application/json:
          schema:
            oneOf:
            - title: CreateLoanApplicationResponse
              allOf:
              - $ref: '#/components/schemas/RESPONSE_200_TAAS'
              - type: object
                properties:
                  responseData:
                    allOf:
                    - $ref: '#/components/schemas/UpdateLoanResponse'
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            Unencrypted Response - Success:
              value:
                code: EMKT200
                message: Success
                repliedTime: '2023-04-01 00:00:43'
                correlationId: efbf054e8f9c477493bfb3d2a19781b2
                responseData:
                  loanNumber: LNSG23040102
                  applicationId: 46338647WB6V
                  customerReference: CRSG23040101
                  status: Submitted
                errorDetails: null
            Unencrypted Response - Bad Request Payload - Format:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_PAYLOAD_TAAS'
            Unencrypted Response - Bad Request Payload - Business Logic:
              summary: Unencrypted Response - Bad Request Payload (Business Logic)
              value:
                code: EMKT400
                message: Bad request payload
                repliedTime: "2023-04-01 00:00:43"
                correlationId: null
                responseData: null
                errorDetails: 
                - code: EMKT400-007,
                  message: The loanStartDate should be equal or later than today and within the next 15 days of today.
                - code: EMKT400-008,
                  message: tenor value less than or equal to 360 Days.
                - code: EMKT400-016,
                  message: The interestRepaymentAccount must be equal to chargesRepaymentAccount.
                - code: EMKT400-078,
                  message: The loanRepaymentAccount is invalid.       
                - code: EMKT400-079,
                  message: The interestRepaymentAccount or ChargesRepaymentAccount is invalid.
            Unencrypted Response - Internal Server Error:
              $ref: '#/components/examples/RESPONSE_200_INTERNAL_SERVER_ERROR_TAAS'
            Unencrypted Response - Decryption Failure:
              $ref: '#/components/examples/RESPONSE_200_DECRYPTION_FAILURE_TAAS'
            Unencrypted Response - Bad Request Header:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_HEADER_TAAS'
            Unencrypted Response - Auth Error:
              $ref: '#/components/examples/RESPONSE_200_AUTH_ERROR_TAAS'
            Unencrypted Response - Gateway Timeout:
              $ref: '#/components/examples/RESPONSE_200_GATEWAY_TIMEOUT_TAAS'
            Encrypted Response:
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS'    
    ExtendTradeLoanResponse:
      description: >-
        <strong>Success</strong>
        <section>
          <h6>To process the response:</h6>          
            <ol>
              <li>
              <strong>Receives response</strong> as per <code>EncryptedAndBase64Encoded_TAAS</code> schema. <strong>Decodes</strong> and <strong>decrypts</strong> it.
              <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"><sub>View guidance on Message Level Encryption</sub></a>
              <ol type="i">
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Encrypted Body - Base64 encoding</code>.</li>
                <li>
                  You may experience the full response journey via <strong>Smart Sandbox</strong>.
                  <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="blank"><sub>How to Submit Loan Extension Request via API in Sandbox Environment?</a>
                </li>
              </ol>
              </li>
              <li>
                <strong>Upon response is decrypted successful</strong>, you shall be able to obtain the <code>Unencrypted response</code> in <code>JSON</code> structure, as per <code>ExtendTradeLoanResponse</code> schema.
                <ol type="i">               
                <li>Upon a loan extension request is submitted <strong>successfully</strong>, a <code>status</code> is changed to <code>Extension Submitted</code>.</li>
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Unencrypted Response</code>.</li>
               </ol>
              </li>
            </ol>
        </section>
        <section>
          <h6>Linked Operations:</h6> 
          <ol>
            <li>
              Enquires <strong>status of this and many other loans</strong> that have been submitted via <code>Request Trade Loan Status API</code>. <a href="#operation/list-trade-loan-status"><sub>View Endpoint</sub></a>
            </li>
            <li>
              Enquires <strong>details of this loan</strong> of it via <code>Request Trade Loan Details API</code>. <a href="#operation/get-trade-loan-details"><sub>View Endpoint</sub></a>
            </li>
          </ol>
        </section>
      content:
        application/json:
          schema:
            oneOf:
            - title: ExtendTradeLoanResponse
              allOf:
              - $ref: '#/components/schemas/RESPONSE_200_TAAS'
              - type: object
                properties:
                  responseData:
                    allOf:
                    - $ref: '#/components/schemas/UpdateLoanResponse'
                    - type: object
                    properties:
                      customerReference:
                        writeOnly: true
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            Unencrypted Response - Success:
              value:
                code: EMKT200
                message: Success
                repliedTime: '2023-04-01 00:10:43'
                correlationId: efbf054e8f9c477493bfb3d2a19781b2
                responseData:
                  applicationId: 20230401SG02
                  loanNumber: LNSG23040102
                  status: Extension Submitted
                errorDetails: null
            Unencrypted Response - Bad Request Payload - Format:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_PAYLOAD_TAAS'
            Unencrypted Response - Bad Request Payload - Business Logic:
              summary: Unencrypted Response - Bad Request Payload (Business Logic)
              value:
                code: EMKT400
                message: Bad request payload
                repliedTime: "2023-04-01 00:10:43"
                correlationId: null
                responseData: null
                errorDetails:        
                - code: EMKT400-049,
                  message: Unable to find this trade loan, please check the loan number you entered.
                - code: EMKT400-050,
                  message: The Application still in progress, please try later or contact HSBC operations team for help.
                - code: EMKT400-051,
                  message: The current loan product type is invalid.       
                - code: EMKT400-055,
                  message: The automatically calculated loan loanExtensionMaturityDate must be later than the loanMaturityDate.
                - code: EMKT400-057,
                  message: The loan is expired.
                - code: EMKT400-106,
                  message: The transaction does not existed or status is not allowed.  
            Unencrypted Response - Internal Server Error:
              $ref: '#/components/examples/RESPONSE_200_INTERNAL_SERVER_ERROR_TAAS'
            Unencrypted Response - Decryption Failure:
              $ref: '#/components/examples/RESPONSE_200_DECRYPTION_FAILURE_TAAS'
            Unencrypted Response - Bad Request Header:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_HEADER_TAAS'
            Unencrypted Response - Auth Error:
              $ref: '#/components/examples/RESPONSE_200_AUTH_ERROR_TAAS'
            Unencrypted Response - Gateway Timeout:
              $ref: '#/components/examples/RESPONSE_200_GATEWAY_TIMEOUT_TAAS'
            Encrypted Response:
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS'
    SettleTradeLoanResponse:
      description: >-
        <strong>Success</strong>
        <section>
          <h6>To process the response:</h6>          
            <ol>
              <li>
              <strong>Receives response</strong> as per <code>EncryptedAndBase64Encoded_TAAS</code> schema. <strong>Decodes</strong> and <strong>decrypts</strong> it.
              <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"><sub>View guidance on Message Level Encryption</sub></a>
              <ol type="i">
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Encrypted Body - Base64 encoding</code>.</li>
                <li>
                  You may experience the full response journey via <strong>Smart Sandbox</strong>. <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="blank"><sub>How to Submit Loan Settlement Request via API in Sandbox Environment?</a>
                </li>
              </ol>
              </li>
              <li>
                <strong>Upon response is decrypted successful</strong>, you shall be able to obtain the <code>Unencrypted response</code> in <code>JSON</code> structure, as per <code>SettleTradeLoanResponse</code> schema.
                <ol type="i">               
                <li>Upon a Loan Settlement Request is submitted <strong>successfully</strong>, a <code>status</code> is changed to <code>Settlement Submitted</code>.</li>
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Unencrypted Response</code>.</li>
               </ol>
              </li>
            </ol>
        </section>
        <section>
          <h6>Linked Operations:</h6> 
          <ol>
            <li>
              Enquires <strong>status of this and many other loans</strong> that have been submitted via <code>Request Trade Loan Status API</code>. <a href="#operation/list-trade-loan-status"><sub>View Endpoint</sub></a>
            </li>
            <li>
              Enquires <strong>details of this loan</strong> of it via <code>Request Trade Loan Details API</code>. <a href="#operation/get-trade-loan-details"><sub>View Endpoint</sub></a>
            </li>
          </ol>
        </section>
      content:
        application/json:
          schema:
            oneOf:
            - title: SettleTradeLoanResponse
              allOf:
              - $ref: '#/components/schemas/RESPONSE_200_TAAS'
              - type: object
                properties:
                  responseData:
                    allOf:
                    - $ref: '#/components/schemas/UpdateLoanResponse'
                    - type: object
                    properties:
                      customerReference:
                        writeOnly: true
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            Unencrypted Response - Success:
              value:
                code: EMKT200
                message: Success
                repliedTime: '2023-04-01 00:20:43'
                correlationId: efbf054e8f9c477493bfb3d2a19781b2
                responseData:
                  applicationId: 20230401SG02
                  loanNumber: LNSG23040102
                  status: Settlement Submitted
                errorDetails: null
            Unencrypted Response - Bad Request Payload - Format:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_PAYLOAD_TAAS'
            Unencrypted Response - Bad Request Payload - Business Logic:
              summary: Unencrypted Response - Bad Request Payload (Business Logic)
              value:
                code: EMKT400
                message: Bad request payload
                repliedTime: "2023-04-01 00:20:43"
                correlationId: null
                responseData: null
                errorDetails:        
                - code: EMKT400-042,
                  message: The repaymentDate must be between today and the loanMaturityDate.
                - code: EMKT400-043,
                  message: The current loan is expired, repaymentDate must be equal to today.
                - code: EMKT400-045,
                  message: The repaymentAmount must be less than the loanAmountOutstanding.       
                - code: EMKT400-051,
                  message: The current loan product type is invalid.
                - code: EMKT400-057,
                  message: The loan is expired.
                - code: EMKT400-106,
                  message: The transaction does not existed or status is not allowed. 
            Unencrypted Response - Internal Server Error:
              $ref: '#/components/examples/RESPONSE_200_INTERNAL_SERVER_ERROR_TAAS'
            Unencrypted Response - Decryption Failure:
              $ref: '#/components/examples/RESPONSE_200_DECRYPTION_FAILURE_TAAS'
            Unencrypted Response - Bad Request Header:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_HEADER_TAAS'
            Unencrypted Response - Auth Error:
              $ref: '#/components/examples/RESPONSE_200_AUTH_ERROR_TAAS'
            Unencrypted Response - Gateway Timeout:
              $ref: '#/components/examples/RESPONSE_200_GATEWAY_TIMEOUT_TAAS'
            Encrypted Response:
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS'
    ListTradeLoanStatusResponse:
      description: >-
        <strong>Success</strong>
        <section>
          <h6>To process the response:</h6>          
            <ol>
              <li>
              <strong>Receives response</strong> as per <code>EncryptedAndBase64Encoded_TAAS</code> schema. <strong>Decodes</strong> and <strong>decrypts</strong> it.
              <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"><sub>View guidance on Message Level Encryption</sub></a>
              <ol type="i">
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Encrypted Body - Base64 encoding</code>.</li>
                <li>
                  You may experience the full response journey via <strong>Smart Sandbox</strong>. <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="blank"><sub>How to Submit Loan Settlement Request via API in Sandbox Environment?</a>
                </li>
              </ol>
              </li>
              <li>
                <strong>Upon response is decrypted successful</strong>, you shall be able to obtain the <code>Unencrypted response</code> in <code>JSON</code> structure, as per <code>SettleTradeLoanResponse</code> schema.
                <ol type="i">               
                <li>Upon successful enquiry, a list of loan transaction (up to specified <code>pageSize</code> is retrieved.</li>
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Unencrypted Response</code>.</li>
               </ol>
              </li>
            </ol>
        </section>
        <section>
          <h6>Linked Operations:</h6> 
          <ol>
            <li>
              Extends it's <strong>duration</strong> via <code>Submit Buyer Loan Extension Request API</code>. <a href="#operation/extend-standard-buyer-loans"><sub>View Endpoint</sub></a>
            </li>
            <li>
              Performs <strong>settlement</strong> via <code>Submit Buyer Loan Settlement Request API</code>. <a href="#operation/settle-standard-buyer-loans"><sub>View Endpoint</sub></a>
            </li>
            <li>
              Enquires <strong>details of this loan</strong> of it via <code>Request Trade Loan Details API</code>. <a href="#operation/get-trade-loan-details"><sub>View Endpoint</sub></a>
            </li>
          </ol>
        </section>
      content:
        application/json:
          schema:
            oneOf:
            - title: ListTradeLoanStatusResponse
              allOf:
              - $ref: '#/components/schemas/RESPONSE_200_TAAS'
              - type: object
                properties:
                  responseData:
                    required:
                    - records
                    allOf:
                    - $ref: '#/components/schemas/LIST_MODEL_RESPONSE_TAAS'
                    - type: object
                      nullable: true
                      properties:
                        records:
                          type: array
                          items:
                            allOf:
                            - $ref: '#/components/schemas/TradeLoanDetailModel'
                            - type: object
                              properties:  
                                status:
                                  minLength: 7
                                paymentAmount:
                                  writeOnly: true
                                typeOfGoods:
                                  writeOnly: true
                                loanAmountLoanCurrency:
                                  writeOnly: true
                                loanAmountOutstanding:
                                  writeOnly: true
                                totalInterestPaid:
                                  writeOnly: true
                                interestOutstanding:
                                  writeOnly: true
                                fixedOrVariableRateLoan:
                                  writeOnly: true
                                currentInterestRate:
                                  writeOnly: true
                                interestCalculationPreferenceCode:
                                  writeOnly: true
                                interestCollectionFrequencyCode:
                                  writeOnly: true
                                interestCalculationPreference:
                                  writeOnly: true
                                interestCollectionFrequency:
                                  writeOnly: true
                                loanRepaymentAccount:
                                  writeOnly: true
                                interestRepaymentAccount:
                                  writeOnly: true
                                chargesRepaymentAccount:
                                  writeOnly: true
                                goodsDescription:
                                  writeOnly: true
                                beneficiaryDetails:
                                  writeOnly: true
                                invoiceDetail:
                                  writeOnly: true
                                dateRecorded:
                                  writeOnly: true
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            Unencrypted Response - Success:
              value:
                code: EMKT200
                message: Success
                repliedTime: '2023-04-01 00:25:43'
                correlationId: efbf054e8f9c477493bfb3d2a19781b2
                responseData:
                  pageSize: '10'
                  pageNumber: '1'
                  totalCount: '7'
                  records:
                    - tradeAccountNumber: SGHSBC12345678912
                      productType: Buyer Loan
                      beneficiaryName: ''
                      customerReference: ''
                      loanNumber: LNSG23040102
                      paymentCurrency: ''
                      loanAmountInPaymentCurrency: ''
                      loanCurrency: SGD
                      status: Settlement Submitted
                      loanStartDate: '2023-04-01'
                      loanMaturityDate: '2023-05-29'
                      tenor: '60'
                      outstandingCurrency: USD
                      outstandingAmount: '750.00'
                      creationDateAndTime: ''
                    - tradeAccountNumber: SGHSBC12345678912
                      productType: Buyer Loan
                      beneficiaryName: ''
                      customerReference: ''
                      loanNumber: LNSG23040101
                      paymentCurrency: ''
                      loanAmountInPaymentCurrency: ''
                      loanCurrency: SGD
                      status: Submitted
                      loanStartDate: '2023-04-01'
                      loanMaturityDate: '2023-04-30'
                      tenor: '30'
                      outstandingCurrency: HKD
                      outstandingAmount: '5900.00'
                      creationDateAndTime: ''
                    - tradeAccountNumber: SGHSBC12345678912
                      productType: Buyer Loan
                      beneficiaryName: ''
                      customerReference: ''
                      loanNumber: LNSG23031502
                      paymentCurrency: ''
                      loanAmountInPaymentCurrency: ''
                      loanCurrency: SGD
                      status: Extension Submitted
                      loanStartDate: '2023-03-15'
                      loanMaturityDate: '2023-05-14'
                      tenor: '60'
                      outstandingCurrency: USD
                      outstandingAmount: '750.00'
                      creationDateAndTime: ''
                    - tradeAccountNumber: SGHSBC12345678912
                      productType: Buyer Loan
                      beneficiaryName: ''
                      customerReference: ''
                      loanNumber: LNSG23031501
                      paymentCurrency: ''
                      loanAmountInPaymentCurrency: ''
                      loanCurrency: SGD
                      status: Disbursed
                      loanStartDate: '2023-03-15'
                      loanMaturityDate: '2023-04-14'
                      tenor: '30'
                      outstandingCurrency: SGD
                      outstandingAmount: '1000.00'
                      creationDateAndTime: ''
                    - tradeAccountNumber: SGHSBC12345678912
                      productType: Buyer Loan
                      beneficiaryName: ''
                      customerReference: ''
                      loanNumber: LNSG23030103
                      paymentCurrency: ''
                      loanAmountInPaymentCurrency: ''
                      loanCurrency: SGD
                      status: Cancelled
                      loanStartDate: '2023-03-01'
                      loanMaturityDate: '2023-03-30'
                      tenor: '30'
                      outstandingCurrency: HKD
                      outstandingAmount: '0.00'
                      creationDateAndTime: ''
                    - tradeAccountNumber: SGHSBC12345678912
                      productType: Buyer Loan
                      beneficiaryName: ''
                      customerReference: ''
                      loanNumber: LNSG23030102
                      paymentCurrency: ''
                      loanAmountInPaymentCurrency: ''
                      loanCurrency: SGD
                      status: Settlement Submitted
                      loanStartDate: '2023-03-01'
                      loanMaturityDate: '2023-04-01'
                      tenor: '31'
                      outstandingCurrency: GBP
                      outstandingAmount: '610.00'
                      creationDateAndTime: ''
                    - tradeAccountNumber: SGHSBC12345678912
                      productType: Buyer Loan
                      beneficiaryName: ''
                      customerReference: ''
                      loanNumber: LNSG23030101
                      paymentCurrency: ''
                      loanAmountInPaymentCurrency: ''
                      loanCurrency: SGD
                      status: Settled
                      loanStartDate: '2023-03-01'
                      loanMaturityDate: '2023-03-30'
                      tenor: '30'
                      outstandingCurrency: JPY
                      outstandingAmount: '0.00'
                      creationDateAndTime: ''
            Unencrypted Response - Bad Request Payload - Format:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_PAYLOAD_TAAS'
            Unencrypted Response - Internal Server Error:
              $ref: '#/components/examples/RESPONSE_200_INTERNAL_SERVER_ERROR_TAAS'
            Unencrypted Response - Decryption Failure:
              $ref: '#/components/examples/RESPONSE_200_DECRYPTION_FAILURE_TAAS'
            Unencrypted Response - Bad Request Header:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_HEADER_TAAS'
            Unencrypted Response - Auth Error:
              $ref: '#/components/examples/RESPONSE_200_AUTH_ERROR_TAAS'
            Unencrypted Response - Gateway Timeout:
              $ref: '#/components/examples/RESPONSE_200_GATEWAY_TIMEOUT_TAAS'
            Encrypted Response:
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS'
    GetTradeLoanDetailResponse:
      description: >-
        <strong>Success</strong>
        <section>
          <h6>To process the response:</h6>          
            <ol>
              <li>
              <strong>Receives response</strong> as per <code>EncryptedAndBase64Encoded_TAAS</code> schema. <strong>Decodes</strong> and <strong>decrypts</strong> it.
              <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"><sub>View guidance on Message Level Encryption</sub></a>
              <ol type="i">
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Encrypted Body - Base64 encoding</code>.</li>
                <li>
                  You may experience the full response journey via <strong>Smart Sandbox</strong>. <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="blank"><sub>How to Request Loan Details via API in Sandbox Environment?</a>
                </li>
              </ol>
              </li>
              <li>
                <strong>Upon response is decrypted successful</strong>, you shall be able to obtain the <code>Unencrypted response</code> in <code>JSON</code> structure, as per <code>SettleTradeLoanResponse</code> schema.
                <ol type="i">               
                <li>Upon successful enquiry, the specified loan is retrieved.</li>
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Unencrypted Response</code>.</li>
               </ol>
              </li>
            </ol>
        </section>
        <section>
          <h6>Linked Operations:</h6> 
          <ol>
            <li>
              Extends it's <strong>duration</strong> via <code>Submit Buyer Loan Extension Request API</code>. <a href="#operation/extend-standard-buyer-loans"><sub>View Endpoint</sub></a>
            </li>
            <li>
              Performs <strong>settlement</strong> via <code>Submit Buyer Loan Settlement Request API</code>. <a href="#operation/settle-standard-buyer-loans"><sub>View Endpoint</sub></a>
            </li>
            <li>
              Enquires <strong>status of this and many other loans</strong> that have been submitted via <code>Request Trade Loan Status API</code>. <a href="#operation/list-trade-loan-status"><sub>View Endpoint</sub></a>
            </li>
          </ol>
        </section>
      content:
        application/json:
          schema:
            oneOf:
            - title: GetTradeLoanDetailResponse
              allOf:
              - $ref: '#/components/schemas/RESPONSE_200_TAAS'
              - type: object
                properties:
                  responseData:
                    allOf:
                    - $ref: '#/components/schemas/TradeLoanDetailModel'
                    - type: object
                      properties:
                        beneficiaryName:
                          writeOnly: true
                        outstandingAmount:
                          writeOnly: true
                        outstandingCurrency:
                          writeOnly: true
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            Unencrypted Response - Submitted:
              value:
                code: EMKT200
                message: Success
                repliedTime: '2023-04-01 00:25:43'
                correlationId: efbf054e8f9c477493bfb3d2a19781b2
                responseData:
                  tradeAccountNumber: SGHSBC123456789123
                  productType: Buyer Loan
                  loanNumber: LNSG23040101
                  status: Submitted
                  typeOfGoods: ''
                  customerReference: ''
                  loanStartDate: '2023-04-01'
                  tenor: '30'
                  loanMaturityDate: '2023-04-30'
                  paymentCurrency: ''
                  paymentAmount: ''
                  loanAmountInPaymentCurrency: ''
                  loanCurrency: SGD
                  loanAmountLoanCurrency: '1000.00'
                  loanAmountOutstanding: '5900.00'
                  creationDateAndTime: ''
                  loanRepaymentAccount: SGHSBC123456789123
                  interestCalculationPreference: ''
                  interestCollectionFrequency: ''
                  interestRepaymentAccount: SGHSBC123456789123
                  chargesRepaymentAccount: SGHSBC123456789123
                  currentInterestRate: '3.0566'
                  interestOutstanding: '0.00'
                  fixedOrVariableRateLoan: Fixed
                  dateRecorded: '2023-04-01'
                  totalInterestPaid: '0'
                  beneficiaryDetails:
                    - paymentMethod: ''
                      amountCurrency: ''
                      amount: ''
                      beneficiaryName: ''
                      beneficiaryReferenceNumber: ''
                      beneficiaryCountry: ''
                      beneficiaryAddressLine1: ''
                      beneficiaryAddressLine2: ''
                      beneficiaryAddressLine3: ''
                      beneficiaryBankAccount: 'AC-BEN-HK001'
                      beneficiaryBankName: 'BANK-HK001 Holdings Plc.'
                      beneficiaryBankSwiftBicBranchCode: 'HSBCSGS2001'
                      beneficiaryBankCountry: 'HK'
                      beneficiaryBankAddressLine1: 'BANK-HK001 Tower #01-01'
                      beneficiaryBankAddressLine2: '1 BANK-HK001 Street'
                      beneficiaryBankAddressLine3: 'HONG KONG'
            Unencrypted Response - Disbursed:
              value:
                code: EMKT200
                message: Success
                repliedTime: '2023-04-01 00:25:43'
                correlationId: efbf054e8f9c477493bfb3d2a19781b2
                responseData:
                  tradeAccountNumber: SGHSBC123456789123
                  productType: Buyer Loan
                  loanNumber: LNSG23031501
                  status: Disbursed
                  typeOfGoods: ''
                  customerReference: ''
                  loanStartDate: '2023-03-15'
                  tenor: '30'
                  loanMaturityDate: '2023-04-14'
                  paymentCurrency: ''
                  paymentAmount: ''
                  loanAmountInPaymentCurrency: ''
                  loanCurrency: SGD
                  loanAmountLoanCurrency: '1000.00'
                  loanAmountOutstanding: '750.00'
                  creationDateAndTime: ''
                  loanRepaymentAccount: SGHSBC123456789123
                  interestCalculationPreference: ''
                  interestCollectionFrequency: ''
                  interestRepaymentAccount: SGHSBC123456789123
                  chargesRepaymentAccount: SGHSBC123456789123
                  currentInterestRate: '3.0566'
                  interestOutstanding: '0.00'
                  fixedOrVariableRateLoan: Fixed
                  dateRecorded: '2023-03-15'
                  totalInterestPaid: '0'
                  beneficiaryDetails:
                    - paymentMethod: ''
                      amountCurrency: ''
                      amount: ''
                      beneficiaryName: ''
                      beneficiaryReferenceNumber: ''
                      beneficiaryCountry: ''
                      beneficiaryAddressLine1: ''
                      beneficiaryAddressLine2: ''
                      beneficiaryAddressLine3: ''
                      beneficiaryBankAccount: 'AC-BEN-US001'
                      beneficiaryBankName: 'BANK-US001 Holdings Plc.'
                      beneficiaryBankSwiftBicBranchCode: 'HSBCSGS2001'
                      beneficiaryBankCountry: 'SG'
                      beneficiaryBankAddressLine1: 'BANK-US001 Tower #01-01'
                      beneficiaryBankAddressLine2: '1 BANK-SG001 Street'
                      beneficiaryBankAddressLine3: 'USA'
            Unencrypted Response - Extension Submitted:
              value:
                code: EMKT200
                message: Success
                repliedTime: '2023-04-01 00:25:43'
                correlationId: efbf054e8f9c477493bfb3d2a19781b2
                responseData:
                  tradeAccountNumber: SGHSBC123456789123
                  productType: Buyer Loan
                  loanNumber: LNSG23031502
                  status: Extension Submitted
                  typeOfGoods: ''
                  customerReference: ''
                  loanStartDate: '2023-03-15'
                  tenor: '60'
                  loanMaturityDate: '2023-05-14'
                  paymentCurrency: ''
                  paymentAmount: ''
                  loanAmountInPaymentCurrency: ''
                  loanCurrency: SGD
                  loanAmountLoanCurrency: '1000.00'
                  loanAmountOutstanding: '1000.00'
                  creationDateAndTime: ''
                  loanRepaymentAccount: SGHSBC123456789123
                  interestCalculationPreference: ''
                  interestCollectionFrequency: ''
                  interestRepaymentAccount: SGHSBC123456789123
                  chargesRepaymentAccount: SGHSBC123456789123
                  currentInterestRate: '3.0566'
                  interestOutstanding: '0.00'
                  fixedOrVariableRateLoan: Fixed
                  dateRecorded: '2023-04-01'
                  totalInterestPaid: '0'
                  beneficiaryDetails:
                    - paymentMethod: ''
                      amountCurrency: ''
                      amount: ''
                      beneficiaryName: ''
                      beneficiaryReferenceNumber: ''
                      beneficiaryCountry: ''
                      beneficiaryAddressLine1: ''
                      beneficiaryAddressLine2: ''
                      beneficiaryAddressLine3: ''
                      beneficiaryBankAccount: 'AC-BEN-SG001'
                      beneficiaryBankName: 'BANK-SG001 Holdings Plc.'
                      beneficiaryBankSwiftBicBranchCode: 'HSBCSGS2001'
                      beneficiaryBankCountry: 'SG'
                      beneficiaryBankAddressLine1: 'BANK-SG001 Tower #01-01'
                      beneficiaryBankAddressLine2: '1 BANK-SG001 Street'
                      beneficiaryBankAddressLine3: 'SINGAPORE 12345'
            Unencrypted Response - Settlement Submitted:
              value:
                code: EMKT200
                message: Success
                repliedTime: '2023-04-01 00:25:43'
                correlationId: efbf054e8f9c477493bfb3d2a19781b2
                responseData:
                  tradeAccountNumber: SGHSBC123456789123
                  productType: Buyer Loan
                  loanNumber: LNSG23030102
                  status: Settlement Submitted
                  typeOfGoods: ''
                  customerReference: ''
                  loanStartDate: '2023-03-01'
                  tenor: '31'
                  loanMaturityDate: '2023-04-01'
                  paymentCurrency: ''
                  paymentAmount: ''
                  loanAmountInPaymentCurrency: ''
                  loanCurrency: GBP
                  loanAmountLoanCurrency: '1000.00'
                  loanAmountOutstanding: '610.00'
                  creationDateAndTime: ''
                  loanRepaymentAccount: SGHSBC123456789123
                  interestCalculationPreference: ''
                  interestCollectionFrequency: ''
                  interestRepaymentAccount: SGHSBC123456789123
                  chargesRepaymentAccount: SGHSBC123456789123
                  currentInterestRate: '3.0566'
                  interestOutstanding: '0.00'
                  fixedOrVariableRateLoan: Fixed
                  dateRecorded: '2023-04-01'
                  totalInterestPaid: '0'
                  beneficiaryDetails:
                    - paymentMethod: ''
                      amountCurrency: ''
                      amount: ''
                      beneficiaryName: ''
                      beneficiaryReferenceNumber: ''
                      beneficiaryCountry: ''
                      beneficiaryAddressLine1: ''
                      beneficiaryAddressLine2: ''
                      beneficiaryAddressLine3: ''
                      beneficiaryBankAccount: 'AC-BEN-GB001'
                      beneficiaryBankName: 'BANK-GB001 Holdings Plc.'
                      beneficiaryBankSwiftBicBranchCode: 'HSBCSGS2001'
                      beneficiaryBankCountry: 'GB'
                      beneficiaryBankAddressLine1: 'BANK-GB001 Tower #01-01'
                      beneficiaryBankAddressLine2: '1 BANK-GB001 Street'
                      beneficiaryBankAddressLine3: 'UNITED KINGDOM'
            Unencrypted Response - Settled:
              value:
                code: EMKT200
                message: Success
                repliedTime: '2023-04-01 00:25:43'
                correlationId: efbf054e8f9c477493bfb3d2a19781b2
                responseData:
                  tradeAccountNumber: SGHSBC123456789123
                  productType: Buyer Loan
                  loanNumber: LNSG23030101
                  status: Settled
                  typeOfGoods: ''
                  customerReference: ''
                  loanStartDate: '2023-03-01'
                  tenor: '30'
                  loanMaturityDate: '2023-03-30'
                  paymentCurrency: ''
                  paymentAmount: ''
                  loanAmountInPaymentCurrency: ''
                  loanCurrency: SGD
                  loanAmountLoanCurrency: '1000.00'
                  loanAmountOutstanding: '0.00'
                  creationDateAndTime: ''
                  loanRepaymentAccount: SGHSBC123456789123
                  interestCalculationPreference: ''
                  interestCollectionFrequency: ''
                  interestRepaymentAccount: SGHSBC123456789123
                  chargesRepaymentAccount: SGHSBC123456789123
                  currentInterestRate: '3.0566'
                  interestOutstanding: '0.00'
                  fixedOrVariableRateLoan: Fixed
                  dateRecorded: '2023-03-30'
                  totalInterestPaid: '0'
                  beneficiaryDetails:
                    - paymentMethod: ''
                      amountCurrency: ''
                      amount: ''
                      beneficiaryName: ''
                      beneficiaryReferenceNumber: ''
                      beneficiaryCountry: ''
                      beneficiaryAddressLine1: ''
                      beneficiaryAddressLine2: ''
                      beneficiaryAddressLine3: ''
                      beneficiaryBankAccount: 'AC-BEN-JP001'
                      beneficiaryBankName: 'BANK-JP001 Holdings Plc.'
                      beneficiaryBankSwiftBicBranchCode: 'HSBCSGS2001'
                      beneficiaryBankCountry: 'SG'
                      beneficiaryBankAddressLine1: 'BANK-JP001 Tower #01-01'
                      beneficiaryBankAddressLine2: '1 BANK-JP001 Street'
                      beneficiaryBankAddressLine3: 'JAPAN'  
            Unencrypted Response - Cancelled:
              value:
                code: EMKT200
                message: Success
                repliedTime: '2023-04-01 00:25:43'
                correlationId: efbf054e8f9c477493bfb3d2a19781b2
                responseData:
                  tradeAccountNumber: SGHSBC123456789123
                  productType: Buyer Loan
                  loanNumber: LNSG23030103
                  status: Cancelled
                  typeOfGoods: ''
                  customerReference: ''
                  loanStartDate: '2023-03-01'
                  tenor: '30'
                  loanMaturityDate: '2023-03-30'
                  paymentCurrency: ''
                  paymentAmount: ''
                  loanAmountInPaymentCurrency: ''
                  loanCurrency: SGD
                  loanAmountLoanCurrency: '1000.00'
                  loanAmountOutstanding: '0.00'
                  creationDateAndTime: ''
                  loanRepaymentAccount: SGHSBC123456789123
                  interestCalculationPreference: ''
                  interestCollectionFrequency: ''
                  interestRepaymentAccount: SGHSBC123456789123
                  chargesRepaymentAccount: SGHSBC123456789123
                  currentInterestRate: '3.0566'
                  interestOutstanding: '0.00'
                  fixedOrVariableRateLoan: Fixed
                  dateRecorded: '2023-03-01'
                  totalInterestPaid: '0'
                  beneficiaryDetails:
                    - paymentMethod: ''
                      amountCurrency: ''
                      amount: ''
                      beneficiaryName: ''
                      beneficiaryReferenceNumber: ''
                      beneficiaryCountry: ''
                      beneficiaryAddressLine1: ''
                      beneficiaryAddressLine2: ''
                      beneficiaryAddressLine3: ''
                      beneficiaryBankAccount: 'AC-BEN-HK001'
                      beneficiaryBankName: 'BANK-HK001 Holdings Plc.'
                      beneficiaryBankSwiftBicBranchCode: 'HSBCSGS2001'
                      beneficiaryBankCountry: 'HK'
                      beneficiaryBankAddressLine1: 'BANK-HK001 Tower #01-01'
                      beneficiaryBankAddressLine2: '1 BANK-HK001 Street'
                      beneficiaryBankAddressLine3: 'HONG KONG'
            Unencrypted Response - Bad Request Payload - Format:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_PAYLOAD_TAAS'
            Unencrypted Response - Internal Server Error:
              $ref: '#/components/examples/RESPONSE_200_INTERNAL_SERVER_ERROR_TAAS'
            Unencrypted Response - Decryption Failure:
              $ref: '#/components/examples/RESPONSE_200_DECRYPTION_FAILURE_TAAS'
            Unencrypted Response - Bad Request Header:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_HEADER_TAAS'
            Unencrypted Response - Auth Error:
              $ref: '#/components/examples/RESPONSE_200_AUTH_ERROR_TAAS'
            Unencrypted Response - Gateway Timeout:
              $ref: '#/components/examples/RESPONSE_200_GATEWAY_TIMEOUT_TAAS'
            Encrypted Response:
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS'
  ## Trade Loan reusable responses
    UploadSupportingDocumentResponse:
      description: >-
        <strong>Success</strong>
        <section>
          <h6>To process the response:</h6>          
            <ol>
              <li>
              <strong>Receives response</strong> as per <code>EncryptedAndBase64Encoded_TAAS</code> schema. <strong>Decodes</strong> and <strong>decrypts</strong> it.
              <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"><sub>View guidance on Message Level Encryption</sub></a>
              <ol type="i">
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Encrypted Body - Base64 encoding</code>.</li>
                <li>
                  You may experience the full response journey via <strong>Smart Sandbox</strong>. <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="blank"><sub>How to Request Loan Details via API in Sandbox Environment?</a>
                </li>
              </ol>
              </li>
              <li>
                <strong>Upon response is decrypted successful</strong>, you shall be able to obtain the <code>Unencrypted response</code> in <code>JSON</code> structure, as per <code>SettleTradeLoanResponse</code> schema.
                <ol type="i">               
                <li>Upon submitted documents are received for processing, a <code>docUploadRequestId</code> will be generated. These values are input for other <code>linked operations</code>.</li>
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Unencrypted Response</code>.</li>
               </ol>
              </li>
            </ol>
        </section>
        <section>
          <h6>Linked Operations:</h6> 
          <ol>
            <li>Enquire status of submitted document(s) via <code>Request Supporting Document Status API</code>. <a href="#operation/list-supporting-document-status"><sub>View Endpoint</sub></a></li>                  
          </ol>
        </section>
      content:
        application/json:
          schema:
            oneOf:
            - title: UnencryptedResponse
              allOf:
              - $ref: '#/components/schemas/RESPONSE_200_TAAS'
              - type: object
                properties:
                  responseData:
                    allOf:
                    - $ref: '#/components/schemas/DocumentListModel'
                    - type: object
                      properties:
                        accountNumber:
                          writeOnly: true
                        docDetails:
                          writeOnly: true
                        docId:
                          writeOnly: true
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            Unencrypted Response - Success:
              value:
                code: EMKT200
                message: Success
                repliedTime: '2023-04-01 00:00:43'
                correlationId: efbf054e8f9c477493bfb3d2a19781b2
                responseData:
                  docUploadRequestId: efbf054e8f9c477493bfb3d2a19781b2
                errorDetails: null
            Unencrypted Response - Bad Request Payload - Format:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_PAYLOAD_TAAS'
            Unencrypted Response - Internal Server Error:
              $ref: '#/components/examples/RESPONSE_200_INTERNAL_SERVER_ERROR_TAAS'
            Unencrypted Response - Bad Request Header:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_HEADER_TAAS'
            Unencrypted Response - Auth Error:
              $ref: '#/components/examples/RESPONSE_200_AUTH_ERROR_TAAS'
            Unencrypted Response - Gateway Timeout:
              $ref: '#/components/examples/RESPONSE_200_GATEWAY_TIMEOUT_TAAS'
            Encrypted Response:
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS'           
    ListSupportingDocumentStatusResponse:
      description: >-
        <strong>Success</strong>
        <section>
          <h6>To process the response:</h6>          
            <ol>
              <li>
              <strong>Receives response</strong> as per <code>EncryptedAndBase64Encoded_TAAS</code> schema. <strong>Decodes</strong> and <strong>decrypts</strong> it.
              <a href="https://develop.hsbc.com/node/665#apidoccontentid-926" target="_blank"><sub>View guidance on Message Level Encryption</sub></a>
              <ol type="i">
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Encrypted Body - Base64 encoding</code>.</li>
                <li>
                  You may experience the full response journey via <strong>Smart Sandbox</strong>. <a href="https://develop.hsbc.com/node/665#apidoccontentid-2192" target="blank"><sub>How to Request Loan Details via API in Sandbox Environment?</a>
                </li>
              </ol>
              </li>
              <li>
                <strong>Upon response is decrypted successful</strong>, you shall be able to obtain the <code>Unencrypted response</code> in <code>JSON</code> structure, as per <code>SettleTradeLoanResponse</code> schema.
                <ol type="i">               
                <li>Upon successful enquiry, a list of <code>docId</code> and <code>documentName</code> will be retrieved. These values are inputs for other <code>linked operations</code>.</li>
                <li>An example is available under <code>Response samples</code>/ <code>Example</code>/ <code>Unencrypted Response</code>.</li>
               </ol>
              </li>
            </ol>
        </section>
        <section>
          <h6>Linked Operations:</h6> 
          <ol>
            <li>Submit Buyer Loan Application Request via <code>Submit Buyer Loan Application Request API</code>. <a href="https://develop.hsbc.com/node/665/endpoints#operation/create-standard-buyer-loan-applications" target="blank"><sub>View Endpoint</sub></a></li>
            <li>Submit Buyer Loan Application Request via <code>Submit Buyer Loan Application Request API</code>. <a href="https://develop.hsbc.com/node/668/endpoints#operation/create-standard-buyer-loan-applications" target="blank"><sub>View Endpoint</sub></a></li>
          </ol>
        </section>
      content:
        application/json:
          schema:
            oneOf:
            - title: ListSupportingDocumentStatusResponse
              allOf:
              - $ref: '#/components/schemas/RESPONSE_200_TAAS'
              - type: object
                properties:
                  responseData:
                    allOf:
                    - $ref: '#/components/schemas/SupportingDocumentModel'
                    - type: object
                      properties:
                        accountNumber:
                          writeOnly: true  
                        docName:
                          writeOnly: true
            - $ref: '#/components/schemas/EncryptedAndBase64Encoded_TAAS'
          examples:
            Unencrypted Response - Success:
              value:
                code: EMKT200
                message: Success
                repliedTime: '2023-04-01 00:00:43'
                correlationId: efbf054e8f9c477493bfb3d2a19781b2
                responseData:
                  formType: P
                  docId: idd_10349C86-0000-C515-AB9B-65B893B9744B
                  documentName: test.tif
                  docStatus: In Progress
                  numPages: '1'
                  imageFormat: BMP
                  imageBytes: '409844'
                  hash: F4318B5E707877F3B1DC3BE48708E532
                errorDetails: null
            Unencrypted Response - Bad Request Payload - Format:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_PAYLOAD_TAAS'
            Unencrypted Response - Internal Server Error:
              $ref: '#/components/examples/RESPONSE_200_INTERNAL_SERVER_ERROR_TAAS'
            Unencrypted Response - Decryption Failure:
              $ref: '#/components/examples/RESPONSE_200_DECRYPTION_FAILURE_TAAS'
            Unencrypted Response - Bad Request Header:
              $ref: '#/components/examples/RESPONSE_200_BAD_REQUEST_HEADER_TAAS'
            Unencrypted Response - Auth Error:
              $ref: '#/components/examples/RESPONSE_200_AUTH_ERROR_TAAS'
            Unencrypted Response - Gateway Timeout:
              $ref: '#/components/examples/RESPONSE_200_GATEWAY_TIMEOUT_TAAS'
            Encrypted Response:
              $ref: '#/components/examples/EncryptedAndBase64Encoded_TAAS'
    GetHealth_RESPONSE_200_TAAS:
      description: Returned health status.
      content:
        application/json:
          schema:
            title: GetHealth_RESPONSE_200_TAAS
            allOf:
            - $ref: '#/components/schemas/RESPONSE_200_TAAS' 
            - properties:
                responseData:
                  example: null
  # TRADE FINANCE COMMON RESPONSE MODEL
    RESPONSE_400_TAAS:
      description: >-
        **Bad Request**
    RESPONSE_401_TAAS:
      description: |-
        <strong>Unauthorised</strong>  
          <details>
          <summary>View Response Codes:</summary>
            <table>
              <thead>
                  <tr>
                      <th>HSBC API Response Code</th>
                      <th>Scenario/ Troubleshooting</th>
                  </tr>
              </thead>
              <tbody>
                  <tr>
                      <td>EDSPER1001</td>
                      <td>Mandatory field Kid is missing or invalid in the customer JWT header</td>
                  </tr>
                  <tr>
                      <td>EDSPER1002</td>
                      <td>Invalid PGP Key , Key is set to never expiry</td>
                  </tr>
                  <tr>
                      <td>EDSPER1003</td>
                      <td>Invalid PGP Key , Key is expired</td>
                  </tr>
                  <tr>
                      <td>EDSPER1004</td>
                      <td>Invalid PGP Key</td>
                  </tr>
                  <tr>
                      <td>EDSPER1005</td>
                      <td>Customer JWT is expired</td>
                  </tr>
                  <tr>
                      <td>EDSPER1006</td>
                      <td>Mandatory field claim "iat" is missing or invalid from customer JWT header</td>
                  </tr>
                  <tr>
                      <td>EDSPER1007</td>
                      <td>Mandatory field claim  "Alg" is missing or invalid  in customer JWT header</td>
                  </tr>
                  <tr>
                      <td>EDSPER1008</td>
                      <td>Mandatory field Sub (profile id) is missing or invalid in customer JWT body</td>
                  </tr>
                  <tr>
                      <td>EDSPER2002</td>
                      <td>Internal Error. Please contact HSBC technical support.</td>
                  </tr>
                  <tr>
                      <td>EDSPER2003</td>
                      <td>Mandatory field jti is missing or invalid in customer JWT payload</td>
                  </tr>
                  <tr>
                      <td>EDSPER2004 : User account is locked</td>
                      <td>Please contact HSBC technical support.</td>
                  </tr>
                  <tr>
                      <td>EDSPER2005</td>
                      <td>JWT Signature validation failed / Invalid JWT Signature</td>
                  </tr>
                  <tr>
                      <td>EDSPER2006</td>
                      <td>Blocked access to user accessing from sanctioned country</td>
                  </tr>
                  <tr>
                      <td>EDSPER2007</td>
                      <td>IP address missing so sanctioned country check failed.</td>
                  </tr>
                  <tr>
                      <td>EDSPER2008 : Authentication Token missing</td>
                      <td>Invalid Authentication Token</td>
                  </tr>
                  <tr>
                      <td>EDSPER2009 : Client Token or Payload is in Invalid format</td>
                      <td>Either Client Token or Payload is in Invalid format</td>
                  </tr>
                  <tr>
                      <td>EDSPER2010</td>
                      <td>Mandatory field aud is missing or invalid in customer JWT payload</td>
                  </tr>
                  <tr>
                      <td>EDSPER2011 : Client Token or Payload is in Invalid format</td>
                      <td>Customer Token or Payload is invalid - payload hash mismatch.</td>
                  </tr>
                  <tr>
                      <td>EDSPER2012 : Mandatory field ver is missing or invalid</td>
                      <td>Mandatory field ver is missing or invalid from JWT header</td>
                  </tr>
                  <tr>
                      <td>EDSPER2013 : User Login credentials are invalid</td>
                      <td>User Login credentials are invalid</td>
                  </tr>
                  <tr>
                      <td>EDSPER2014 : Partner-customer relationship verification failed</td>
                      <td>Please contact HSBC technical support.</td>
                  </tr>
                  <tr>
                      <td>EDSPEX2001</td>
                      <td>Please contact HSBC technical support.</td>
                  </tr>
              </tbody>
          </table>
          </details>     
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                description: Authorization error code."
                type: string
                minLength: 10
                maxLength: 255
                enum:
                - 'EDSPER1001'
                - 'EDSPER1002'
                - 'EDSPER1003'
                - 'EDSPER1004'
                - 'EDSPER1005: JWT token expired'
                - 'EDSPER1006'
                - 'EDSPER1007'
                - 'EDSPER1008'
                - 'EDSPER2002'
                - 'EDSPER2003'
                - 'EDSPER2004'
                - 'EDSPER2005'
                - 'EDSPER2006'
                - 'EDSPER2007'
                - 'EDSPER2008: Authentication Token missing'
                - 'EDSPER2009: Client Token or Payload is in Invalid format'
                - 'EDSPER2010'
                - 'EDSPER2011: Client Token or Payload is in Invalid format'
                - 'EDSPER2012: Mandatory field ver is missing or invalid'
                - 'EDSPER2013: User Login credentials are invalid'
                - 'EDSPER2014: Partner-customer relationship verification failed'
                - 'EDSPEX2001'
                example: "EDSPER2008: Authentication Token missing"
              message:
                description: "Authorization error description."
                type: string
                minLength: 1
                maxLength: 255
                enum:
                - 'Unauthorized: invalid authentication credentials'
                example: "Unauthorized: invalid authentication credentials"
          examples:
            Unauthorized:
              summary: Unauthorized
              description: >-
                `JSON Web Token` may contain invalid data parameters - check `Authorization` in `request header`.
                <details> 
                  Please refer to [API Security at HSBC](#authentication) - Using JWT with Client Private Key.
                </details>
              value: 
                code: 'EDSPER1005 : JWT token expired'
                message: 'Unauthorized: invalid authentication credentials'
    RESPONSE_403_TAAS:
      description: >-
        **Forbidden**
      content:
        application/json:
          schema:
            type: object
            description: "Forbidden"
            properties:
              errorInfo:
                type: array
                items:
                  type: object
                  properties:
                    code:
                      description: "Forbidden error type."
                      type: string               
                      maxLength: 255
                      example: "Saml signing error"
          examples:
            Forbidden:
              summary: Forbidden
              description: Saml Signing Error.
              value: 
                code: 'Saml signing error'
    RESPONSE_404_TAAS:
      description: >-
        **Not Found**
      content:
        text/plain:
          schema:
            type: string
            description: "Resource not found"
            maxLength: 18
            enum:
            - 'resource not found'
          examples:
            Not_Found:
              summary: Not Found
              description: Requested Resource not found – double check HTTP URL.
              value: 'resource not found'
    RESPONSE_500_TAAS:
      description: >-
        **Internal Server Error**
      content:
        text/plain:
          schema:
            description: "Internal Server Error"
            type: string
            maxLength: 255
          examples:
            Internal_Server_Error:
              summary: Internal Server Error
              description: 'Issue encountered within HSBC systems (internal server or solution component is not available)'
              value: 'Upstream connect error or disconnect/reset before headers. reset reason: connection failure'
    RESPONSE_502_TAAS:
      description: >-
        **Bad Gateway**
      content:
        text/plain:
          schema:
            description: "Bad Gateway"
            type: string
            maxLength: 255
          examples:
            Bad_Gateway:
              summary: Bad Gateway
              description: 'Issue encountered within HSBC systems (internal server or solution component is not available)'
              value: 'Bad Gateway'
    RESPONSE_503_TAAS:
      description: >-
        **Service Unavailable**
      content:
        text/plain:
          schema:
            description: "Internal Server Error"
            type: string
            maxLength: 255
          examples:
            Service_Unavailable:
              summary: Service Unavailable
              description: 'Issue encountered within HSBC systems (internal server or solution component is not available)'
              value: 'Upstream connect error or disconnect/reset before headers. reset reason: connection failure'
    RESPONSE_504_TAAS:
      description: >-
        **Gateway Timeout**
      content:
        text/plain:
          schema:
            description: "Gateway Timeout"
            type: string
            maxLength: 255
          examples:
            Gateway_Timeout:
              summary: Gateway Timeout
              description: 'Request Timeout'
              value: 'Gateway Timeout'
  # Reusable examples            
  examples:
    EncryptedAndBase64Encoded_TAAS:
      summary: Encrypted Body - Base64 encoding
      description: >-
        This is how the encrypted message body would look like. Refer to example from <a href="https://develop.hsbc.com/node/645#apidoccontentid-2153" target="_blank">Making an API Request via Sandbox Environment?</a>  
      value: LS0tLS1CRUdJTiBQR1AgTUVTU0FHRS0tLS0tClZlcnNpb246IEJDUEcgdjEuNjIKCmhRRU1BME5ITzJHRVpzN2RBUWYvYWw0cTRZdVRscnRqSHVlYURRN1ZKVldiOGdzN3pMT2pBY3BKakJub0pqbnHKYURXNmRKRFFxc1VPelZSQXZtUmpsUEtTbDQ1cmhoSXIvM05JTDFLZDBGQnpTVm5OdXV4eUhiNDVYZDFGOVpJaApKekZmMTdpRkhvUXI1d0hjN1U4UTc1MWxXTVE0T1RJRURVMXVhYXNRR2p5SXRlUzcycmkxYzdlMWdIK0tRenZmCllHU0cxd2ZiTmd6TTdOdkY3dGdLbjZoM2JVcXc2SE5XOHBFNHBxMDczRkcrekU3UUNnNjFFaTB3QUJIbXJjS2MKZEZBTHBWYkhtVFpBMnhZczVOZWVmcEFabnB6WENoanZncU9xMnhLaEl4clJaeXk3RzVESUNNNGhEK0w3ZDQyMApHK0RPcE5OYkdjRmdTbWd5YS94S3BZWXFUN3MwMkdJNmI3SVNoNTRnSDlMQVl3R1VUMDhMU0QzaS9NMExDQ1g4Cmg5OWhsUDZiT3hJalpSbk10OUJCZG52MUZiVnlYUGxiWDJSL2lkZHV5Wnd4MW10LzdlMk96M2Q0dGRzK0hzMU8KZ3lwVVFwM1hzUTYrWlQzVmdwRDFudHg2eWRuR3NSbDBTVnBHbExKZ2hsbXY1SGVWcUpqenVXSndoZnpPZHUxOAp3dVNMNVJDMkRtdHA5UDZFdjY1Y1BoYVRsVGs1SHI5QXg1SWswQnNSbGVhR01XVStMTHNTbTBTSnhzWnlRTEQvCnhWQ0JVTkRFM3pkYXA2RHV6eE04ZXdwblBaclI3amhuRHQ2dXBwcU1ET1JtZlh1Q3VNYThGclRMTFpVL1VoUTEKTTJ3cnVvR0krdHp0c09oZWRhZHZPaDlSSEdyZTA2anFGQ2Jqb1FldkhqT2l0U3Y3MEgyR3F1N2syUVZmK2R0Uwp3U1A1MStHTWx1ekljY3pzNjhVQVNpOUN1dVFnUXdGMVRYclA1SStZUzgxU21CZUxOZz09Cj1WaHI3Ci0tLS0tRU5EIFBHUCBNRVNTQUdFLS0tLS0K
    RESPONSE_200_AUTH_ERROR_TAAS:
      summary: Unencrypted Response - Authorization Error
      description: >-
        The `tradeAccountNumber` is not authorized under the `extnlCustomerId`. 
      value:
        code: EMKT105
        message: Authentication check failed!
        repliedTime: "2023-04-01 00:00:43"
        correlationId: null
        responseData: null
        errorDetails: 
          code: EMKT400-001,
          message: The account number does not match our records.
    RESPONSE_200_BAD_REQUEST_PAYLOAD_TAAS:
      summary: Unencrypted Response - Bad Request Payload (Format)
      description: >-
        Invalid inputs in the `request payload`.
          - `EMKT400-001` is an example of a request parameter that must not be `empty`.
          - `EMKT400-002` is an example of a request parameter's `size` is invalid.
          - `EMKT400-003` is an example of a request parameter's is `missing`.
          - `EMKT400-004` is an example of a request parameter's `format` is invalid.
          - `EMKT400-005` is an example of a request parameter's `format` (within an `object`) is invalid.
          - `EMKT400-006` is an example of a request parameter's `format` (within `array[0]`) is invalid.
      value:
        code: EMKT400
        message: Bad request payload
        repliedTime: "2023-04-01 00:00:43"
        correlationId: null
        responseData: null
        errorDetails: 
        - code: EMKT400-001,
          message: paraName001 must not be blank.
        - code: EMKT400-002,
          message: paraName002 size must be between 0 and 30
        - code: EMKT400-003
          message: paraName003 cannot be deleted, please input null value instead of deleting optional parameter.
        - code: EMKT400-004,
          message: dateName004 data entered in incorrect format.
        - code: EMKT400-005,
          message: objectName005.paramName001 must not be blank.
        - code: EMKT400-006,
          message: arrayName006[0].paramName001 must not be blank.
        - code: EMKT400-0XX,
          message: The miscStates should be a json string.
    RESPONSE_200_BAD_REQUEST_HEADER_TAAS:
      summary: Unencrypted Response - Bad Request Header (EMKT105)
      description: >-
        Missing parameter(s) in `request header`. Please validate'
      value:
        code: EMKT105
        message: Authentication check failed!
        repliedTime: "2023-04-01 00:00:43"
        correlationId: "efbf054e8f9c477493bfb3d2a19781b2"
        responseData: null
        errorDetails: 
        - code: EMKT121,
          message: Not found requestId in header
        - code: EMKT122,
          message: Not found requestTime in header
    RESPONSE_200_DECRYPTION_FAILURE_TAAS:
      summary: Unencrypted Response - Decryption Failure (EMKT103)
      description: 'HSBC systems unable to decrypt the request. Please verify credentials and encryptions'
      value:
        code: EMKT103
        message: DECRYPTION_FAILURE
        repliedTime: "2023-04-01 00:00:43"
        correlationId: "efbf054e8f9c477493bfb3d2a19781b2"
        responseData: null
        errorDetails: 
        - code: EMKT103,
          message: DECRYPTION_FAILURE
    RESPONSE_200_GATEWAY_TIMEOUT_TAAS:
      summary: Unencrypted Response - Gateway Timeout (EMKT107)
      value:
        code: EMKT107
        message: GATEWAY_TIMEOUT
        repliedTime: "2023-04-01 00:00:43"
        correlationId: "efbf054e8f9c477493bfb3d2a19781b2"
        responseData: null
        errorDetails: 
        - code: EMKT107,
          message: GATEWAY_TIMEOUT
    RESPONSE_200_INTERNAL_SERVER_ERROR_TAAS:
      summary: Unencrypted Response - Internal Server Error (EMKT102)
      description: 'Request successfully authenticated by gateway, however issue encountered within HSBC downstream systems (internal server or solution component is not available)'
      value:
        code: EMKT102
        message: INTERNAL_SERVER_ERROR
        repliedTime: "2023-04-01 00:00:43"
        correlationId: "efbf054e8f9c477493bfb3d2a19781b2"
        responseData: null
        errorDetails: 
        - code: EMKT102,
          message: INTERNAL_SERVER_ERROR
    RESPONSE_200_INTERNAL_EXCHANGE_FAILED_TAAS_WDM:
      summary: Unencrypted Response - Internal Exchange Failed (EMKT106)
      description: 'Request successfully authenticated by gateway, however issue encountered within HSBC downstream systems (internal server or solution component is not available)'
      value:
        code: EMKT500
        message: Internal exchange failed!
        repliedTime: "2023-04-01 00:00:43"
        correlationId: "efbf054e8f9c477493bfb3d2a19781b2"
        responseData: null
        errorDetails: 
        - code: EMKT106,
          message: Internal exchange failed! The Bank workflow system currently offline.
  parameters:
    # Common Headers
    # Reusable Headers (Use these headers for TaaS Eb2b)
    Authorization:
      name: Authorization
      in: header       
      description: >
        <p>Your <strong>Digital Identity</strong>, which is a <strong>private-key-signed</strong> <code>Bearer Token</code> generated <strong>per request</strong> with the prefix <code>JWS</code>.<br> 
        <a href="#authentication"><sub>What is Bearer Token ?</sub></p>
      required: true
      schema:
        type: string
      example: 'JWS eyJ2ZXIiOiIxLjAiLCJraWQiOiIy...'
    requestTime:
      name: requestTime
      in: header
      description: >-
        <p>Timestamp of the HTTP request generated, format as per <code>RFC3339 Section5.6</code><br>
        Timezone: <strong>UTC</strong><br>
        <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6" target="blank"><sub>Understand RFC3339 Section5.6</sub></a>.</p>        
      required: true
      schema:
        allOf:
        - $ref: '#/components/schemas/DateTime_TAAS'
      example: '2023-04-01 00:00:00'
    requestId:
      name: requestId
      in: header
      description: >-
        <p>The unique identifier (UUID) of request triggered to access HSBC API service, generated by your platform. Eliminate hyphens <code>-</code> in the UUID.<br>
        <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier" target="blank"><sub>What is Universally unique identifier (UUID)? </sub></a><br></p> 
        <details>
          <summary>Note for <code>Try it now</code>:</summary>
          To trigger mock responses, use theses value: <code>SUCCESS</code>, <code>BAD_REQUEST</code>, <code>INTERNAL_ERROR</code>. <a href="https://develop.hsbc.com/node/812#making-an-api-request-via-open-api-specifications" target="blank"><sub>How to make a mock request?</sub></a>
        </details>
      required: true
      schema:
        allOf:
        - oneOf:
          - allOf:
            - $ref: '#/components/schemas/Uuid_TAAS'
            - minLength: 32
          - title: MockRequest
            type: string
            enum:
            - 'SUCCESS'
            - 'BAD_REQUEST'
            - 'INTERNAL_ERROR'
      example: '70c2d301d23f453bac5eebb64eb91860'
    countryCode:  
      name: countryCode
      in: header
      description: >-
        <p>Specify which <strong>country</strong>/ <strong>market</strong> this request is generated, format as per ISO 3166 Alpha-2-code.<br>
        <a href="https://www.iso.org/glossary-for-iso-3166.html" target="blank"><sub>What is ISO3166 Alpha-2-code? </sub></a><br> 
        <a href="https://develop.hsbc.com/api-overview/how-get-started-18" target="blank"><sub>Find out which countries/ markets are supported?</sub></a></p>
      required: true
      schema:
        allOf:
        - $ref: '#/components/schemas/ISOCountryCode'
        - minLength: 2
      example: 'SG'
    Content-Type:  
      name: Content-Type
      in: header
      description: >-
        Specify media type of the request.
        <details>
        <ol>
        <li>Default media type is <code>application/json</code>.</li>
        <li>For certain countries/ regions, <code>text/plain</code> will be used.</li> 
      required: true
      schema:
        type: string
        enum:
        - 'application/json'
        - 'text/plain'
        default: 'application/json'
      example: 'application/json'
    schemaVersion:  
      name: schemaVersion
      in: header
      description: API Version
      required: true
      schema:
        type: string
        enum:
        - '1.0'
      example: '1.0'
    x-hsbc-profile-id:
      name: x-hsbc-profile-id
      in: header
      required: true
      schema:
        type: string
        pattern: ^/d{1,2}
      example: '24'
    x-hsbc-client-id:
      name: x-hsbc-client-id
      in: header
      required: true
      schema:
        $ref: '#/components/schemas/Uuid_TAAS'
      example: '70c2d301d23f453bac5eebb64eb91860'
    x-hsbc-client-secret:
      name: x-hsbc-client-secret
      in: header
      required: true
      schema:
        $ref: '#/components/schemas/Uuid_TAAS'
      example: '70c2d301d23f453bac5eebb64eb91860'
# Security scheme definitions
  securitySchemes:
    BearerTokenJWS: # JSON Web Token
      type: apiKey
      in: header       
      name: Authorization
      description: >-
        Your **Digital Identity**, which is a **private-key-signed** `Bearer Token` generated **per request**, must be sent via `Authorization` in the request `header`. [<sub>What is Bearer Token ?</sub>](#authentication)       
        
        example: `JWS eyJ2ZXIiOiIxLjAiLCJraWQiOiJFMzYzQ0VGRjAwMThBMjAyIiwid...`