FundConnext€¦ · 1.3 Subscription - newUnitholderIdRef max length to 20 Change characters...

Page 1 of 50

FundConnext

Restful Web services API

Message Specification

for

No Migration Customer

Version 1.9

Sep 11 , 2020

Page 2 of 50

Revision

Revision Description Updated by Updated Date

0.30 1. Create from standard API Chatchai 25/01/2017

0.31 1. Adjust IC License to optional 2. Adjust redemptionType possible value from “Unit”

to “UNIT 3. Add validate minimum unit/balance redemption

and switching out 4. Update switching error message spec 5. Update cancel and approve error message spec 4. Update Create Passthrough Customer spec 5. Remove getPassThrough Customer spec 6. Update endpoint URL 7. Add download API spec

Chatchai 17/02/2017

1.0 Subscription - Update settlementBankCode and

settlementBankAccount to be optional. - Disable payment type CHQ_SA and CRC_SA

(error message E112) - Add bank mapping validation (error message

E113) - paymentType CHQ_AMC, require to fill pay in AMC

bank code/ account in settlementBankCode and settlementBankAccount

- bankCode is mandatory, if paymentType is CRC_AMC

Redemption - Update settlementBankCode and

settlementBankAccount to be optional. - Add possible value of reasonToSellLtfRmf.

Download - Add Nav to be possible value for download API Error Message - Remove error code E101 - Add required field error code in approve and cancel

API.

Chatchai 19/05/2017

Page 3 of 50

1.2 Subscription - Add error code E209 to reject FATCA person to

buy fund that not allow for FATCA person. - Add field chqBranch for payment type CHQ_AMC

Switching

Add error code E253 and E254 to validate switching transaction

Download Add possible value to download Switching Matrix and Trade Calendar

Chatchai 07/08/2017

1.3 Subscription - Change newUnitholderIdRef max length to 20

characters

Subscription/ Redemption / Switching - Add field status for create approved order

Chatchai 24/11/2017

1.4 Add Change Password API Switching - Edit amount and unit format to be 18,2 and 18,4

respectively. Download - Add Unitholder Balance and Allotted Transaction

Upload - Add upload order file

Chatchai 29/01/2018

1.5 Download - Add Dividend News and Dividend Transaction

Chatchai 14/05/2018

1.6 Subscription - Enable payment type CHQ_SA

Chatchai 20/08/2018

1.7 Create Customer - add v2 to support update request - add v3 to support customer profile v3.0

Chatchai 5/11/2018

1.8 Subscription - Add v2 to support FinNet real time - Add field issuedBy and creditCardNo for paymentType = CRC_* Payment Inquiry - New api for inquiry payment status by transactionId Upload Attachment - Add new api to upload attachment files Download - Fund Performance - Suspend UHID - Assigned UHID - LTF Balance - Master data such as postal code, bank branch

code, amc code and sa code.

Chatchai 11/11/2019

Page 4 of 50

1.8.1 Change Password Update url from /api/changePassword/ to

/api/auth/changePassword/

Chatchai 16/07/2020

1.9 Subscription Change setttlementBankCode and settlementBankAccount from optional to mandatory

Chatchai 11/09/2020

Page 5 of 50

Table of Contents

Login .......................................................................................................................................... 6

Change Password ...................................................................................................................... 7

Create Subscription ................................................................................................................... 9

Create Subscription V2 .............................................................................................................14

Payment Status Inquiry .............................................................................................................20

Create Redemption ...................................................................................................................21

Create Switching .......................................................................................................................26

Cancel Subscription ..................................................................................................................31

Cancel Redemption ..................................................................................................................33

Cancel Switching ......................................................................................................................35

Approve Subscription ................................................................................................................37

Approve Redemption ................................................................................................................39

Approve Switching ....................................................................................................................41

Create Customer .......................................................................................................................43

Create Customer V2 .................................................................................................................44

Create Customer V3 .................................................................................................................45

Download File ...........................................................................................................................46

Upload File ................................................................................................................................48

Upload Attachment .................................................................................................................49

Page 6 of 50

Login Title Login

Description Login to the system and acquire access tokens URL /api /auth Method POST URL Params Required:

N/A Optional: N/A

Header Attribute

Example: {

"Content-Type": "application/json" }

Data Params Example:

{ "username": "SAA1", "password": "1233", }

Possible Data Params

Key Mandatory Type Max size

Remark

username Y Char 15 password Y Char 15

Success Response

Example:

Status: 200 { "username": "SAA1", "access_token": "n47vrc97jvneqop57xEDKO8E19LSBOEKoseF83", "saCode": "SAOne" }

Error Response

List of error message:

Status: 401 Unauthorized { "errMsg": { "code": "E000", "message": "Unauthorized access" } }

Possible Response

Key Mandatory Type Remark

username Y Char [Success Case] access_token Y Char [Success Case] Access token to be sent

in header of future request saCode Y Char [Success Case] Selling Agent that user

can act on behalf of errMsg Y [Fail Case] code Y Char [Fail Case] Error code message Y Char [Fail Case] Error message for Error

response (status != 200)

Note Token has session time 30 minutes.

Page 7 of 50

Change Password Title Change Password

Description Change password of current user

URL /api/auth/changePassword/

Method POST

URL Params Required: N/A Optional: N/A

Header

Attribute

Example: {

"X-Auth-Token": "01KEOKD0387dKEPGKJEEDFKLJ", "Content-Type": "application/json" }


{ " newPassword":"pAssword0123" }

Possible

Data Params

Key Mandatory Type Max

size

Remark

newPassword Y Char 32 Compiled Policy Password Password Length: 8 - 32 characters (Allow special characters such as ! @ # $). Password Complexity: Password must contain at least - One uppercase letter - One lowercase letter - One numeral Enforce Password History: Five of

different unique passwords that a

user must use before the user is

allowed to reuse a previous

password.

Success

Response

Example:

Status: 200 OK

Error

Response

Example:

Status: 401 Unauthorized { "errMsg": { "code": "E000", "message": "Unauthorized access" } } Status: 500 Internal Server Error {

Page 8 of 50

"errMsg": { "code": "E002", "message": "InvalidPasswordPolicy" } }

Possible

Response


Remark

errMsg Y [Fail Case] Code Y Char 4 [Fail Case] Error code Message Y Char 100 [Fail Case] Error message for Error


Page 9 of 50

Create Subscription Title Create Subscription

Description Create new subscription order URL /api/passthrough/subscriptions/ Method POST URL Params Required:

N/A Optional: N/A

Header Attribute

Example: {



{ "saOrderReferenceNo":"91993207101", "transactionDateTime":"20161005101010", "saCode": "SEBA", "unitholderId":"1001", “newUnitholderIdRef” : “ABC123”, "overrideRiskProfile": "Y", "overrideFxRisk": "Y", "fundCode":"AAB", "amount":"10000.00", "effectiveDate":"20161005", "paymentType":"ATS_SA", "bankCode":"001", "bankAccount":"12345", "channel":"MOB", "icLicense":"00001", "branchNo":"001", "forceEntry":"N", “settlementBankCode”: “001”, “settlementBankAccount”: “123” }



Remark

saOrderReferenceNo Y Char 30 Reference order from SA system

transactionDateTime Y Char 14 Transaction Time from SA System Format: YYYYMMDDHHMMSS

saCode Y Char 15 unitholderId Y Char 15 AMC’s unitholder ID

[SEG] when create new segregate unitholder ID [OMN] when create new omnibus unitholder ID

newUnitholderIdRef N Char 20 Reference Customer from SA

system. Required: when no unitholder ID

fundCode Y Char 30 amount Y Number 18,2 Example: 1000.00 effectiveDate Y Date 8 Format: YYYYMMDD

Example: 20160930 overrideRiskProfile Y Char 1 [Y]- accept to invest in fund that

has higher risk than risk profile.

Page 10 of 50

[N] – no override overrideFxRisk Y Char 1 [Y]- accepts to invest in fund that

has FX risk [N] – no override

paymentType Y Char 8

[ATS_SA] = ATS to/by SA [EATS_SA] = E-ATS to/by SA [TRN_SA] = Bank Transfer to SA [CHQ_SA] = Cheque pay to/by SA [CRC_SA] = Credit card to SA [ATS_AMC] = ATS to/by AMC [TRN_AMC] = Bank Transfer to AMC [CHQ_AMC] = Cheque pay to/by AMC [CRC_AMC] = Credit card to AMC

creditCardNo N Char 16 Credit Card No Required if paymentType = [CRC_*]

issuedBy N Char 20 Credit card issuer Required if paymentType = [CRC_*]

bankCode N Char 4 Required if paymentType = [ATS_*] , [EATS_*],[TRN_*],[CHQ_*]

bankAccount N Char 20 Bank Account Required if paymentType = [ATS_*] , [EATS_*],[TRN_*]

payChequeNo N Char 10 Required if paymentType = [CHQ_*]

payChequeDate N Date 8 Required if paymentType = [CHQ_AMC]

channel Y Char 3 [MOB] = Order from mobile device [ONL] = Internet exclude mobile [MKT] = Marketing/Counter

icLicense N Char 10 IC License branchNo N Char 5 SA Branch Code forceEntry Y Char 1 [Y] = Force to skip cut-off time

validation [N] = Normal order

ltfCondition N Char 1 Only LTF [0] = Not transfer to another LTF [1] = Transfer to another LTF

autoRedeemFundCode N Char 30 Only term fund Fill fund code that subscription when auto redeem term fund.

settlementBankCode Y Char 4 settlementBankAccount Y Char 20 chqBranch N Char 5 Mandatory if paymentType is

[CHQ_*]

status N Char 10 [APPROVED] = create approved order

Success Response

Example:

Status: 200 { "transactionId": "00116100600159217", "saOrderReferenceNo": "91993207101"

Page 11 of 50

} Error Response

Example:

Status: 401 Unauthorized { "errMsg": { "code": "E000", "message": "Unauthorized access" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E001", "message": "<Field Name> is required field." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E002", "message": "Invalid field format." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E003", "message": "<Field Name> is invalid." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E104", "message": " Fund Code cannot be found." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E112", "message": "Payment type cheque to SA and credit card to SA are not available " } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E113", "message": "Bank code mapping not found" } } Status: 422 Unprocessable Entry {

Page 12 of 50

"errMsg": { "code": "E201", "message": "Amount must be greater than zero" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E202", "message": " Amount must not be over two place of decimal." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E209", "message": " This fund does not accept order from US citizen." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E251", "message": "Subscription amount is less than minimum initial purchase" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E252", "message": "Subscription amount is less than minimum purchase" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E301", "message": " Effective Date cannot be past date" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E302", "message": " Effective date must be the business date for this fund" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E303", "message": " This transaction is submitted after cut-off time, please change the effective date"

Page 13 of 50

} } Status: 422 Unprocessable Entry { "errMsg": { "code": "E401", "message": " Duplicated SA Order Reference No" } }

Possible Response


Remark

transactionId Y Char 17 [Success Case] Transaction Id in fundConnext

saOrderReferenceNo Y Char 30 [Success Case] Same value of original reference id



Page 14 of 50

Create Subscription V2 Title Create Subscription V2

Description

Create new subscription order to support FinNet real time (For discussion)

URL /api/passthrough/subscriptions/v2 Method POST URL Params

Required: N/A Optional: N/A

Header Attribute

Example: {


Data Params

Example: { "saOrderReferenceNo":"91993207101", "transactionDateTime":"20161005101010", "saCode": "SEBA", "unitholderId":"1001", “newUnitholderIdRef” : “ABC123”, "overrideRiskProfile": "Y", "overrideFxRisk": "Y", "fundCode":"AAB", "amount":"10000.00", "effectiveDate":"20161005", "paymentType":"ATS_SA", "channel":"MOB", "icLicense":"00001", "branchNo":"001", "forceEntry":"N", “settlementBankCode”: “001”, “settlementBankAccount”: “0987654321”, “sendingBankCode”: “002”, “sendingBankAccount”: “1234567890”, “sendingBankAccountName” :”นายกองทนุ ทดสอบ”,

“sendingBankAccountTaxId” : “1234567890123”, “receivingBankCode”: “002”, “receivingBankAccount”: “1234567890”, “receivingBankAccountName” :”บรษิทั เอบซี ีจ ากดั”, “receivingBankAccountTaxId” : “1234567890123”, “finnetCustomerNo” : “12345” }



Remark




[SEG] when create new segregate unitholder ID [OMN] when create new omnibus unitholder ID

Page 15 of 50

newUnitholderIdRef N Char 20 Reference Customer from SA system. Required: when no unitholder ID

fundCode Y Char 30 amount Y Number 18,2 Example: 1000.00 effectiveDate Y Date 8 Format: YYYYMMDD

Example: 20160930 overrideRiskProfile Y Char 1 [Y]- accept to invest in fund that

has higher risk than risk profile. [N] – no override

overrideFxRisk Y Char 1 [Y]- accepts to invest in fund that has FX risk [N] – no override

paymentType Y Char 8 [ATS_SA] = ATS to/by SA

[EATS_SA] = E-ATS to/by SA

[TRN_SA] = Bank Transfer to

SA

[CHQ_SA] = Cheque pay to/by

SA

[CRC_SA] = Credit card to SA

[ATS_AMC] = ATS to/by AMC

[TRN_AMC] = Bank Transfer to

AMC

[CHQ_AMC] = Cheque pay

to/by AMC

[CRC_AMC] = Credit card to AMC

creditCardNo N Char 16 Credit Card No Required if paymentType = [CRC_*]

issuedBy N Char 20 Credit card issuer Required if paymentType = [CRC_*]

payChequeBankCode N Char 4 Mandatory if paymentType is [CHQ_*]

payChequeNo N Char 10 Required if paymentType = [CHQ_*]

payChequeDate N Date 8 Required if paymentType = [CHQ_AMC]

channel Y Char 3 [MOB] = Order from mobile device [ONL] = Internet exclude mobile [MKT] = Marketing/Counter

icLicense N Char 10 IC License branchNo N Char 5 SA Branch Code forceEntry Y Char 1 [Y] = Force to skip cut-off time

validation [N] = Normal order

ltfCondition N Char 1 Only LTF [0] = Not transfer to another LTF [1] = Transfer to another LTF

autoRedeemFundCode N Char 30 Only term fund Fill fund code that subscription when auto redeem term fund.

settlementBankCode Y Char 4 settlementBankAccount Y Char 20 chqBranch N Char 5 Mandatory if paymentType is

[CHQ_*]

Page 16 of 50


compCompCode N Char 20 Mandatory for [ATS_*] and use FinNet real time Company Code assigned by bank

sendingBankCode N Number 3 Mandatory for [ATS_*]

รหสัธนาคารของผูจ้่าย (นกัลงทุน)

sendingBankAccountNo N Number 15 Mandatory for [ATS_*]

เลขทีบ่ญัชขีองผูจ้่าย (นกัลงทุน)

sendingBankAccountName N Char 120 Mandatory for [ATS_*] and use FinNet real time

ชือ่บญัชขีองผูจ้่าย (นกัลงทุน)

sendingBankAccountTaxId N Char 13 Mandatory for [ATS_*] and use FinNet real time

รหสัประจ าตวัผูเ้สยีภาษขีองผูจ้่าย(นกัลงทุน)

(บุคคลธรรมดาใชเ้ลขบตัรประชาชน)

receivingBankCode N Number 3 Mandatory for [ATS_*] and use FinNet real time or [TRN_*]

รหสัธนาคารของผูร้บั (SA หรอื AMC

แลว้แต่ payment type)

receivingBankAccountNo N Number 15 Mandatory for [ATS_*] and use FinNet real time or [TRN_*]

เลขทีบ่ญัชขีองผูร้บั (SA หรอื AMC


receivingBankAccountName N Char 120 Mandatory for [ATS_*] and use FinNet real time

ชือ่บญัชขีองผูร้บั (SA หรอื AMC


receivingBankAccountTaxId N Char 13 Mandatory for [ATS_*] and use FinNet real time

รหสัประจ าตวัผูเ้สยีภาษขีองผูร้บั (SA หรอื AMC แล้วแต่ payment type)

finnetCustomerNo N Char 30 Mandatory for [ATS_*] and use FinNet real time with KBANK and BBL

หมายเลขลกูคา้ของบรษิทัสมาชกิทีธ่นาคารเป็นผูก้ าหนด

Success Response

Example:

Status: 200 { "transactionId": "00116100600159217", "saOrderReferenceNo": "91993207101" }

Error Response

Example:

Status: 401 Unauthorized { "errMsg": { "code": "E000", "message": "Unauthorized access" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E001", "message": "<Field Name> is required field."

Page 17 of 50

} } Status: 422 Unprocessable Entry { "errMsg": { "code": "E002", "message": "Invalid field format." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E003", "message": "<Field Name> is invalid." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E104", "message": " Fund Code cannot be found." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E112", "message": "Payment type cheque to SA and credit card to SA are not available " } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E113", "message": "Bank code mapping not found" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E201", "message": "Amount must be greater than zero" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E202", "message": " Amount must not be over two place of decimal." } }

Page 18 of 50

Status: 422 Unprocessable Entry { "errMsg": { "code": "E209", "message": " This fund does not accept order from US citizen." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E251", "message": "Subscription amount is less than minimum initial purchase" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E252", "message": "Subscription amount is less than minimum purchase" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E301", "message": " Effective Date cannot be past date" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E302", "message": " Effective date must be the business date for this fund" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E303", "message": " This transaction is submitted after cut-off time, please change the effective date" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E401", "message": " Duplicated SA Order Reference No" } }

Possible Response


Remark


Page 19 of 50




Page 20 of 50

Payment Status Inquiry Title Payment Status Inquiry

Description Payment Status Inquiry

URL /api/passthrough/payment/query/:transactionId

Method GET URL Params Required:

transactionId Optional: N/A

Possible URL Params


Remark

transactionId Y Char 16 Transaction Id in fundConnext

Success

Response

Example:

Status: 200 { "paymentStatus": "SUCCESS", "paymentInstructor": "FND", "paymentProcessingType" : "R" }

Error

Response

Example:

Status: 422 Unprocessable Entry { "errMsg": { "code": "E107", "message": "Transaction ID cannot be found." } }

Possible

Response

Key Mandatory Type Max

size

Remark

paymentInstructor N Char 3 [Success Case] Only paymentType = [ATS_*] [FND] = processed by FinNet [SA] = processed by SA [AMC] = process by AMC

paymentProcessingType N Char 1 [Success Case] Only paymentInstructor = [FND] [B]= Batch [R]= Real time

paymentStatus N Char 10 [Success Case] Only paymentInstructor = [FND] [QUEUING] = in queue [PROCESSING]= processing by FinNet [SUCCESS] = payment sucess [FAILED] = payment failed

errMsg Y [Fail Case]

Code Y Char 4 [Fail Case] Error code

Message Y Char 100 [Fail Case] Error message for Error response (status != 200)

Page 21 of 50

Create Redemption Title Create Redemption

Description Create new redemption order URL /api/passthrough /redemptions/ Method POST URL Params Required:

N/A Optional: N/A

Header Attribute

Example: {



{ "saOrderReferenceNo":"91993207101", "transactionDateTime":"20161005101010", "unitholderId":"1001", "fundCode":"AAB", "redemptionType": "AMT", "amount":"10000.00", "effectiveDate":"20161005", "paymentType":"ATS_SA", "bankCode":"001", "bankAccount":"123", "channel":"MOB", "icLicense":"00001", "branchNo":"BB001", "forceEntry":"Y", }



Remark




fundCode Y Char 30 redemptionType Y Char 4 “UNIT” : unit

“AMT”: amount amount N Number 18,2 Example: 1000.00 unit N Number 18,4 Example: 100.0000 effectiveDate Y Date 8 Format: YYYYMMDD

Example: 20160930 paymentType Y Char 8 [ATS_SA] = ATS to/by SA

[CHQ_SA] = Cheque pay to/by SA [ATS_AMC] = ATS to/by AMC [CHQ_AMC] = Cheque pay to/by AMC

bankCode N Char 4 Required if paymentType =

[ATS_*] bankAccount N Char 20 Required if paymentType =

[ATS_*]

Page 22 of 50

channel Char 3 [MOB] = Order from mobile device [ONL] = Internet exclude mobile [MKT] = Marketing/Counter

icLicense N Char 10 IC License branchNo N Char 5 SA Branch Code forceEntry Y Char 1 [Y] = Force to skip cut-off

time validation [N] = Normal order

reasonToSellLtfRmf N Char 1 Only LTF/RMF: เหตุผลการขายคนืกรณ๊ กองทุน LTF /RMF

1 = ตาย 2 = ทพุพลภาพ

3 = ตามเงือ่นไขตามกรมสรรพากร 4 = ไมเ่ป็นไปตามเงือ่นไข 5 = ซือ้เกนิในปีปัจจุบนั

rmfCapGainWhtChoice N Char 1 Only RMF: ลกูคา้ใชส้ทิธปิระโยชน์ทางภาษ ีจากกองทนุ RMF รวมทกุ บลจ.ไมน้่อยกวา่ 5 ปี

Y : Waive withholding tax N : Charge withholding tax

rmfCapAmtRedeemChoice N Char 1 Only RMF: เงือ่นไขการตดัตน้ทุนเงนิลงทนุกองทุน RMF

1 : ตดัตน้ทนุเงนิลงทุนกอ่นประกาศ 2 : ตดัตน้ทนุเงนิลงทุนหลงัประกาศ 3 : ตดัตน้ทนุเงนิลงทุนทีซ่ ือ้ในปีปัจจุบนั

4 : ตดั FIFO ตามปกต ิsellAllUnitFlag N Char 1 [Y] = Sell all unit

[N] = Not sell all unit settlementBankCode N Char 4 Required if paymentType =

[*_SA]

settlementBankAccount N Char 20 Required if paymentType =

[*_SA]

status N Char 10 [APPROVED] = create

approved order

Success Response

Example:

Status: 200 { "transactionId": "00116100600159217", "saOrderReferenceNo": "91993207101", "settlementDate": "20161005" }

Error Response

Example:

Status: 401 Unauthorized { "errMsg": { "code": "E000", "message": "Unauthorized access" } } Status: 422 Unprocessable Entry { "errMsg": {

Page 23 of 50

"code": "E001", "message": "<Field Name> is required field." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E002", "message": "Invalid field format." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E003", "message": "<Field Name> is invalid." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E104", "message": " Fund Code cannot be found." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E113", "message": "Bank code mapping not found" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E201", "message": "Amount must be greater than zero" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E202", "message": " Amount must not be over two place of decimal." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E204", "message": "Unit must be greater than zero" }

Page 24 of 50

} Status: 422 Unprocessable Entry { "errMsg": { "code": "E205", "message": " Unit must not be over four place of decimal." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E207", "message": " Redemption amount/unit is less than minimum redemption amount/unit” } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E208", "message": "Order cannot redeem because latest unitholder balance from AMC does not update” } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E301", "message": " Effective Date cannot be past date" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E302", "message": " Effective date must be the business date for this fund" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E303", "message": " This transaction is submitted after cut-off time, please change the effective date" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E306", "message": " Advance order must be less than one year" } }

Page 25 of 50

Status: 422 Unprocessable Entry { "errMsg": { "code": "E401", "message": " Duplicated SA Order Reference No" } }

Possible Response


Remark



settlementDate Y Date 8 [Success Case] YYYYMMDD errMsg Y [Fail Case] code Y Char 4 [Fail Case] Error code message Y Char 100 [Fail Case] Error message for Error


Note

Page 26 of 50

Create Switching Title Create Switching

Description

Create new switching order

URL /api/passthrough /switchings/ Method POST URL Params

Required: N/A Optional: N/A

Header Attribute

Example: {


Data Params

Example:

{ "saOrderReferenceNo":"91993207101", "transactionDateTime":"20161005101010", "saCode": "SEBA", "unitholderId":"1001", "fundCode":"AAB", "overrideRiskProfile": "Y", "overrideFxRisk": "Y", "redemptionType ": "AMT", "amount":"10000.00", "counterFundCode ": "AALTF", "effectiveDate ":"20161005", "channel":"MOB ", "icLicense":"00001", "forceEntry":"N" }



Remark



saCode Y Char 15 unitholderId Y Char 15 fundCode Y Char 30 Switch out: Fund Code redemptionType Y Char 4 “UNIT” : unit

“AMT”: amount amount Number 18,2 unit Number 18,4 counterFundCode Y Char 30 Switch in: Fund Code effectiveDate Y Date 8 overrideRiskProfile Y Char 1 [Y]- accept to invest in

fund that has higher risk than risk profile. [N] – no override

overrideFxRisk Y Char 1 [Y]- accepts to invest in fund that has FX risk [N] – no override

channel Y Char 3 [MOB] = Order from mobile device [ONL] = Internet exclude mobile

Page 27 of 50

[MKT] = Marketing/Counter

icLicense N Char 10 IC License branchNo N Char 5 SA Branch Code forceEntry Y Char 1 [Y] = Force to skip cut-

off time validation [N] = Normal order

sellAllUnitFlag N Char 1 [Y] = Sell all unit [N] = Not sell all unit


Success Response

Example:

Status: 201 { "transactionId": "00116100600159217", "saOrderReferenceNo": "91993207101", }

Error Response

Example:

Status: 401 Unauthorized { "errMsg": { "code": "E000", "message": "Unauthorized access" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E001", "message": "<Field Name> is required field." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E002", "message": "Invalid field format." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E003", "message": "<Field Name> is invalid." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E201", "message": "Amount must be greater than zero" } } Status: 422 Unprocessable Entry

Page 28 of 50

{ "errMsg": { "code": "E202", "message": " Amount must not be over two place of decimal." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E204", "message": "Unit must be greater than zero" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E205", "message": " Unit must not be over four place of decimal." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E207", "message": " Redemption amount/unit is less than minimum redemption amount/unit” } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E208", "message": "Order cannot redeem because latest unitholder balance from AMC does not update” } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E251", "message": "amount is less than minimum initial purchase" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E252", "message": "amount is less than minimum purchase" } } Status: 422 Unprocessable Entry { "errMsg": {

Page 29 of 50

"code": "E253", "message": "Switching transaction is not valid from switching matrix" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E254", "message": "Switching’s type is not supported" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E301", "message": " Effective Date cannot be past date" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E302", "message": " Effective date must be the business date for this fund" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E303", "message": " This transaction is submitted after cut-off time, please change the effective date" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E306", "message": " Advance order must be less than one year" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E401", "message": " Duplicated SA Order Reference No" } }

Possible Response


Remark


saOrderReferenceNo Char 30 [Success Case] Same value of original reference id

errMsg [Fail Case] code Char 4 [Fail Case] Error code

Page 30 of 50

message Char 100 [Fail Case] Error message for Error response (status != 200)

Note

Page 31 of 50

Cancel Subscription Title Cancel Subscription

Description Cancel subscription order URL /api/passthrough /subscriptions/:transactionId Method DELETE URL Params Required:

N/A Optional: N/A

Header Attribute

Example: {

"X-Auth-Token": "01KEOKD0387dKEPGKJEEDFKLJ" }


{ "force": "Y" }



Remark

force N Char 1 Default : N Y=force to cancel order N=if order status is “APROVED”, order cannot be cancelled.

Success Response

Example:

Status: 200 { "transactionId": "00116100600159217", }

Error Response

Example:

Status: 401 Unauthorized { "errMsg": { "code": "E000", "message": "Unauthorized access" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E001", "message": "<Field Name> is required field." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E107", "message": "Transaction ID cannot be found." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E109", "message": "Transaction ID cannot be cancelled." }

Page 32 of 50

} Status: 422 Unprocessable Entry { "errMsg": { "code": "E304", "message": "Transaction ID cannot be cancelled as over cut-off time." } }

Possible Response


Remark


errMsg [Fail Case] code Char 4 [Fail Case] Error code message Char 100 [Fail Case] Error message for Error


Note

Page 33 of 50

Cancel Redemption Title Cancel Redemption

Description Cancel redemption order URL /api/passthrough /redemptions/:transactionId Method DELETE URL Params Required:

N/A Optional: N/A

Header Attribute

Example: {



{ "force": "Y" }



Remark


Success Response

Example:


Error Response

Example:


Page 34 of 50


Possible Response


Remark




Note

Page 35 of 50

Cancel Switching Title Cancel Switching

Description Cancel switching order URL /api/passthrough /switchings/:transactionId Method DELETE URL Params Required:

N/A Optional: N/A

Header Attribute

Example: {



{ "force": "Y" }



Remark


Success Response

Example:


Error Response

Example:


Page 36 of 50


Possible Response


Remark




Note

Page 37 of 50

Approve Subscription Title Approve Subscription

Description Approve subscription order URL /api/passthrough /subscriptions/:transactionId Method PATCH URL Params Required:

N/A Optional: N/A

Header Attribute

Example: {



{ "status": "Approve" }



Remark

status Y Char 10

Success Response

Example:

Status: 200 { "transactionId": "00116100600159217" }

Error Response

Example:

Status: 401 Unauthorized { "errMsg": { "code": "E000", "message": "Unauthorized access" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E001", "message": "<Field Name> is required field." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E107", "message": "Transaction ID cannot be found." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E106", "message": "Transaction is already approved." } }

Page 38 of 50

Status: 422 Unprocessable Entry { "errMsg": { "code": "E110", "message": "Transaction ID cannot be approved." } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E305", "message": "Transaction ID cannot be approved as over approved period." } }

Possible Response


Remark




Note

Page 39 of 50

Approve Redemption Title Approve Redemption

Description Approve redemption order URL /api/passthrough /redemptions/:transactionId Method PATCH URL Params Required:

N/A Optional: N/A

Header Attribute

Example: {






Remark

status Y Char 10

Success Response

Example:


Error Response

Example:


Page 40 of 50


Possible Response


Remark




Note

Page 41 of 50

Approve Switching Title Approve Switching

Description Approve switching order URL /api/passthrough /switchings/:transactionId Method PATCH URL Params Required:

N/A Optional: N/A

Header Attribute

Example: {






Remark

status Y Char 10

Success Response

Example:


Error Response

Example:


Page 42 of 50


Possible Response


Remark




Note

Page 43 of 50

Create Customer Title Create Passthrough Customer

Description Create new passthrough customer URL /api/passthrough/customers/ Method POST URL Params Required:

N/A Optional: N/A

Header Attribute

Example: {



{ "amcCode": "SEBA", “effectiveDate”: “20170217”, “customerProfile”: “xxx|xxxxx|xxxx”, “customerProfileDetail”: “xxx|xxxxx|xxxx^xxxxx|xxxxx|xxxxx”, “bankAccount”: “xxx|xxxxx|xxxx” }



Remark

amcCode Y Char 15 effectiveDate Y Char 10 Format: YYYYMMDD customerProfile Y Char 10,000 Use standard FundConnext

format customerProfileDetail Y Char 10,000 Use standard FundConnext

format New line using “^”

bankAccount Y Char 10,000 Use standard FundConnext format New line using “^”

Success Response

Example:

Status: 200 { "referenceNo": "00116100600159217", }

Possible Response


Remark

referenceNo Y Char 17 [Success Case] Reference No from fundConnext

errMsg Y [Fail Case] code Y Char 4 [Fail Case] Error code message Y Char 100 [Fail Case] Error message for Error


Page 44 of 50

Create Customer V2 Title Create/Update Passthrough Customer

Description Create new passthrough customer; and update if newUnitholderIdReferenceNo and effectiveDate already exists

URL /api/passthrough/customers/v2 Method POST URL Params Required:

N/A Optional: N/A

Header Attribute

Example: {






Remark





Success Response

Example:


Possible Response


Remark




Page 45 of 50

Create Customer V3 Title Create/Update Passthrough Customer

Description Create new passthrough customer for customer profile V3.0 and need to configure to update if newUnitholderIdReferenceNo and effectiveDate already exists

URL /api/passthrough/customers/v3 Method POST URL Params Required:

N/A Optional: N/A

Header Attribute

Example: {






Remark





Success Response

Example:


Possible Response


Remark




Page 46 of 50

Download File Title Download File

Description Download file by fileType and businessDate URL /api/files/:businessDate/:fileType.zip Method GET URL Params Required:

Example: /api/files/20170218/FundMapping.zip Optional: N/A

Possible URL Params


Remark

fileType Y Char 50 Possible Value 1. Fund Data* “FundMapping” “FundProfile” “FundHoliday” “SwitchingMatrix” “TradeCalendar” “FundPerformance” 2. Confirmation** “Nav” “AllottedTransactions” “UnitholderBalance” “LTFBalance” 3. Dividend** “DividendNews” “DividendTransaction” 4. Others - “SuspendUnitholder”* - “AssignUnitholderId”* 5. Master Data - “PostalCode”* - “BankBranch”* - “AMCCode”* - “SACode”* *use Trading Day **use Trading Day-1

businessDate Y Char 10 Format YYYYMMDD

Header Attribute

Example: {


Data Params N/A Success Response

Example:

Status: 200 Response Header

Content-Type: application/zip Content-Disposition: attachment; filename=":fileType.zip" Response Body

Page 47 of 50

[File content]

Error Response

Example:

Status: 401 Unauthorized { "errMsg": { "code": "E000", "message": "Unauthorized access" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E500", "message": "Requested file is not found" } }

Possible Response


Remark



Note

Page 48 of 50

Upload File Title Upload File

Description Uploadload file by fileType URL /api/sa/upload/passthrough/:fileType

Method POST URL Params Required:

Example: /api/sa/upload/passthrough/orderTransaction Optional: N/A

Possible URL Params


Remark

fileType Y Char 50 Possible Value “orderTransaction”

Header Attribute Example: {

"X-Auth-Token": "01KEOKD0387dKEPGKJEEDFKLJ", "Content-Type": "multipart/form-data" } Note: The uploaded file must be zipped

Data Params N/A Success Response

Example:

Status: 200

Error Response Example: Status: 401 Unauthorized { "errMsg": { "code": "E000", "message": "Unauthorized access" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E500", "message": "Upload failed : error message depends on failed case " } }

Possible Response


Remark



Page 49 of 50

Upload Attachment Title Upload Attachment

Description Upload attachment file for AMC on current business date before 3:42 pm URL /api/passthrough/uploadAttachment Method POST Header Attribute

Example:

{ "X-Auth-Token": "01KEOKD0387dKEPGKJEEDFKLJ", "Content-Type": "multipart/form-data" }

Data Params n/a Possible

Data Params


Remark

file Y File 10 MB

PDF, JPG or PNG file

amcCode Y Char 15 fileType Y Char 50 Possible Value

- ApplicationForm - Suitability - Others - IdCard - Fatca - BankAccount - Amendment - ByAccountApplicationForm - ForAccountApplicationForm - JointAccountApplicationForm

unitholderId Y Char 15 There are two possible value for this

field

Open New Unitholder ID use : newUnitholderIdRef which is reference customer from SA system.

Update existing unitholder ID use : AMC’s Unitholder ID

Success Response

Example:

Status: 200 Response Body

OK

Error Response

Example:

Status: 401 Unauthorized { "errMsg": { "code": "E000", "message": "Unauthorized access" } } Status: 422 Unprocessable Entry { "errMsg": { "code": "E263", "message": "Invalid file type or size" } }

Page 50 of 50

Possible Response


Remark

errMsg [Fail Case] Code Char 4 [Fail Case] Error code message Char 100 [Fail Case] Error message for Error


Note

Date post:	08-Oct-2020
Category:	Documents
Upload:	others
View:	6 times
Download:	1 times

FundConnext€¦ · 1.3 Subscription - newUnitholderIdRef max length to 20 Change characters...

Documents