API Reference

Get Fiat History

📘

How to fill remark field

If the remark field is required to be included in the API response for the deposit order, it should be filled in according to the following rules when initiating the transfer. SCB intra-bank transfers are not supported for now.

  1. Enterprise Bank Account Mode (For example, Chong Hing Bank), add REF:
    /REF:####
  2. Automatic transfer to trading account:
    /CMD:autoTF_{trading_accountId}_{customer_custom_field}
  3. Transaction remark:
    /MEMO:{customer_custom_field}

Chong Hing Bank sample:
/REF:H2A6U8/CMD:autoTF_1471090223379184384_customId1/MEMO:customId2

ZA/SCB sample:
/REF:/CMD:autoTF_1471090223379184384_customId1/MEMO:customId2

No Auto transfer, just remark:
/REF:/CMD:/MEMO:customId


Weight: 5

Request Parameters

PARAMETER

TYPE

Req'd

DESCRIPTION

type

STRING

Y

"deposit", "withdraw"

status

STRING

deposit:
"under_review" "processing" "successful" "failed"
withdraw:
"under_review" "processing" "successful" "failed"

startTime

LONG

Y

Start timestamp

endTime

LONG

Y

End timestamp

channel

STRING

"auto", "manual"; default "auto" For transaction records prior to (9/1/2023 please use manual channel)

remark

STRING

Remark

limit

INTEGER

Limit

recvWindow

LONG

Recv Window

timestamp

LONG

Y

Timestamp

clientOrderId

STRING

Can be used for filtering

Response content

PARAMETER

TYPE

DESCRIPTION

orderId

STRING

Fiat Order ID, e.g: "FD467701147384938496"

type

STRING

"deposit", "withdraw"

remark

STRING

Deposit: The remark message from bank deposit

asset

STRING

"USD" or "HKD". Fee Asset is the same as the Transaction Asset.

grossAmount

STRING

Deposit/Withdraw order amount

netAmount

STRING

Actual fund in amount Deposit: grossAmount - fee Withdraw: grossAmount + fee

fee

STRING

Deposit / Withdraw fee

status

STRING

deposit:
"under_review" "processing" "failed" "successful" "withdraw_return"
withdraw:
"under_review" "processing" "failed" "successful" "return"

createdTime

LONG

Order Created Timestamp

updatedTime

LONG

Order Updated Timestamp

channel

STRING

clientOrderId

STRING

Client order ID

Language
Credentials
Header
Click Try It! to start a request and see the response here!