---
swagger: "2.0"
info:
  x-ibm-name: home-loan-product
  title: Home Loan Product
  version: 1.0.1
  description: ""
schemes:
- https
basePath: /home-loan-product/v1
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  X-IBM-Client-Id:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
- X-IBM-Client-Id: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/Response Parameters'
      parameters:
      - name: Query Parameters
        required: false
        in: body
        schema:
          $ref: '#/definitions/Query Parameters'
definitions:
  Query Parameters:
    properties:
      LoadTypeList:
        type: string
        description: ประเภทสินเชื่อบ้าน มีค่าดังนี้ 0782200001 (สินเชื่อเพื่อซื้อที่อยู่อาศัย
          (ใหม่/มือสอง)), 0782200002 (สินเชื่อเพื่อซื้อที่อยู่อาศัย (ใหม่)), 0782200003
          (สินเชื่อเพื่อซื้อที่อยู่อาศัย (มือสอง)), 0782200004 (สินเชื่อเพื่อ Refinance)
          หากต้องการกรองข้อมูล สามารถระบุค่าโดยใช้ Comma (,) คั่น เช่น 0782200001,0782200002
          เป็นต้น หากไม่ต้องการกรองข้อมูล สามารถกำหนดเป็นค่าว่าง (Empty String) ได้
          || Home loan type, whose possible values are 0782200001 (home loan for new
          and second-hand home), 0782200002 (home loan for new home), 0782200003 (home
          loan for second-hand home), 0782200004 (loan for refinancing). In order
          to select specific home loan type, please put Comma (,) between each type;
          for example, 0782200001,0782200002 - The cell can be left blank.
        example: 0782200001,0782200002
      IsTypeSingleHouse:
        type: string
        description: หลักประกันประเภทบ้านเดี่ยว หากต้องการค้นหาหลักประกันประเภทนี้
          ระบุ Y หากไม่ต้องการค้นหาหลักประกันประเภทนี้ระบุ N || Detached house. In
          order to select this collateral type, state Y, if not, state N.
        example: "Y"
      IsTypeTwinHouse:
        type: string
        description: หลักประกันประเภทบ้านแฝด หากต้องการค้นหาหลักประกันประเภทนี้ ระบุ
          Y หากไม่ต้องการค้นหาหลักประกันประเภทนี้ระบุ N || Semi-detached house. In
          order to select this collateral type, state Y, if not, state N.
        example: "Y"
      IsTypeTownHouse:
        type: string
        description: หลักประกันประเภททาวน์เฮ้าส์ / ทาวน์โฮม หากต้องการค้นหาหลักประกันประเภทนี้
          ระบุ Y หากไม่ต้องการค้นหาหลักประกันประเภทนี้ระบุ N || Townhouse/townhome.
          In order to select this collateral type, state Y, if not, state N.
        example: "Y"
      IsTypeCondominium:
        type: string
        description: หลักประกันประเภทห้องชุดพักอาศัย (คอนโดมิเนียม) หากต้องการค้นหาหลักประกันประเภทนี้
          ระบุ Y หากไม่ต้องการค้นหาหลักประกันประเภทนี้ระบุ N || Condominium. In order
          to select this collateral type, state Y, if not, state N.
        example: "Y"
      IsTypeCommerciaBuilding:
        type: string
        description: หลักประกันประเภทอาคารพาณิชย์ หากต้องการค้นหาหลักประกันประเภทนี้
          ระบุ Y หากไม่ต้องการค้นหาหลักประกันประเภทนี้ระบุ N || Commercial building.
          In order to select this collateral type, state Y, if not, state N.
        example: "Y"
      IsTypeHomeOffice:
        type: string
        description: หลักประกันประเภทโฮมออฟฟิศ หากต้องการค้นหาหลักประกันประเภทนี้
          ระบุ Y หากไม่ต้องการค้นหาหลักประกันประเภทนี้ระบุ N || Home office. In order
          to select this collateral type, state Y, if not, state N.
        example: "Y"
      IsTypePropertyForeClosed:
        type: string
        description: หลักประกันประเภททรัพย์สินรอการขาย หากต้องการค้นหาหลักประกันประเภทนี้
          ระบุ Y หากไม่ต้องการค้นหาหลักประกันประเภทนี้ระบุ N || Non-performing asset.
          In order to select this collateral type, state Y, if not, state N.
        example: "Y"
      IsTypeOther:
        type: string
        description: หลักประกันประเภทอื่น ๆ หากต้องการค้นหาหลักประกันประเภทนี้ ระบุ
          Y หากไม่ต้องการค้นหาหลักประกันประเภทนี้ระบุ N ||Other types of collateral.
          In order to select this collateral type, state Y, if not, state N.
        example: "Y"
      FICodeList:
        type: string
        description: รหัส-ชื่อผู้ให้บริการ หากต้องการกรองข้อมูล สามารถระบุค่าโดยใช้
          Comma (,) คั่น เช่น 002,026 เป็นต้น หากไม่ต้องการกรองข้อมูล สามารถกำหนดเป็นค่าว่าง
          (Empty String) ได้ || Financial service provider code-name. In order to
          select specific financial service provider, please put Comma (,) between
          each code; for example, 002,026 - The cell can be left blank.
        example: 002,026
      ProductName:
        type: string
        description: ชื่อผลิตภัณฑ์ สามารถกำหนดเงื่อนไขชื่อผลิตภัณฑ์ที่ต้องการค้นหาแบบบางส่วน
          (Partial Search) หรือกำหนดเป็นค่าว่าง (Empty String) ได้ || Product name.
          User can use partial search for product name, or the cell can be left blank.
      CharacterBorrowerLoanList:
        type: string
        description: คุณสมบัติของผู้กู้ที่มีผลต่ออัตราดอกเบี้ยของสินเชื่อ มีค่าดังนี้
          0781700001,0781700002 (ผู้มีรายได้ประจำ), 0781700003 (เจ้าของกิจการ), 0781700004
          (กลุ่มลูกค้าที่ผู้ให้บริการกำหนด), 0781700005 (อื่น ๆ) หากต้องการกรองข้อมูล
          สามารถระบุค่าโดยใช้ Comma (,) คั่น เช่น 0781700001,0781700002 เป็นต้น หากไม่ต้องการกรองข้อมูล
          สามารถกำหนดเป็นค่าว่าง (Empty String) ได้ || Character of borrower that
          affects loan interest rate. The possible values are 0781700001,0781700002
          (full-time employee), 0781700003 (self-employment), 0781700004 (specific
          customer group), 0781700005 (others). In order to select specific borrower
          characteristic, please put Comma (,) between each character; for example,
          0781700001,0781700002 - The cell can be left blank.
        example: 0781700001,0781700002
      MinIncomePerMonthList:
        type: string
        description: รายได้ขั้นต่ำ (บาท/เดือน) ของลูกค้าที่สามารถใช้ผลิตภัณฑ์ได้ มีค่าดังนี้
          0-15000 (น้อยกว่า 15,000 บาท), 0-30000 (น้อยกว่า 30,000 บาท), 0-50000 (น้อยกว่า
          50,000 บาท), 0-100000 (น้อยกว่า 100,000 บาท), 0-200000 (น้อยกว่า 200,000
          บาท), 200001-n (200,000 บาทขึ้นไป) หากต้องการกรองข้อมูล สามารถระบุค่าโดยใช้
          Comma (,) คั่น เช่น  0-14999,0-29999 เป็นต้น หากไม่ต้องการกรองข้อมูล สามารถกำหนดเป็นค่าว่าง
          (Empty String) ได้ || Minimum monthly income requirement, whose possible
          values are 0-14999 (less than 15,000 baht), 0-29999 (less than 30,000 baht),
          0-49999 (less than 50,000 baht), 0-99999 (less than 100,000 baht), 0-199999
          (less than 200,000 baht), 200000-n (more than 200,000 baht). In order to
          select specific minimum monthly income requirement, please put Comma (,)
          between each requirement; for example, 0-14999,0-29999 - The cell can be
          left blank.
        example: 0-15000
      MRTAList:
        type: string
        description: ประกันชีวิตคุ้มครองวงเงินสินเชื่อ (MRTA) มีค่าดังนี้ ไม่ต้องสมัคร
          MRTA, ต้องสมัคร MRTA หากต้องการกรองข้อมูล สามารถระบุค่าโดยใช้ Comma (,)
          คั่น เช่น ไม่ต้องสมัคร MRTA,ต้องสมัคร MRTA หากไม่ต้องการกรองข้อมูล สามารถกำหนดเป็นค่าว่าง
          (Empty String) ได้ || Mortgage Reducing Term Assurance (MRTA) condition,
          whose possible values are ไม่ต้องสมัคร MRTA (no MRTA required) ,ต้องสมัคร
          MRTA (MRTA required). In order to select specific condition, please put
          Comma (,) between each choice; for example, ไม่ต้องสมัคร MRTA,ต้องสมัคร
          MRTA - The cell can be left blank.
        example: ""
      LoanOtherProductConditionList:
        type: string
        description: เงื่อนไขการใช้สินเชื่อควบคู่กับผลิตภัณฑ์อื่น มีค่าดังนี้ 0781800001
          (ไม่มีเงื่อนไข), 0781800002 (ต้องใช้บัญชีเงินฝากของผู้ให้บริการ), 0781800003
          (ต้องใช้บัญชีเงินเดือนของผู้ให้บริการ), 0781800004 (ต้องใช้บัตรเครดิตของผู้ให้บริการ),
          0781800005 (อื่น ๆ) หากต้องการกรองข้อมูล สามารถระบุค่าโดยใช้ Comma (,) คั่น
          เช่น 0781800001,0781800002 หากไม่ต้องการกรองข้อมูล สามารถกำหนดเป็นค่าว่าง
          (Empty String) ได้ || Requirement to use additional products in order to
          apply for a loan. The possible values are 0781800001 (not required to use
          additional products), 0781800002 (required to use provider's deposit account),
          0781800003 (required to use provider's payroll account), 0781800004 (required
          to use provider's credit card), 0781800005 (others). In order to select
          specific requirement, please put Comma (,) between each choice; for example,
          0781800001,0781800002 - The cell can be left blank.
        example: 0781800001,0781800002
      CreditLineAmount:
        type: string
        description: วงเงินสินเชื่อ (บาท) สามารถกำหนดเงื่อนไขวงเงินสินเชื่อขั้นต่ำตามจำนวนที่ระบุ
          หรือกำหนดเป็นค่าว่าง (Empty String) ได้ || Credit limit in Thai baht. User
          can specify the credit limit, or the cell can be left blank.
        example: "100000"
      RateYearOneList:
        type: string
        description: ลักษณะอัตราดอกเบี้ย ปีที่ 1 มีค่าดังนี้ 0782000001,0782000002
          (อัตราคงที่), 0782000003,0782000004 (อัตราลอยตัว), 0782000005 (อัตราผสม)
          หากต้องการกรองข้อมูล สามารถระบุค่าโดยใช้ Comma (,) คั่น เช่น 0782000001,0782000002,0782000005
          หากไม่ต้องการกรองข้อมูล สามารถกำหนดเป็นค่าว่าง (Empty String) ได้ || Type
          of interest rate for the first year, whose possible values are 0782000001,0782000002
          (fixed rate), 0782000003,0782000004 (floating rate), 0782000005 (mixed rate).
          In order to select specific interest rate type, please put Comma (,) between
          each type; for example, 0782000001,0782000002,0782000005 - The cell can
          be left blank.
        example: 0782000001,0782000003,0782000005
      RateYearTwoList:
        type: string
        description: ลักษณะอัตราดอกเบี้ย ปีที่ 2 มีค่าดังนี้ 0782000001,0782000002
          (อัตราคงที่), 0782000003,0782000004 (อัตราลอยตัว), 0782000005 (อัตราผสม)
          หากต้องการกรองข้อมูล สามารถระบุค่าโดยใช้ Comma (,) คั่น เช่น 0782000001,0782000002,0782000005
          หากไม่ต้องการกรองข้อมูล สามารถกำหนดเป็นค่าว่าง (Empty String) ได้ || Type
          of interest rate for the second year, whose possible values are 0782000001,0782000002
          (fixed rate), 0782000003,0782000004 (floating rate), 0782000005 (mixed rate).
          In order to select specific interest rate type, please put Comma (,) between
          each type; for example, 0782000001,0782000002,0782000005 - The cell can
          be left blank.
        example: 0782000001,0782000003,0782000005
      RateYearThreeList:
        type: string
        description: ลักษณะอัตราดอกเบี้ย ปีที่ 3 มีค่าดังนี้ 0782000001,0782000002
          (อัตราคงที่), 0782000003,0782000004 (อัตราลอยตัว), 0782000005 (อัตราผสม)
          หากต้องการกรองข้อมูล สามารถระบุค่าโดยใช้ Comma (,) คั่น เช่น 0782000001,0782000002,0782000005
          หากไม่ต้องการกรองข้อมูล สามารถกำหนดเป็นค่าว่าง (Empty String) ได้ || Type
          of interest rate for the third year, whose possible values are 0782000001,0782000002
          (fixed rate), 0782000003,0782000004 (floating rate), 0782000005 (mixed rate).
          In order to select specific interest rate type, please put Comma (,) between
          each type; for example, 0782000001,0782000002,0782000005 - The cell can
          be left blank.
        example: 0782000001,0782000003,0782000005
    additionalProperties: false
  Response Parameters:
    properties:
      result:
        type: object
        properties:
          api:
            type: string
          timestamp:
            type: string
            format: date-time
          data:
            type: array
            items:
              properties:
                FICode:
                  type: string
                  description: รหัสสถาบัน || Financial Institution code
                FIName:
                  type: string
                  description: ชื่อผู้ให้บริการ || Financial service provider name
                ProductName:
                  type: string
                  description: ชื่อผลิตภัณฑ์ || Product name
                PercentAverageInterestRateForThreeYear:
                  type: string
                  description: 'อัตราดอกเบี้ยเฉลี่ย 3 ปี (หน่วย : ร้อยละต่อปี) ||
                    Average interest rate for 3 years (% per year)'
                ConditionOfYearInterestRate:
                  type: string
                  description: อัตราดอกเบี้ยแต่ละปีที่ลูกค้าได้รับ ในปีที่ 1 2 และ
                    3 || Interest rate in the first, second, and third year
                EffectiveInterestRate:
                  type: string
                  description: 'อัตราดอกเบี้ยที่แท้จริง (หน่วย : ร้อยละต่อปี) || Effective
                    interest rate (% per year)'
                MaximumNormalInterestRate:
                  type: string
                  description: 'อัตราดอกเบี้ยสูงสุดกรณีปกติ (หน่วย : ร้อยละต่อปี)
                    || Maximum normal interest rate (% per year)'
                DefaultInterestRateAndRelatedCondition:
                  type: string
                  description: อัตราดอกเบี้ยกรณีผิดนัดชำระหนี้และเงื่อนไข || Default
                    interest rate and condition
                LoadTypeName:
                  type: string
                  description: ประเภทสินเชื่อบ้าน || Home loan type
                TypeOfCollatera:
                  type: string
                  description: ประเภทหลักประกัน || Type of collateral
                CharacterOfBorrowerToLoanInterestRate:
                  type: string
                  description: คุณสมบัติของผู้กู้ที่มีผลต่ออัตราดอกเบี้ยของสินเชื่อ
                    || Character of borrower that affects loan interest rate
                ConditionOfLoanWithOtherProduct:
                  type: string
                  description: เงื่อนไขการใช้สินเชื่อควบคู่กับผลิตภัณฑ์อื่น || Requirement
                    to use additional products in order to apply for a loan
                ConditionOfProduct:
                  type: string
                  description: เงื่อนไขผลิตภัณฑ์ || Product condition
                BorrowerAge:
                  type: string
                  description: อายุผู้กู้ || Borrower age
                MinimumMonthlyIncome:
                  type: string
                  description: รายได้ขั้นต่ำ (บาท/เดือน) || Minimum monthly income
                ConditionToApply:
                  type: string
                  description: เงื่อนไขในการสมัคร || Condition to apply
                CreditLimit:
                  type: string
                  description: วงเงินสินเชื่อ || Credit limit
                LoanToValueRatio:
                  type: string
                  description: อัตราส่วนของวงเงินสินเชื่อสูงสุดต่อหลักประกัน || Loan-to-Value
                    ratio (LTV ratio)
                ConditionOfCreditLimit:
                  type: string
                  description: เงื่อนไขของวงเงินสินเชื่อ || Credit limit condition
                PeriodOfBorrowing:
                  type: string
                  description: ระยะเวลาการกู้ยืม || Borrowing period
                ConditionOfInstallment:
                  type: string
                  description: เงื่อนไขของการผ่อนชำระ || Installment plan condition
                MortgageReducingTermAssurance:
                  type: string
                  description: ประกันชีวิตคุ้มครองวงเงินสินเชื่อ (MRTA) || Mortgage
                    Reducing Term Assurance (MRTA) condition
                MRTACancellationFee:
                  type: string
                  description: ค่าธรรมเนียมกรณีขอยกเลิกประกันชีวิตคุ้มครองวงเงินสินเชื่อ
                    (MRTA) || MRTA cancellation fee
                SurveyAndAppraisalFee:
                  type: string
                  description: ค่าสำรวจและประเมินหลักประกันโดยผู้ประเมินภายในและผู้ประเมินภายนอก
                    || Survey and appraisal fee by internal and external appraiser
                StampDuty:
                  type: string
                  description: ค่าอากรแสตมป์ || Stamp duty
                MortgageFee:
                  type: string
                  description: ค่าธรรมเนียมจดจำนอง || Mortgage fee
                TransferFee:
                  type: string
                  description: ค่าธรรมเนียมการโอนกรรมสิทธิ์ || Transfer fee
                CreditInformationVerificationFee:
                  type: string
                  description: ค่าตรวจสอบข้อมูลเครดิต กรณีพบข้อมูลเครดิต || Credit
                    Bureau status check service fee
                FireInsurancePremiums:
                  type: string
                  description: ค่าเบี้ยประกันอัคคีภัย || Fire insurance premiums
                FeeForChequeReturned:
                  type: string
                  description: การเรียกเก็บค่าใช้จ่ายกรณีเช็คคืน (เช็คของผู้ให้บริการอื่น)
                    || Fee for returned cheque (other banks' cheque)
                FeeForDeficiencyBalanceAC:
                  type: string
                  description: ค่าใช้จ่ายกรณีเงินในบัญชีไม่พอจ่าย (กรณีชำระหนี้โดยการหักบัญชีกับผู้ให้บริการอื่น)
                    || Insufficient direct debit charge (deducting from other banks'
                    account)
                CopyOfStatementFee:
                  type: string
                  description: ค่าขอใบแจ้งยอดบัญชีแต่ละงวด (ชุดที่ 2 เป็นต้นไป) ||
                    Statement re-issuing fee (from the 2nd issue)
                FinesForChequeReturned:
                  type: string
                  description: ค่าปรับกรณีชำระเป็นเช็คและเช็คถูกคืน || Fee for returned
                    cheque
                DebtCollectionFee:
                  type: string
                  description: ค่าติดตามทวงถามหนี้ || Debt collection fee
                FeeforChangingInterestRate:
                  type: string
                  description: ค่าธรรมเนียมกรณีขอเปลี่ยนแปลงอัตราดอกเบี้ยก่อนครบกำหนด
                    || Fee for changing interest rate
                RefinanceFee:
                  type: string
                  description: ค่าธรรมเนียมกรณีไถ่ถอนจำนองไปใช้บริการกับผู้ให้บริการอื่น
                    (Refinance) || Refinance fee
                OtherFees:
                  type: string
                  description: ค่าธรรมเนียมอื่น ๆ || Other fees
                DeductingFromBankACFee:
                  type: string
                  description: ค่าธรรมเนียมในการชำระเงินโดยหักบัญชีของผู้ให้บริการ
                    || Deducting from bank account fee
                DeductingFromOtherBankACFee:
                  type: string
                  description: ค่าธรรมเนียมในการชำระเงินโดยหักบัญชีของผู้ให้บริการอื่น
                    || Deducting from other bank account fee
                BankCounterServiceFee:
                  type: string
                  description: ค่าธรรมเนียมในการชำระเงินที่สาขาของผู้ให้บริการ ||
                    Service provider's counter service fee
                OtherBankCounterServiceFee:
                  type: string
                  description: ค่าธรรมเนียมในการชำระเงินที่สาขาของผู้ให้บริการอื่น
                    || Other providers' counter service fee
                OtherCounterServiceFee:
                  type: string
                  description: ค่าธรรมเนียมในการชำระเงินที่จุดบริการรับชำระเงิน ||
                    Other payment counter service fee
                OnlinePaymentFee:
                  type: string
                  description: ค่าธรรมเนียมในการชำระเงินผ่านระบบ Online (Internet
                    / Mobile banking) || Online payment fee
                CDMATMPaymentFee:
                  type: string
                  description: ค่าธรรมเนียมในการชำระเงินผ่านเครื่อง CDM / ATM || CDM
                    / ATM payment fee
                PhonePaymentFee:
                  type: string
                  description: ค่าธรรมเนียมในการชำระเงินผ่านระบบโทรศัพท์อัตโนมัติ
                    || Phone payment fee
                ChequeOrMoneyOrderPaymentFee:
                  type: string
                  description: ค่าธรรมเนียมในการชำระเงินโดยเช็คหรือธนาณัติทางไปรษณีย์
                    || Cheque or money order payment fee
                OtherChannelPaymentFee:
                  type: string
                  description: ค่าธรรมเนียมในการชำระเงินผ่านช่องทางอื่น ๆ || Other
                    channel payment fee
                URL:
                  type: string
                  description: URL ของ website ผลิตภัณฑ์ || Product website URL
                FeeURL:
                  type: string
                  description: URL ของ website ค่าธรรมเนียม || Fee website URL
    additionalProperties: false
x-ibm-endpoints:
- endpointUrl: https://apigw1.bot.or.th/bot-iwt/public
  description: API Gateway
  type:
  - production
...