System
System-level endpoints used by trading and operator roles.
Get a deposit ticket by OMS ID, account, request code, and ticket ID
Authorizations
Body
OMSIdintegerRequired
AccountIdintegerRequired
RequestCodestringRequired
TicketIdintegerRequired
Responses
200
A deposit ticket object
application/json
400
Invalid input parameters
401
Unauthorized access
404
Deposit ticket not found
post
POST /ap/GetDepositTicket HTTP/1.1
Host: apstage.proxy.kiiex.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"OMSId": 1,
"AccountId": 1,
"RequestCode": "text",
"TicketId": 1
}
{
"assetManagerId": 1,
"accountId": 1,
"assetId": 1,
"assetName": "text",
"amount": 1,
"omsId": 1,
"requestCode": "text",
"requestIP": "text",
"requestUser": 1,
"requestUserName": "text",
"operatorId": 1,
"Status": 1,
"feeAmt": 1,
"updatedByUser": 1,
"updatedByUserName": "text",
"ticketNumber": 1,
"depositInfo": {},
"createdTimestamp": "2025-07-09T15:23:19.691Z",
"lastUpdateTimeStamp": "2025-07-09T15:23:19.691Z",
"comments": {},
"attachments": {}
}
Get all deposit tickets for a given OMS, operator, and account
Authorizations
Body
OMSIdintegerRequired
OperatorIdintegerRequired
AccountIdintegerRequired
Responses
200
List of deposit tickets
application/json
400
Invalid input parameters
401
Unauthorized access
404
No deposit tickets found for given criteria
post
POST /ap/GetDepositTickets HTTP/1.1
Host: apstage.proxy.kiiex.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"OMSId": 1,
"OperatorId": 1,
"AccountId": 1
}
[
{
"assetManagerId": 1,
"accountId": 1,
"assetId": 1,
"assetName": "text",
"amount": 1,
"omsId": 1,
"requestCode": "text",
"requestIP": "text",
"requestUser": 1,
"requestUserName": "text",
"operatorId": 1,
"Status": 1,
"feeAmt": 1,
"updatedByUser": 1,
"updatedByUserName": "text",
"ticketNumber": 1,
"depositInfo": {},
"createdTimestamp": "2025-07-09T15:23:19.691Z",
"lastUpdateTimeStamp": "2025-07-09T15:23:19.691Z",
"comments": {},
"attachments": {}
}
]
Retrieve a withdraw ticket based on OMS ID, account, request code, and ticket ID
Authorizations
Body
OMSIdintegerRequired
AccountIdintegerRequired
RequestCodestringRequired
TicketIdintegerRequired
Responses
200
A withdraw ticket object
application/json
400
Invalid input parameters
401
Unauthorized access
404
Withdraw ticket not found
post
POST /ap/GetWithdrawTicket HTTP/1.1
Host: apstage.proxy.kiiex.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"OMSId": 1,
"AccountId": 1,
"RequestCode": "text",
"TicketId": 1
}
{
"assetManagerId": 1,
"accountId": 1,
"assetId": 1,
"assetName": "text",
"amount": 1,
"templateForm": "text",
"templateFormType": "text",
"omsId": 1,
"requestCode": "text",
"requestIP": "text",
"requestUserId": 1,
"requestUserName": "text",
"operatorId": 1,
"Status": 1,
"feeAmt": 1,
"updatedByUser": 1,
"updatedByUserName": "text",
"ticketNumber": 1,
"createdTimestamp": "2025-07-09T15:23:19.691Z",
"lastUpdateTimestamp": "2025-07-09T15:23:19.691Z",
"Comments": [
{
"commentId": 1,
"enteredBy": 1,
"enteredDateTime": "2025-07-09T15:23:19.691Z",
"comment": "text",
"operatorId": 1,
"omsId": 1,
"ticketCode": "text",
"ticketId": 1
}
],
"Attachments": [
{
"attachmentId": 1,
"submittedByUserId": 1,
"submittedByUserName": "text",
"uploadDate": "2025-07-09T15:23:19.691Z",
"uploadIP": "text",
"ticketNumber": 1
}
],
"AuditLog": [
{}
]
}
Creates a deposit ticket used to fund an account.
Authorizations
Body
assetManagerIdintegerOptional
accountIdintegerOptional
assetIdintegerOptional
assetNamestring | nullableOptional
amountnumberOptional
omsIdintegerOptional
requestCodestring | nullableOptional
requestIPstring | nullableOptional
requestUserintegerOptional
requestUserNamestring | nullableOptional
operatorIdintegerOptional
StatusintegerOptional
feeAmtnumberOptional
updatedByUserintegerOptional
updatedByUserNamestring | nullableOptional
ticketNumberintegerOptional
depositInfoobject | nullableOptional
createdTimestampstring · date-timeOptional
lastUpdateTimeStampstring · date-timeOptional
commentsobject | nullableOptional
attachmentsobject | nullableOptional
Responses
200
Result of the creation
application/json
400
Invalid deposit ticket data
401
Unauthorized request
post
POST /ap/CreateDepositTicket HTTP/1.1
Host: apstage.proxy.kiiex.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 409
{
"assetManagerId": 1,
"accountId": 1,
"assetId": 1,
"assetName": "text",
"amount": 1,
"omsId": 1,
"requestCode": "text",
"requestIP": "text",
"requestUser": 1,
"requestUserName": "text",
"operatorId": 1,
"Status": 1,
"feeAmt": 1,
"updatedByUser": 1,
"updatedByUserName": "text",
"ticketNumber": 1,
"depositInfo": {},
"createdTimestamp": "2025-07-09T15:23:19.691Z",
"lastUpdateTimeStamp": "2025-07-09T15:23:19.691Z",
"comments": {},
"attachments": {}
}
{
"success": true,
"requestcode": "text"
}
Returns a single withdraw ticket from OMS, trading venue operator, and account that matches the current Verify Code for confirmation.
Authorizations
Body
OMSIdintegerRequired
VerifyCodestringRequired
Responses
200
A withdraw ticket object
application/json
400
Bad request
post
POST /ap/GetWithdrawTicketByVerifyCode HTTP/1.1
Host: apstage.proxy.kiiex.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"OMSId": 1,
"VerifyCode": "text"
}
{
"assetManagerId": 1,
"accountId": 1,
"assetId": 1,
"assetName": "text",
"amount": 1,
"templateForm": "text",
"templateFormType": "text",
"omsId": 1,
"requestCode": "text",
"requestIP": "text",
"requestUserId": 1,
"requestUserName": "text",
"operatorId": 1,
"Status": 1,
"feeAmt": 1,
"updatedByUser": 1,
"updatedByUserName": "text",
"ticketNumber": 1,
"createdTimestamp": "2025-07-09T15:23:19.691Z",
"lastUpdateTimestamp": "2025-07-09T15:23:19.691Z",
"Comments": [
{
"commentId": 1,
"enteredBy": 1,
"enteredDateTime": "2025-07-09T15:23:19.691Z",
"comment": "text",
"operatorId": 1,
"omsId": 1,
"ticketCode": "text",
"ticketId": 1
}
],
"Attachments": [
{
"attachmentId": 1,
"submittedByUserId": 1,
"submittedByUserName": "text",
"uploadDate": "2025-07-09T15:23:19.691Z",
"uploadIP": "text",
"ticketNumber": 1
}
],
"AuditLog": [
{}
]
}
Was this helpful?