Back to top

API Documentation

EUSO SSS API 文件

EUSO SSS API 主要作用為 接收、查詢訂單，並交易至第三方代收系統(超商付款).

SERVER INFO

正式平台 : https://nothing.index-group.com.tw/EUSO

測試平台 : https://systest.index-group.com.tw/EUSO

Note: 測試平台是開發環境, 不一定會開啟.

Release Version

1.0.5

  • Release Date: 2023/06/09

  • 新增 (NEW)

    • [API] queryRemitOrder
      • 新增查詢欄位(Request) - page (number) 查詢指定頁數資料
      • 新增回應資料(Response) - Paging (PagingData) 回應當前查詣資料分頁資訊

  • 調整 (Modify)

    • [API] queryRemitOrder
      • 預設訂單查詢時間範圍修改為 7個月

1.0.4

  • Release Date: 2021/03/05

  • 調整 (Modify)

    • [API] queryLoanConfigJSON (Response)
      • 增加欄位 supportLoanPaymentFlexFundMap: 描述支援 FlexFund 的設定
      • 修正欄位規格 LoanPMAmountMap, LoanMonthNumberMap: 增加 LoanPaymentCode 層.

  • 新增 (NEW)

    • [繳費方式] TRANS TYPE INFO TABLE
    • [繳費代號] LOAN PAYMENT CODE INFO TABLE
    • [繳費類型] LOAN PAYMENT TYPE INFO TABLE

1.0.3

  • Release Date: 2020/12/08

  • 調整 (Modify)

    • [API] createRemitOrder (From Column)
      • 增加欄位 arc_image_file: 居留證 - 正面 jpg
      • 增加欄位 arc_01_image_file: 居留證 - 背面 jpg
      • 增加欄位 face_image_file: 大頭照 jpg
    • [API] createRemitOrder (Response)
    • 增加欄位 arc_image: 居留證 - 正面 jpg
    • 增加欄位 arc_01_imag: 居留證 - 背面 jpg
    • 增加欄位 face_image: 大頭照 jpg

1.0.2

  • Release Date: 2020/12/08

  • 調整 (Modify)

    • [API] queryRemitOrder - ecPayOrderList (Response)(Column)
      • 增加欄位 paymentURLs: 繳費頁URL

1.0.1

  • Release Date: 2020/12/04

  • 調整 (Modify)

    • [API] createRemitOrder (From Column)
      • 增加欄位 introducer (string, optional): 介紹人的代碼

1.0.0

  • Release Date: 2020/10/29

  • 新增 (NEW)

    • SSS Remit Order

API Overview

  • SSS匯款(SSSRemit)
    • queryER
      • 取得匯率
    • queryServiceFeeV2
      • 取得服務費
    • createRemitOrder
      • 建立訂單
    • queryRemitOrder
      • 查詢訂單
    • uploadReceiptImg
      • 繳費收據上傳
    • verifyRemitAmountLimit
      • 檢查匯款金額限制
    • queryCompleteRemitOrder
      • 查詢已完成繳費之訂單
    • queryLoanConfigJSON
      • 取得Loan Config JSON

API 建立定單 使用順序

  1. 取得打單設定 - queryLoanConfig

  2. 取得匯率 - queryER

  3. 取得服務費 - queryServiceFeeV2

  4. 建立定單 - createRemitOrder

SSS匯款API - SSSRemit

Resource

POST/api/services/sssRemit/queryER.api

Example URI

POST https://systest.index-group.com.tw/EUSO/api/services/sssRemit/queryER.api
Request  Form Submit
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
{
  "company": "index",
  "apid": "ROI01",
  "remit_country": "IDN"
}
Schema
{
  "type": "object",
  "properties": {
    "company": {
      "type": "string",
      "description": "公司代碼"
    },
    "apid": {
      "type": "string",
      "description": "APP 代碼"
    },
    "remit_country": {
      "type": "string",
      "description": "匯款國家, IDN, VNM, PHL"
    }
  },
  "required": [
    "company",
    "apid"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "statusCode": "1",
  "message": "SUCCESS",
  "response_time": "2017/11/15 14:54:40",
  "response_text": [
    {
      "exchange_rate": 30.11,
      "exchange_flag": "USD"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "string",
      "description": "交易狀態"
    },
    "message": {
      "type": "string",
      "description": "交易訊息"
    },
    "response_time": {
      "type": "string",
      "description": "回覆時間, yyyy/MM/dd HH:mm:ss"
    },
    "response_text": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "exchange_rate": {
            "type": "number",
            "enum": [
              30.11
            ],
            "description": "匯率xxx"
          },
          "exchange_flag": {
            "type": "string",
            "enum": [
              "USD"
            ],
            "description": "幣別"
          }
        },
        "required": [
          "exchange_rate",
          "exchange_flag"
        ],
        "additionalProperties": false
      },
      "description": "回復資訊內容"
    }
  },
  "required": [
    "response_text"
  ]
}

Resource

POST/api/services/sssRemit/queryServiceFeeV2.api

Example URI

POST https://systest.index-group.com.tw/EUSO/api/services/sssRemit/queryServiceFeeV2.api
Request  Form Submit
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
{
  "company": "index",
  "apid": "ROI01",
  "remit_country": "IDN",
  "trans_type": "BTB",
  "amount": 100
}
Schema
{
  "type": "object",
  "properties": {
    "company": {
      "type": "string",
      "description": "公司代碼"
    },
    "apid": {
      "type": "string",
      "description": "APP 代碼"
    },
    "remit_country": {
      "type": "string",
      "description": "匯款國家, IDN, VNM, PHL"
    },
    "trans_type": {
      "type": "string",
      "description": "匯款方式"
    },
    "amount": {
      "type": "number",
      "description": "匯款金額(NTD)"
    }
  },
  "required": [
    "company",
    "apid",
    "trans_type",
    "amount"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "statusCode": "1",
  "message": "SUCCESS",
  "response_time": "2017/11/15 14:54:40",
  "response_text": {
    "service_fee": 100
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "string",
      "description": "交易狀態"
    },
    "message": {
      "type": "string",
      "description": "交易訊息"
    },
    "response_time": {
      "type": "string",
      "description": "回覆時間, yyyy/MM/dd HH:mm:ss"
    },
    "response_text": {
      "type": "object",
      "properties": {
        "service_fee": {
          "type": "number",
          "description": "服務費(NTD)"
        }
      },
      "description": "回復資訊內容"
    }
  }
}

Resource

POST/api/services/sssRemit/createRemitOrder.api

Example URI

POST https://systest.index-group.com.tw/EUSO/api/services/sssRemit/createRemitOrder.api
Request  Form Submit
HideShow
Headers
Content-Type: multipart/form-data
Body
{
  "company": "index",
  "apid": "ROE01",
  "uuid": "1234567890",
  "device_id": "1234567890",
  "lang": "zh_TW",
  "remit_country": "IDN",
  "sender_name": "AAA",
  "sender_birthday": "1900/01/01",
  "sender_arc": "AA00000000",
  "sender_arc_term": "1900/01/01",
  "sender_tel": "0123456789",
  "sender_mobile": "0123456789",
  "sender_country": "PHL",
  "recipinent_name": "BBB",
  "recipinent_tel": "0123456789",
  "recipinent_birthday_note": "``",
  "debtorID": "1234567890",
  "debtorType": "``",
  "loanStartYear": 2020,
  "loanStartMonth": 10,
  "loanEndYear": 2020,
  "loanEndMonth": 10,
  "loanMonthNumber": 1,
  "loanFlexiFund": 0,
  "loanPMAmount": 200,
  "loanNumber": "1234567890",
  "loanPaymentCode": "1234567890",
  "loanPaymentType": "1234567890",
  "recipinent_number": "1234567890",
  "discount_fee": 0,
  "red_point_discount": 0,
  "service_fee": 100,
  "amount": 10,
  "total_amount": 110,
  "exchange_rate_flag": "PHP",
  "exchange_rate": 400,
  "referenceER": 4000,
  "trans_type": "BTB",
  "note": "note...",
  "coupon_code": "``",
  "coupon_value": 0,
  "sign_image_file": "[file]",
  "payment_type": "CVS",
  "sender_info_modify": "0|1",
  "euso_timestamp": "0000000000000000",
  "sender_source_of_income": "001",
  "sender_source_of_income_other": "其他",
  "sender_remittance_purpose": "001",
  "sender_remittance_purpose_other": "其他",
  "recipinent_relationship": "001",
  "recipinent_relationship_other": "其他",
  "introducer": "0000000",
  "face_image_file": "[file]",
  "arc_image_file": "[file]",
  "arc_01_image_file": "[file]"
}
Schema
{
  "type": "object",
  "properties": {
    "company": {
      "type": "string",
      "description": "公司代碼"
    },
    "apid": {
      "type": "string",
      "description": "APP 代碼"
    },
    "uuid": {
      "type": "string",
      "description": "使用者 UUID"
    },
    "device_id": {
      "type": "string",
      "description": "使用者 Device ID"
    },
    "lang": {
      "type": "string",
      "description": "使用者當前使用的語系, en_PH, in_ID, vi_VN, zh_TW"
    },
    "remit_country": {
      "type": "string",
      "description": "匯款國家, IDN, VNM, PHL"
    },
    "sender_name": {
      "type": "string",
      "description": "寄件者姓名"
    },
    "sender_birthday": {
      "type": "string",
      "description": "寄件者生日, yyyy/MM/dd"
    },
    "sender_arc": {
      "type": "string",
      "description": "寄件者居留證號碼"
    },
    "sender_arc_term": {
      "type": "string",
      "description": "寄件者居留證到期日, yyyy/MM/dd"
    },
    "sender_tel": {
      "type": "string",
      "description": "寄件者電話"
    },
    "sender_mobile": {
      "type": "string",
      "description": "寄件者手機號碼"
    },
    "sender_country": {
      "type": "string",
      "description": "寄件者國藉, IDN | PHL | VNM"
    },
    "recipinent_name": {
      "type": "string",
      "description": "收款人姓名"
    },
    "recipinent_tel": {
      "type": "string",
      "description": "收款人聯絡電話. (EEC 為必填)"
    },
    "recipinent_birthday_note": {
      "type": "string",
      "description": "收款人生日"
    },
    "debtorID": {
      "type": "string",
      "description": "借方ID"
    },
    "debtorType": {
      "type": "string",
      "description": "借方類型"
    },
    "loanStartYear": {
      "type": "number",
      "description": "繳款年份."
    },
    "loanStartMonth": {
      "type": "number",
      "description": "繳款月份"
    },
    "loanEndYear": {
      "type": "number",
      "description": "繳款至年份"
    },
    "loanEndMonth": {
      "type": "number",
      "description": "繳款至月份"
    },
    "loanMonthNumber": {
      "type": "number",
      "description": "繳款月數"
    },
    "loanFlexiFund": {
      "type": "number",
      "description": "(PHP)Flexi-fund amount Value can be 0 Minimum is 200, Maximum is   999,999 Allowed only for OFW Requires 1 month of the highest contribution amount"
    },
    "loanPMAmount": {
      "type": "number",
      "description": "(PHP)繳款金額"
    },
    "loanNumber": {
      "type": "string",
      "description": "Members active loan account number"
    },
    "loanPaymentCode": {
      "type": "string",
      "description": "3 – Social Security Card"
    },
    "loanPaymentType": {
      "type": "string",
      "description": "3 – Social Security Card"
    },
    "recipinent_number": {
      "type": "string",
      "description": "交易方式為 SSS 時, 必填"
    },
    "discount_fee": {
      "type": "number",
      "description": "扣折(NTD)"
    },
    "red_point_discount": {
      "type": "number",
      "description": "紅利折抵(NTD)"
    },
    "service_fee": {
      "type": "number",
      "description": "服務費(NTD)"
    },
    "amount": {
      "type": "number",
      "description": "應匯金額(NTD)"
    },
    "total_amount": {
      "type": "number",
      "description": "訂單總金額(NTD)"
    },
    "exchange_rate_flag": {
      "type": "string",
      "description": "外幣幣別"
    },
    "exchange_rate": {
      "type": "number",
      "description": "外幣匯率"
    },
    "referenceER": {
      "type": "number",
      "description": "匯兌金額 (應匯金額 兌換 外幣金額)"
    },
    "trans_type": {
      "type": "string",
      "description": "匯款方式"
    },
    "note": {
      "type": "string",
      "description": "備註"
    },
    "coupon_code": {
      "type": "string",
      "description": "coupon代碼"
    },
    "coupon_value": {
      "type": "number",
      "description": "coupon折價金額(NTD)"
    },
    "sign_image_file": {
      "type": "string",
      "description": "*file* 簽名照"
    },
    "payment_type": {
      "type": "string",
      "description": "付款方式. 參照 **[付款方式] Payment Type**"
    },
    "sender_info_modify": {
      "type": "string",
      "description": "是否有修改當前sender info, 1為強制進入審核機制"
    },
    "euso_timestamp": {
      "type": "string",
      "description": "訂單時間戳記"
    },
    "sender_source_of_income": {
      "type": "string",
      "description": "資金來源, 參照 [資金來源] Source of income List"
    },
    "sender_source_of_income_other": {
      "type": "string",
      "description": "資金來源-其他內容"
    },
    "sender_remittance_purpose": {
      "type": "string",
      "description": "匯款目的, 參照 [資金來源] [匯款目的] Remittance purpose List"
    },
    "sender_remittance_purpose_other": {
      "type": "string",
      "description": "匯款目的-其他內容"
    },
    "recipinent_relationship": {
      "type": "string",
      "description": "匯款對象關係, 參照 [匯款對象關係] Relationship List"
    },
    "recipinent_relationship_other": {
      "type": "string",
      "description": "匯款對象關係-其他內容"
    },
    "introducer": {
      "type": "string",
      "description": "介紹人代碼"
    },
    "face_image_file": {
      "type": "string",
      "description": "*file* 大頭照 - **使用 Sender Profile 的 APP 則非必填**"
    },
    "arc_image_file": {
      "type": "string",
      "description": "*file* 居留證照  - **使用 Sender Profile 的 APP 則非必填**"
    },
    "arc_01_image_file": {
      "type": "string",
      "description": "*file* 居留證照01(背面照)  - **使用 Sender Profile 的 APP 則非必填**"
    }
  },
  "required": [
    "company",
    "apid",
    "device_id",
    "lang",
    "sender_name",
    "sender_birthday",
    "sender_arc",
    "sender_arc_term",
    "sender_mobile",
    "sender_country",
    "recipinent_name",
    "recipinent_tel",
    "recipinent_birthday_note",
    "debtorID",
    "loanStartYear",
    "loanStartMonth",
    "loanEndYear",
    "loanEndMonth",
    "loanMonthNumber",
    "loanFlexiFund",
    "loanPMAmount",
    "discount_fee",
    "red_point_discount",
    "service_fee",
    "amount",
    "total_amount",
    "exchange_rate_flag",
    "exchange_rate",
    "referenceER",
    "trans_type",
    "sign_image_file",
    "payment_type",
    "sender_info_modify",
    "face_image_file",
    "arc_image_file",
    "arc_01_image_file"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "statusCode": "1",
  "message": "SUCCESS",
  "response_time": "2017/11/15 14:54:40",
  "response_text": {
    "uuid": "0123456789",
    "euso_order": "ROX171012001a",
    "status": "0|1|2"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "string",
      "description": "交易狀態"
    },
    "message": {
      "type": "string",
      "description": "交易訊息"
    },
    "response_time": {
      "type": "string",
      "description": "回覆時間, yyyy/MM/dd HH:mm:ss"
    },
    "response_text": {
      "type": "object",
      "properties": {
        "uuid": {
          "type": "string",
          "description": "使用者 UUID"
        },
        "euso_order": {
          "type": "string",
          "description": "訂單編號"
        },
        "status": {
          "type": "string",
          "description": "訂單狀態"
        }
      },
      "description": "回復資訊內容"
    }
  }
}

Resource

POST/api/services/sssRemit/queryRemitOrder.api

Example URI

POST https://systest.index-group.com.tw/EUSO/api/services/sssRemit/queryRemitOrder.api
Request  Form Submit
HideShow
Headers
Content-Type: form-data
Body
{
  "company": "index",
  "apid": "ROI01",
  "uuid": "1234567890",
  "remit_country": "IDN",
  "euso_order": "ROX00000000",
  "page": 1
}
Schema
{
  "type": "object",
  "properties": {
    "company": {
      "type": "string",
      "description": "公司代碼"
    },
    "apid": {
      "type": "string",
      "description": "APP 代碼"
    },
    "uuid": {
      "type": "string",
      "description": "使用者 UUID"
    },
    "remit_country": {
      "type": "string",
      "description": "匯款國家, IDN, VNM, PHL"
    },
    "euso_order": {
      "type": "string",
      "description": "訂單編號"
    },
    "page": {
      "type": "number",
      "description": "查詢指定頁數 (NEW! v1.0.5)"
    }
  },
  "required": [
    "company",
    "apid"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "statusCode": "1",
  "message": "SUCCESS",
  "response_time": "2017/11/15 14:54:40",
  "response_text": [
    {
      "remit_country": "IDN",
      "sender_name": "AAA",
      "sender_arc": "AA00000000",
      "sender_arc_term": "``",
      "sender_tel": "0123456789",
      "sender_mobile": "0123456789",
      "sender_country": "PHL",
      "recipinent_name": "BBB",
      "recipinent_tel": "0123456789",
      "recipinent_birthday_note": "``",
      "debtorID": "1234567890",
      "debtorType": "``",
      "loanStartYear": 2020,
      "loanStartMonth": 10,
      "loanEndYear": 2020,
      "loanEndMonth": 10,
      "loanMonthNumber": 1,
      "loanFlexiFund": 0,
      "loanPMAmount": 200,
      "loanNumber": "1234567890",
      "loanPaymentCode": "1234567890",
      "loanPaymentType": "1234567890",
      "recipinent_number": "1234567890",
      "discount_fee": 0,
      "red_point_discount": 0,
      "service_fee": 100,
      "amount": 10,
      "total_amount": 110,
      "exchange_rate_flag": "IDR",
      "exchange_rate": 400,
      "referenceER": 4000,
      "trans_type": "BTB",
      "trans_to": "XXX",
      "note": "note...",
      "coupon_code": "``",
      "coupon_value": 0,
      "sign_image": "xxxx.png",
      "face_image": "xxxx.jpg",
      "arc_image": "xxxx.jpg",
      "arc_01_image": "xxxx.jpg",
      "euso_order": "ROX00000000",
      "branch_code": "ROX",
      "status": "0|1|2",
      "pay": "0|1",
      "remittance_order": "xxx0000000000",
      "sender_source_of_income": "001",
      "sender_source_of_income_other": "其他",
      "sender_remittance_purpose": "001",
      "sender_remittance_purpose_other": "其他",
      "recipinent_relationship": "001",
      "recipinent_relationship_other": "其他",
      "ecPayOrderList": [
        {
          "paymentType": "CVS|BARCODE",
          "barcode1": "xxxxxxxxxxxxxx",
          "barcode2": "xxxxxxxxxxxxxx",
          "barcode3": "xxxxxxxxxxxxxx",
          "paymentNo": "xxxxxxxxxxxxxx",
          "merchantTradeNo": "ROX000000001",
          "expireDate": "2011/11/01 00:00:00",
          "returnCode": "``",
          "returnTime": "2011/11/01 00:00:00",
          "paymentURLs": {
            "iBon": "https://aaa.bbb.com/?123",
            "Family": "https://aaa.bbb.com/?123",
            "Hilife": "https://aaa.bbb.com/?123"
          }
        }
      ]
    }
  ],
  "paging": {
    "pageItems": 10,
    "page": 1,
    "pageNumbers": 4,
    "items": 31
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "string",
      "description": "交易狀態"
    },
    "message": {
      "type": "string",
      "description": "交易訊息"
    },
    "response_time": {
      "type": "string",
      "description": "回覆時間, yyyy/MM/dd HH:mm:ss"
    },
    "response_text": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "remit_country": {
            "type": "string",
            "enum": [
              "IDN"
            ],
            "description": "匯款國家, IDN, VNM, PHL"
          },
          "sender_name": {
            "type": "string",
            "enum": [
              "AAA"
            ],
            "description": "寄件者姓名"
          },
          "sender_arc": {
            "type": "string",
            "enum": [
              "AA00000000"
            ],
            "description": "寄件者居留證號碼 (Format : [A-Z]{2}[0-9]{8})"
          },
          "sender_arc_term": {
            "type": "string",
            "enum": [
              "``"
            ],
            "description": "寄件者居留證到期日"
          },
          "sender_tel": {
            "type": "string",
            "enum": [
              "0123456789"
            ],
            "description": "寄件者電話"
          },
          "sender_mobile": {
            "type": "string",
            "enum": [
              "0123456789"
            ],
            "description": "寄件者手機號碼"
          },
          "sender_country": {
            "type": "string",
            "enum": [
              "PHL"
            ],
            "description": "寄件者國藉"
          },
          "recipinent_name": {
            "type": "string",
            "enum": [
              "BBB"
            ],
            "description": "收款人姓名"
          },
          "recipinent_tel": {
            "type": "string",
            "enum": [
              "0123456789"
            ],
            "description": "收款人聯絡電話"
          },
          "recipinent_birthday_note": {
            "type": "string",
            "enum": [
              "``"
            ],
            "description": "收款人生日"
          },
          "debtorID": {
            "type": "string",
            "enum": [
              "1234567890"
            ],
            "description": "借方ID"
          },
          "debtorType": {
            "type": "string",
            "enum": [
              "``"
            ],
            "description": "借方類型"
          },
          "loanStartYear": {
            "type": "number",
            "enum": [
              2020
            ],
            "description": "繳款年份."
          },
          "loanStartMonth": {
            "type": "number",
            "enum": [
              10
            ],
            "description": "繳款月份"
          },
          "loanEndYear": {
            "type": "number",
            "enum": [
              2020
            ],
            "description": "繳款至年份"
          },
          "loanEndMonth": {
            "type": "number",
            "enum": [
              10
            ],
            "description": "繳款至月份"
          },
          "loanMonthNumber": {
            "type": "number",
            "enum": [
              1
            ],
            "description": "繳款月數"
          },
          "loanFlexiFund": {
            "type": "number",
            "enum": [
              0
            ],
            "description": "(PHP)Flexi-fund amount Value can be 0 Minimum is 200, Maximum is   999,999 Allowed only for OFW Requires 1 month of the highest contribution amount"
          },
          "loanPMAmount": {
            "type": "number",
            "enum": [
              200
            ],
            "description": "(PHP)繳款金額"
          },
          "loanNumber": {
            "type": "string",
            "enum": [
              "1234567890"
            ],
            "description": "Members active loan account number"
          },
          "loanPaymentCode": {
            "type": "string",
            "enum": [
              "1234567890"
            ],
            "description": "3 – Social Security Card"
          },
          "loanPaymentType": {
            "type": "string",
            "enum": [
              "1234567890"
            ],
            "description": "3 – Social Security Card"
          },
          "recipinent_number": {
            "type": "string",
            "enum": [
              "1234567890"
            ],
            "description": "交易方式為 SSS 時, 必填"
          },
          "discount_fee": {
            "type": "number",
            "enum": [
              0
            ],
            "description": "扣折(NTD)"
          },
          "red_point_discount": {
            "type": "number",
            "enum": [
              0
            ],
            "description": "紅利折抵(NTD)"
          },
          "service_fee": {
            "type": "number",
            "enum": [
              100
            ],
            "description": "服務費(NTD)"
          },
          "amount": {
            "type": "number",
            "enum": [
              10
            ],
            "description": "應匯金額(NTD)"
          },
          "total_amount": {
            "type": "number",
            "enum": [
              110
            ],
            "description": "訂單總金額(NTD)"
          },
          "exchange_rate_flag": {
            "type": "string",
            "enum": [
              "IDR"
            ],
            "description": "外幣幣別"
          },
          "exchange_rate": {
            "type": "number",
            "enum": [
              400
            ],
            "description": "外幣匯率"
          },
          "referenceER": {
            "type": "number",
            "enum": [
              4000
            ],
            "description": "匯兌金額 (應匯金額 兌換 外幣金額)"
          },
          "trans_type": {
            "type": "string",
            "enum": [
              "BTB"
            ],
            "description": "匯款方式"
          },
          "trans_to": {
            "type": "string",
            "enum": [
              "XXX"
            ],
            "description": "交易銀行"
          },
          "note": {
            "type": "string",
            "enum": [
              "note..."
            ],
            "description": "備註"
          },
          "coupon_code": {
            "type": "string",
            "enum": [
              "``"
            ],
            "description": "coupon代碼"
          },
          "coupon_value": {
            "type": "number",
            "enum": [
              0
            ],
            "description": "coupon折價金額(NTD)"
          },
          "sign_image": {
            "type": "string",
            "enum": [
              "xxxx.png"
            ],
            "description": "簽名照"
          },
          "face_image": {
            "type": "string",
            "enum": [
              "xxxx.jpg"
            ],
            "description": "大頭照"
          },
          "arc_image": {
            "type": "string",
            "enum": [
              "xxxx.jpg"
            ],
            "description": "居留證照"
          },
          "arc_01_image": {
            "type": "string",
            "enum": [
              "xxxx.jpg"
            ],
            "description": "居留證照01"
          },
          "euso_order": {
            "type": "string",
            "enum": [
              "ROX00000000"
            ],
            "description": "訂單編號"
          },
          "branch_code": {
            "type": "string",
            "enum": [
              "ROX"
            ],
            "description": "門市代碼"
          },
          "status": {
            "type": "string",
            "enum": [
              "0|1|2"
            ],
            "description": "訂單狀態"
          },
          "pay": {
            "type": "string",
            "enum": [
              "0|1"
            ],
            "description": "付款狀態, 參照 **[付款狀態] PAY STATUS INFO**"
          },
          "remittance_order": {
            "type": "string",
            "enum": [
              "xxx0000000000"
            ],
            "description": "匯款單編號"
          },
          "sender_source_of_income": {
            "type": "string",
            "enum": [
              "001"
            ],
            "description": "資金來源"
          },
          "sender_source_of_income_other": {
            "type": "string",
            "enum": [
              "其他"
            ],
            "description": "資金來源-其他內容"
          },
          "sender_remittance_purpose": {
            "type": "string",
            "enum": [
              "001"
            ],
            "description": "匯款目的"
          },
          "sender_remittance_purpose_other": {
            "type": "string",
            "enum": [
              "其他"
            ],
            "description": "匯款目的-其他內容"
          },
          "recipinent_relationship": {
            "type": "string",
            "enum": [
              "001"
            ],
            "description": "匯款對象關係"
          },
          "recipinent_relationship_other": {
            "type": "string",
            "enum": [
              "其他"
            ],
            "description": "匯款對象關係-其他內容"
          },
          "ecPayOrderList": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "paymentType": {
                  "type": "string",
                  "enum": [
                    "CVS|BARCODE"
                  ],
                  "description": "繳費方式"
                },
                "barcode1": {
                  "type": "string",
                  "enum": [
                    "xxxxxxxxxxxxxx"
                  ],
                  "description": "條碼 1/3"
                },
                "barcode2": {
                  "type": "string",
                  "enum": [
                    "xxxxxxxxxxxxxx"
                  ],
                  "description": "條碼 2/3"
                },
                "barcode3": {
                  "type": "string",
                  "enum": [
                    "xxxxxxxxxxxxxx"
                  ],
                  "description": "條碼 3/3"
                },
                "paymentNo": {
                  "type": "string",
                  "enum": [
                    "xxxxxxxxxxxxxx"
                  ],
                  "description": "代碼"
                },
                "merchantTradeNo": {
                  "type": "string",
                  "enum": [
                    "ROX000000001"
                  ],
                  "description": "交易序號"
                },
                "expireDate": {
                  "type": "string",
                  "enum": [
                    "2011/11/01 00:00:00"
                  ],
                  "description": "繳費期限 yyyy/MM/dd HH:mm:ss"
                },
                "returnCode": {
                  "type": "string",
                  "enum": [
                    "``"
                  ],
                  "description": "繳費狀態"
                },
                "returnTime": {
                  "type": "string",
                  "enum": [
                    "2011/11/01 00:00:00"
                  ],
                  "description": "繳費時間 yyyy/MM/dd HH:mm:ss"
                },
                "paymentURLs": {
                  "type": "object",
                  "properties": {
                    "iBon": {
                      "type": "string",
                      "enum": [
                        "https://aaa.bbb.com/?123"
                      ],
                      "description": "iBon繳費頁URL"
                    },
                    "Family": {
                      "type": "string",
                      "enum": [
                        "https://aaa.bbb.com/?123"
                      ],
                      "description": "Family繳費頁URL"
                    },
                    "Hilife": {
                      "type": "string",
                      "enum": [
                        "https://aaa.bbb.com/?123"
                      ],
                      "description": "Hilife繳費頁URL"
                    }
                  },
                  "required": [
                    "iBon",
                    "Family",
                    "Hilife"
                  ],
                  "additionalProperties": false,
                  "description": "繳費頁URL"
                }
              },
              "required": [
                "paymentType",
                "barcode1",
                "barcode2",
                "barcode3",
                "paymentNo",
                "merchantTradeNo",
                "expireDate",
                "returnCode",
                "returnTime",
                "paymentURLs"
              ],
              "additionalProperties": false
            },
            "description": "繳費資訊"
          }
        },
        "required": [
          "remit_country",
          "sender_name",
          "sender_arc",
          "sender_arc_term",
          "sender_tel",
          "sender_mobile",
          "sender_country",
          "recipinent_name",
          "recipinent_tel",
          "recipinent_birthday_note",
          "debtorID",
          "debtorType",
          "loanStartYear",
          "loanStartMonth",
          "loanEndYear",
          "loanEndMonth",
          "loanMonthNumber",
          "loanFlexiFund",
          "loanPMAmount",
          "loanNumber",
          "loanPaymentCode",
          "loanPaymentType",
          "recipinent_number",
          "discount_fee",
          "red_point_discount",
          "service_fee",
          "amount",
          "total_amount",
          "exchange_rate_flag",
          "exchange_rate",
          "referenceER",
          "trans_type",
          "trans_to",
          "note",
          "coupon_code",
          "coupon_value",
          "sign_image",
          "face_image",
          "arc_image",
          "arc_01_image",
          "euso_order",
          "branch_code",
          "status",
          "pay",
          "remittance_order",
          "sender_source_of_income",
          "sender_source_of_income_other",
          "sender_remittance_purpose",
          "sender_remittance_purpose_other",
          "recipinent_relationship",
          "recipinent_relationship_other",
          "ecPayOrderList"
        ],
        "additionalProperties": false
      },
      "description": "回復資訊內容"
    },
    "paging": {
      "type": "object",
      "properties": {
        "pageItems": {
          "type": "number",
          "description": "單頁筆數"
        },
        "page": {
          "type": "number",
          "description": "當前頁數"
        },
        "pageNumbers": {
          "type": "number",
          "description": "總頁數"
        },
        "items": {
          "type": "number",
          "description": "總筆數"
        }
      },
      "description": "分頁資訊 (NEW! v1.0.5)"
    }
  },
  "required": [
    "response_text"
  ]
}

Resource

POST/api/services/sssRemit/uploadReceiptImg.api

Example URI

POST https://systest.index-group.com.tw/EUSO/api/services/sssRemit/uploadReceiptImg.api
Request  Form Submit
HideShow
Headers
Content-Type: multipart/form-data
Body
{
  "company": "index",
  "apid": "ROI01",
  "uuid": "1234567890",
  "euso_order": "ROX00000000",
  "receipt_image_file": "[file]"
}
Schema
{
  "type": "object",
  "properties": {
    "company": {
      "type": "string",
      "description": "公司代碼"
    },
    "apid": {
      "type": "string",
      "description": "APP 代碼"
    },
    "uuid": {
      "type": "string",
      "description": "使用者 UUID"
    },
    "euso_order": {
      "type": "string",
      "description": "訂單編號"
    },
    "receipt_image_file": {
      "type": "string",
      "description": "*file* 收據圖"
    }
  },
  "required": [
    "company",
    "apid",
    "uuid",
    "euso_order",
    "receipt_image_file"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "statusCode": "1",
  "message": "SUCCESS",
  "response_time": "2017/11/15 14:54:40",
  "response_text": "ok"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "string",
      "description": "交易狀態"
    },
    "message": {
      "type": "string",
      "description": "交易訊息"
    },
    "response_time": {
      "type": "string",
      "description": "回覆時間, yyyy/MM/dd HH:mm:ss"
    },
    "response_text": {
      "type": "string",
      "description": "回復資訊內容"
    }
  }
}

Resource

POST/api/services/sssRemit/verifyRemitAmountLimit.api

Example URI

POST https://systest.index-group.com.tw/EUSO/api/services/sssRemit/verifyRemitAmountLimit.api
Request  Form Submit
HideShow
Headers
Content-Type: form-data
Body
{
  "company": "index",
  "apid": "ROI01",
  "remit_country": "IDN",
  "sender_arc": "AA00000000"
}
Schema
{
  "type": "object",
  "properties": {
    "company": {
      "type": "string",
      "description": "公司代碼"
    },
    "apid": {
      "type": "string",
      "description": "APP 代碼"
    },
    "remit_country": {
      "type": "string",
      "description": "匯款國家, IDN, VNM, PHL"
    },
    "sender_arc": {
      "type": "string",
      "description": "寄件者居留證號碼,"
    }
  },
  "required": [
    "company",
    "apid",
    "sender_arc"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "statusCode": "1",
  "message": "SUCCESS",
  "response_time": "2017/11/15 14:54:40",
  "response_text": "ok",
  "month": 100
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "string",
      "description": "交易狀態"
    },
    "message": {
      "type": "string",
      "description": "交易訊息"
    },
    "response_time": {
      "type": "string",
      "description": "回覆時間, yyyy/MM/dd HH:mm:ss"
    },
    "response_text": {
      "type": "string",
      "description": "回復資訊內容"
    },
    "month": {
      "type": "number",
      "description": "本月匯款累計金額"
    }
  }
}

Resource

POST/api/services/sssRemit/queryCompleteRemitOrder.api

Example URI

POST https://systest.index-group.com.tw/EUSO/api/services/sssRemit/queryCompleteRemitOrder.api
Request  Form Submit
HideShow
Headers
Content-Type: form-data
Body
{
  "company": "index",
  "apid": "ROI01"
}
Schema
{
  "type": "object",
  "properties": {
    "company": {
      "type": "string",
      "description": "5碼 - 公司代碼"
    },
    "apid": {
      "type": "string",
      "description": "5碼 - APP 代碼"
    }
  },
  "required": [
    "company",
    "apid"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "statusCode": "1",
  "message": "SUCCESS",
  "response_time": "2017/11/15 14:54:40",
  "response_text": [
    {
      "uuid": "123456789",
      "euso_order": "AAA01123456789",
      "remittance_date": "2010/01/01 12:34:56",
      "remittance_order": "WCNE190101001",
      "trans_as": "1|3"
    },
    {
      "uuid": "123456789",
      "euso_order": "AAA01123456789",
      "remittance_date": "2010/01/01 12:34:56",
      "remittance_order": "WCNE190101001",
      "trans_as": "1|3"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "string",
      "description": "交易狀態"
    },
    "message": {
      "type": "string",
      "description": "交易訊息"
    },
    "response_time": {
      "type": "string",
      "description": "回覆時間, yyyy/MM/dd HH:mm:ss"
    },
    "response_text": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "uuid": {
              "type": "string",
              "enum": [
                "123456789"
              ],
              "description": "使用者 uuid"
            },
            "euso_order": {
              "type": "string",
              "enum": [
                "AAA01123456789"
              ],
              "description": "訂單編號"
            },
            "remittance_date": {
              "type": "string",
              "enum": [
                "2010/01/01 12:34:56"
              ],
              "description": "轉入匯款單時間, 格式 : yyyy/MM/dd HH:mm:ss"
            },
            "remittance_order": {
              "type": "string",
              "enum": [
                "WCNE190101001"
              ],
              "description": "匯款單號"
            },
            "trans_as": {
              "type": "string",
              "enum": [
                "1|3"
              ],
              "description": "繳費方式. 參考 [付款方式] TRANS AS INFO"
            }
          },
          "required": [
            "uuid",
            "euso_order",
            "remittance_date",
            "remittance_order",
            "trans_as"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "uuid": {
              "type": "string",
              "enum": [
                "123456789"
              ],
              "description": "使用者 uuid"
            },
            "euso_order": {
              "type": "string",
              "enum": [
                "AAA01123456789"
              ],
              "description": "訂單編號"
            },
            "remittance_date": {
              "type": "string",
              "enum": [
                "2010/01/01 12:34:56"
              ],
              "description": "轉入匯款單時間, 格式 : yyyy/MM/dd HH:mm:ss"
            },
            "remittance_order": {
              "type": "string",
              "enum": [
                "WCNE190101001"
              ],
              "description": "匯款單號"
            },
            "trans_as": {
              "type": "string",
              "enum": [
                "1|3"
              ],
              "description": "繳費方式. 參考 [付款方式] TRANS AS INFO"
            }
          },
          "required": [
            "uuid",
            "euso_order",
            "remittance_date",
            "remittance_order",
            "trans_as"
          ],
          "additionalProperties": false
        }
      ],
      "description": "回復資訊內容"
    }
  },
  "required": [
    "response_text"
  ]
}

Resource

POST/api/services/sssRemit/queryLoanConfigJSON.api

Example URI

POST https://systest.index-group.com.tw/EUSO/api/services/sssRemit/queryLoanConfigJSON.api
Request  Form Submit
HideShow
Headers
Content-Type: form-data
Body
{
  "company": "EEC",
  "apid": "ROE01"
}
Schema
{
  "type": "object",
  "properties": {
    "company": {
      "type": "string",
      "description": "5碼 - 公司代碼"
    },
    "apid": {
      "type": "string",
      "description": "5碼 - APP 代碼"
    }
  },
  "required": [
    "company",
    "apid"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "statusCode": "1",
  "message": "SUCCESS",
  "response_time": "2017/11/15 14:54:40",
  "response_text": {
    "LoanPMAmountMap": {
      "[trans_type]": {
        "[loanPaymentCode]": [
          960,
          1000
        ]
      }
    },
    "LoanMonthNumberMap": {
      "[trans_type]": {
        "[loanPaymentCode]": [
          6,
          12
        ]
      }
    },
    "LoanPaymentCodeMap": {
      "[trans_type]": [
        {
          "[loanPaymentCode]": "display name"
        }
      ]
    },
    "LoanPaymentTypeMap": {
      "[LoanPaymentCode]": [
        {
          "[LoanPaymentType]": "display name"
        }
      ]
    },
    "supportLoanPaymentFlexFundMap": {
      "[trans_type]": {
        "[loanPaymentCode]": [
          "100",
          "200"
        ]
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "string",
      "description": "交易狀態"
    },
    "message": {
      "type": "string",
      "description": "交易訊息"
    },
    "response_time": {
      "type": "string",
      "description": "回覆時間, yyyy/MM/dd HH:mm:ss"
    },
    "response_text": {
      "type": "object",
      "properties": {
        "LoanPMAmountMap": {
          "type": "object",
          "properties": {
            "[trans_type]": {
              "type": "object",
              "properties": {
                "[loanPaymentCode]": {
                  "type": "array"
                }
              },
              "description": "Trans Type 限制金額, SSS|PGB|PHI"
            }
          }
        },
        "LoanMonthNumberMap": {
          "type": "object",
          "properties": {
            "[trans_type]": {
              "type": "object",
              "properties": {
                "[loanPaymentCode]": {
                  "type": "array"
                }
              },
              "description": "限制月份, SSS|PGB|PHI"
            }
          },
          "description": "月份限制"
        },
        "LoanPaymentCodeMap": {
          "type": "object",
          "properties": {
            "[trans_type]": {
              "type": "array"
            }
          },
          "description": "Payment Code Map"
        },
        "LoanPaymentTypeMap": {
          "type": "object",
          "properties": {
            "[LoanPaymentCode]": {
              "type": "array"
            }
          },
          "description": "Payment Type Map"
        },
        "supportLoanPaymentFlexFundMap": {
          "type": "object",
          "properties": {
            "[trans_type]": {
              "type": "object",
              "properties": {
                "[loanPaymentCode]": {
                  "type": "array",
                  "description": "支援 flux fund 的 loanPMAmount"
                }
              }
            }
          },
          "description": "Payment Type Map"
        }
      },
      "description": "回復資訊內容"
    }
  }
}

Remit Ref Table

EEC

  • company : eec

  • apid :

  • lang: en_PH, zh_TW

  • sender_country: PHL

  • trans_type : SSS, PGB, PHI

[繳費方式] TRANS TYPE INFO TABLE

  • SSS

  • PGB

  • PHI

[繳費代號] LOAN PAYMENT CODE INFO TABLE

  • SSS

    • 001 : Contribution
    • 014 : Short-Term
    • 015 : Real Estate Loans

  • PGB

    • 001 : PGB2 - Voluntary
    • 002 : Housing Loan
    • 014 : Short-Term
    • 031 : PGB1 - MANDATORY

  • PHI

    • 001 : Contribution

[繳費類型] LOAN PAYMENT TYPE INFO TABLE

  • 001 : Contribution

  • 002 : Housing Loan

    • E : Principal
    • R : Amortization
    • F : Full Payment

  • 014 : Short-Term

    • S : Salary Loan
    • C : Calamity Loan
    • R : Emergency Loan
    • E : Educational Loan

  • 015 : Real Estate Loans

    • 1 : REL Payment
    • 2 : Fire Insurance
    • 3 : MRI
    • 9 : MISCELLANEOUS
  • 031 : PGB1 - MANDATORY

[匯款單狀態] STATUS INFO

  • 0 : 失敗 | 關閉

  • 1 : 成功

  • 2 : 待審核

[付款狀態] PAY STATUS INFO

  • 0 : 未付款

  • 1 : 己付款

[付款方式] TRANS AS INFO

  • 1 : 門市付款

  • 3 : 超商付款

[資金來源] Source of income List

  • 001 : 薪資

  • 002 : 獎金

  • 999 : 其他

[匯款目的] Remittance purpose List

  • 001 : 存款

  • 002 : 家用

  • 003 : 醫療費

  • 999 : 其他

[匯款對象關係] Relationship List

  • 001 : 本人帳戶

  • 002 : 家人

  • 003 : 朋友

  • 999 : 其他

[付款方式] Payment Type

  • CVS : 超商代碼

  • BARCODE : 超商條碼

NOTES

0. Amount 計算

referenceER = loanPMAmount * loanMonthNumber + Flexi Fund

amount = referenceER * exchange_rate

total_amount = amount + service_fee - red_point_discount - coupon_value

1. Important Notes with SSS Service Mode:

  • SSS requires that Payments must be converted to PHP. Local currency amount must be converted to PHP using the prevailing exchange rates set in IRemit system (as applicable).

  • There is no Principal Amount validation for SSS Loans and all non-contribution payments.

  • For SSS Contributions: Payment Period Validations

    • For January to September contributions, deadline of payment would be until December 31 of the same year. Payments beyond the deadline would be rejected.
    • For October to December contributions, the deadline of payment is up to January 31 of the following year. Payments beyond the deadline would be rejected.
    • Starting April 1, 2019 new SSS payment schedule will take effect using the new upgraded contribution rate
    • January – March 2019 contribution rates still use the old rate even if the new rate already takes effect.
    • Starting April 1, 2019, contribution payments for January – March 2019 must not be mixed up with contributions for April 2019 and onwards. This is due to a restriction of the PRN-based payment system of SSS.

1.1. Contribution

loanPaymentCode = 001( SSS Contribution ) Computation Formula:

Payment Amount = SSS Payment x No of Months
Payment Amount = Php 960.00 x 2
Payment Amount = Php 1,920.00

Fields to be populated:
loanPMAmount = PHP 960.00
referenceER = PHP 1,920.00
debtorID = 3387339666
loanPaymentCode = 001
loanStartYear = 2020
loanStartMonth = 10
loanEndYear = 2020
loanEndMonth = 11
loanMonthNumber = 2

1.2. Flexi Fund

loanPaymentCode = 001( SSS Contribution with Flexi Fund ) Computation Formula

SSS Flexi Funds are the contributions in excess of the total monthly dues (Php 2,400.00).

Specifications:

  - SSS Flexi Fund must be at least PHP200 or higher. Less than PHP200 will be ignored.
  - Monthly Due would then be fixed at PHP2,400.
  - Flexi Funds will not be explicitly defined but rather, it will be included in the Principal amount computation.

Payment Amount = SSS Payment x No of Months + Flexi Fund
Payment Amount = Php 2,400.00 x 2 + Php 200.00
Payment Amount = Php 5,000.00

Fields to be populated
loanFlexiFund = php 200.00
loanPMAmount = php 2,400.00
referenceER = Php 5,000.00
debtorID = 3387339666
loanPaymentCode = 001
loanStartYear = 2020
loanStartMonth = 10
loanEndYear = 2020
loanEndMonth = 11
loanMonthNumber = 2

1.3. Short Term Loan

loanPaymentCode = 014( SSS Short-Term Loans ) Computation Formula

Payment Amount = Amount x No of Months
Payment Amount = Php 2,500.00 x 2
Payment Amount = Php 5,000.00

Fields to be populated
referenceER = Php 5,000.00
loanPaymentCode = 014
loanStartYear = 2020
loanStartMonth = 10
loanEndYear = 2020
loanEndMonth = 11
loanMonthNumber = 2
loanPMAmount = Php 2,500.00
loanPaymentType = S/C/R/E

1.4. Real Estate Loans

loanPaymentCode = 015( SSS Real Estate Loans ) Computation Formula

Payment Amount = Amount x No of Months
Payment Amount = Php 2,500.00 x 2
Payment Amount = Php 5,000.00

Fields to be populated
referenceER = Php 5,000.00
loanPaymentCode = 014
loanStartYear = 2020
loanStartMonth = 10
loanEndYear = 2020
loanEndMonth = 11
loanMonthNumber = 2
loanPMAmount = Php 2,500.00
loanPaymentType = 1/2/3/9

2. Important Notes with PGB Service Mode:

  • PGB requires that Payments must be converted to PHP. To do this, Local currency amount must be converted to PHP using the prevailing exchange rate maintained in IRemit systems (as applicable)

  • Minimum of Php 200 is accepted.

2.1. Contributions

loanPaymentCode = 001/031/033( Pagibig Contributions) Computation Formula

Payment Amount = Amount x No of Months
Payment Amount = Php 200.00 x 1
Payment Amount = Php 200.00

Fields to be populated
referenceER = Php 200.00
loanPaymentCode = 001/031/033
loanStartYear = 2020
loanStartMonth = 10
loanEndYear = 2020
loanEndMonth = 10
loanMonthNumber = 1
loanPMAmount = Php 200.00

2.2. Housing Loans

loanPaymentCode = 002( Pagibig Housing Loans) Computation Formula

Payment Amount = Amount x No of Months
Payment Amount = Php 200.00 x 1
Payment Amount = Php 200.00

Fields to be populated
referenceER = Php 200.00
loanPaymentCode = 002
loanStartYear = 2020
loanStartMonth = 10
loanEndYear = 2020
loanEndMonth = 10
loanMonthNumber = 1
loanPMAmount = Php 200.00
loanPaymentType = E/R/F

2.3. Salary/Short-Term Loans

loanPaymentCode = 003/014( Pagibig Salary/Short-Term Loans) Computation Formula

Payment Amount = Amount x No of Months
Payment Amount = Php 200.00 x 1
Payment Amount = Php 200.00

Fields to be populated
referenceER = Php 200.00
loanPaymentCode = 003/014
loanStartYear = 2020
loanStartMonth = 10
loanEndYear = 2020
loanEndMonth = 10
loanMonthNumber = 1
loanPMAmount = Php 200.00

3. Important Notes with PHN Service Mode:

  • PHN requires that Payments must be converted to PHP. To do this, Local currency amount must be converted to PHP using the prevailing exchange rates (that is QAR->PHP).

3.1 Contributions

loanPaymentCode = 001( Philhealth Contributions ) Computation Formula

Payment Amount = PHN Contribution Amount - No of Months(see to PHN Contribution table )
Payment Amount = Php 1,200.00 - 6
Payment Amount = Php 1,200.00

Fields to be populated
referenceER = Php 1,200.00
loanPaymentCode = 001
loanStartYear = 2020
loanStartMonth = 10
loanEndYear = 2021
loanEndMonth = 3
loanMonthNumber = 6
loanPMAmount = Php 200.00

Generated by aglio on 09 Jun 2023