Online Stock Trading Backup

Accounts

Online Stock Trading Backup

Invest online and have faster, reliable and secure real time trading experience with third party partners. Simplified order placement, modification and deletion process. Supported features of online stock trading include Stock purchase, Stock modification and Stock deletion.

Hong Kong

Trade in stock market

A quick and hassle-free method for the clients to trade and monitor shares online on the basis of current market trends.

Experience a seamless process of order placement, tracking and modification.

 

Zoom In

Secure identification

Clients can securely log in to Citi using below options

  • Citi Credentials (user name, password)
  • Biometric methods for user recognition like face id, touch id etc.
Zoom In

Client authentication using biometrics

Clients are authenticated using various biometrics methods like face recognition, touch id etc.
Zoom In

Validate the OTP generated from Citi Mobile token

Clients can validate the OTP generated from their Citi Mobile token. Alternatively, they also have the option to receive an OTP on their registered mobile number by clicking on the link 'Send OTP via SMS' at the bottom of the screen.
Zoom In

Authentication Successful

After successful two-factor authentication, clients to provide their consent to authorize Citibank to share their data with trusted third-party providers. After providing consent, customers will get a confirmation message and are redirected to partner's app to begin trading with Citibank. Refer to the API Callout 1 for information about retrieving an access token and API Callout 2 for retrieving client's Brokerage and Settlement Accounts details.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve Access Token

The third party calls Citi with the Auth code. Citi then checks to make sure the Auth code is still valid and has not expired. Citi also checks to make sure the Client ID and Secret are valid. Upon successful validation, Citi generates a customer-specific token and returns it to Partner.

Endpoint

Hong Kong: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Parameters

PATH

countryCode

businessCode

Query

NA

FormData

grant_type

code

redirect_uri

View Api Callout 2 >
×

Use Case Callout

Retrieve Brokerage and Settlement Accounts

This API returns the list of all brokerage accounts and the corresponding settlement accounts held by the customer for each stock market.

Endpoint

Hong Kong: GET /v1/investments/products/brokerage/equity/cashAccounts

Paramters

PATH

NA

Query

nextStartIndex

stockMarket

Clients to input order details

Clients can input order details like order type, price etc. in the Order Input screen. Purchasing power, holding quantity and average cost of the stock are also displayed.

The drop down values are reference data fields. Example: Order type is a reference data field which returns different values associated with it.

Refer to the API callout1 to get possible values of the reference fields with their description.

Please note: API callout1 is used to get the reference data field values and used in the subsequent steps of the journey as well.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve valid values

Returns an array of valid values and descriptions for the specified field.

Endpoint

Hong Kong: GET /v1/apac/utilities/referenceData/{referenceCode}

Parameters

PATH

referenceCode

Clients continue to provide their order details

Clients provide their order details like quantity, date etc. and click on 'Continue' to proceed further.

Refer to the API callout1 for information on retrieving brokerage holdings and API Callout2 to verify the order details of the client.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Brokerage Holdings Inquiry

Returns the holding details such as quantity and average cost of a particular stock held by the customer.

Endpoint

Hong Kong: GET /v1/investments/products/brokerage/equity/holdings/miniDetails

Parameters

PATH

NA

Query

accountId

stockCode

stockCurrencyCode

stockMarket

nextStartIndex

 

View Api Callout 2 >
×

Use Case Callout

Preprocess Brokerage Order

This API creates a new brokerage order and verifies that there are no errors. The response from this resource should be used to construct a pre-confirmation page to help the customer review the transaction before confirming the order.

Endpoint

Hong Kong: POST /v1/investments/products/brokerage/{accountId}/equity/orders/preprocess

Parameters

PATH

accountId

Clients confirm their order details

After submitting the order details, the clients need to verify their order details on the Pre-confirmation screen. They also need to verify the transaction fee displayed on the screen. Clients confirm their order details after agreeing to the terms and conditions.

Refer to the below API callout to confirm the order details.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Confirm Brokerage Order

This API is called after the successful order creation and confirms the brokerage order placed by the customer. Post order confirmation, a confirmation number is returned to the customer.

Endpoint

Hong Kong: POST /v1/investments/products/brokerage/equity/orders

Parameters

PATH

NA

Order Confirmation

The clients get an order confirmation message along with a reference number to track the status of their order.
Zoom In

Clients check trade status and modify the orders

Clients can view trade status and also modify the orders.

Please note: These functions are accessible after successful authentication as illustrated above in the journey.

Refer to the below API callout to retrieve brokerage order details.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve Brokerage Orders

This API returns the list of all the brokerage orders placed by a customer.

Endpoint

Hong Kong: GET /v1/investments/products/brokerage/{accountId}/equity/orders

Parameters

PATH

accountId

Query

stockMarket

orderReferenceNumber

securitiesBrokerageOrderStatus

orderFromDate

orderToDate

stockCode

securityBrokerageTradeType

nextStartIndex

Clients view all the orders

The clients can view all the orders placed with Citi. They can either modify or delete any order placed by them.
Zoom In

Modify the order

Clients can modify the price and quantity of the order placed by them. Refer to the below API callout for order modification.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Modify Brokerage Order

This API modifies an existing brokerage order and verifies that there are no errors. The response from this resource should be used to construct a pre-confirmation page to help the customer review the transaction before confirming the order.

Endpoint

Hong Kong: PUT /v1/investments/products/brokerage/{accountId}/equity/orders/preprocess

Parameters

PATH

accountId

Verify the modified order

Modified order details are displayed on the order Pre-confirmation screen. Clients can verify these details and click on 'Confirm' to proceed with the order modification.

Refer to the below API callout for the confirmation of brokerage order modification.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Confirm Brokerage Order Modification

This API confirms the brokerage order modification. It is called after successfully modifying the order. Post order modification, an acknowledgement is sent to the customer.

Endpoint

Hong Kong: PUT /v1/investments/products/brokerage/equity/orders

Parameters

PATH

NA

Confirmation post order modification

The clients receive a confirmation message once the order is modified and resubmitted to the market successfully. They can also view the order status by clicking on the link 'View Trade Status'.
Zoom In

Delete the unprocessed order

Clients can also cancel or delete the order placed by them. An order can be deleted only till the time it is in unprocessed state.
Zoom In

Confirm the order before deletion

Clients can verify the details of their trade before proceeding for the actual deletion.
Zoom In

Order deletion

The clients receive a confirmation message once their order is deleted or cancelled. They can also view the order status by clicking on the link 'View Trade Status'.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Delete Brokerage Order

This API deletes an existing brokerage order. Post successful order deletion, an acknowledgement is sent to the customer.

Endpoint

Hong Kong: DELETE /v1/investments/products/brokerage/{accountId}/equity/orders

Parameters

PATH 

accountId

Query

orderReferenceNumber