Fuze Docs (0.0.7)

Download OpenAPI specification:Download

E-mail: engineering@fuze.finance License: Apache 2.0 Terms of Service

Docs for Fuze

Getting Started With Fuze

user

Update Acl for a user

Update acl for a user. (Requires READWRITE permission for ACL and user)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId

string

object

MANAGE_USERS

string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "barbara_allen",
"modules": {"MANAGE_USERS": "NONE"
}
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "OK"
}

Edits tnc for a already present User

Edits tnc for a already present user by providing orgUserId. (Requires READWRITE permissions for Base)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId required	string Org user id
tnc	boolean User acceptance of TnC
modules	object Permissions enabled for the user
loginAllowedFrom	string or null Allowed login from
loginAllowedTo	string or null Allowed login to
kycData	object or null KYC data

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "johndoe123",
"tnc": true,
"modules": { },
"loginAllowedFrom": "14:00:00",
"loginAllowedTo": "23:00:00",
"kycData": { }
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "OK"
}

Create a new User

Create a new User by providing orgUserId. (Requires READWRITE permissions for User)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

One of

orgUserId required	string Org user id
userType required	string Value: "CONSUMER" Type of User
kyc required	boolean KYC details of the User passed to API
tnc required	boolean User acceptance of TnC
kycData	object or null KYC data

Responses

Request samples

Payload

Content type

application/json

Example

CreateConsumerUserRequestBody

{"orgUserId": "johndoe123",
"userType": "CONSUMER",
"kyc": true,
"tnc": true,
"kycData": { }
}

Response samples

200
400
403
500

Content type

application/json

Example

Code-200_1

{"code": 200,
"error": null,
"data": {"orgUserId": "michael_scott",
"orgId": 12,
"tnc": true,
"kyc": true,
"firstName": "Michael",
"lastName": "Scott",
"userType": "EMPLOYEE",
"userStatus": "ACTIVE",
"modules": {"MANAGE_USERS": "NONE"
}
}
}

Get User by orgUserId

Get User by orgUserId provided at creation time. (Requires READ permission on user)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId

required

string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "barabara_allen"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"orgUserId": "barbara.allen",
"orgId": 12,
"tnc": true,
"kyc": true,
"firstName": "Barbara",
"lastName": "Allen",
"userType": "CONSUMER",
"aclStr": "",
"userStatus": "ACTIVE"
}
}

Freeze User

Freeze a user by passing orgUserId. Once done, further operations on the user will be rejected. (Requires READWRITE permission on User)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId

required

string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "barabara_allen"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"orgUserId": "barbara.allen",
"orgId": 12,
"deleted": true
}
}

Fetch balances of a user

Fetch a summary of balances for a user. (Requires READ permission for User)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId

required

string

Org user id

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "johndoe123"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"currency": "BTC",
"value": 10
},
{"currency": "ETH",
"value": 0.1
}
]
}

Fetch notifications for a user

Fetch a list of notifications for a user. (Requires READ permission for User)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

pageNumber	integer <int32>
pageSize	integer <int32>
fromDate	string <date>
toDate	string <date>

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 1,
"fromDate": "2023-03-02",
"toDate": "2023-03-02"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"message": "Trade Executed",
"createdAt": "2021-06-01T00:00:00Z"
},
{"message": "Trade Executed",
"createdAt": "2021-06-01T00:00:00Z"
}
]
}

Unfreeze Account

Unfreeze an account by passing orgUserId. (Requires READWRITE permission on User)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId

required

string

Org user id

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "johndoe123"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"orgUserId": "barbara.allen",
"orgId": 12
}
}

Fetch all users for your org

Fetch all users for your org. (Requires READ permissions for Org.)

Authorizations:

ApiKeyAuth

query Parameters

pageNumber	integer offset of the page. Default is 0.
pageSize	integer number of records to fetch in a page. Default is 50.
userType	string Type os user (example : consumer, employee).
search	string search on the basis of name/email.
status	string status of the user (inactive, active)
sort	string sorting the response with direction (example: status:ASC, name:DESC). If no direction is mentioned, ASC will be considered by default

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": [{"orgUserId": "barbara_allen",
"firstName": "Barbara",
"lastName": "Allen",
"kyc": true,
"tnc": true,
"userStatus": "ACTIVE",
"userType": "CONSUMER",
"createdAt": 1676446107,
"permissions": {"MANAGE_USERS": "READWRITE",
"RISK_CONTROL": "READWRITE",
"REPORTS_AND_SETTLEMENT": "READWRITE",
"CONSUMER_ACCOUNTS": "READWRITE",
"PROOF_OF_RESERVES": "READWRITE",
"AUDIT_LOGS": "READWRITE",
"APIS": "READWRITE",
"BUSINESS_MONITORING": "READWRITE",
"FUND_MANAGEMENT": "READWRITE",
"KNOW_YOUR_TRANSACTION": "READWRITE"
}
}
],
"error": null
}

Edits a already present User

Edits a already present user by providing orgUserId. (Requires READWRITE permissions for User)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId required	string Org user id
tnc	boolean User acceptance of TnC
modules	object Permissions enabled for the user
loginAllowedFrom	string or null Allowed login from
loginAllowedTo	string or null Allowed login to
kycData	object or null KYC data

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "johndoe123",
"tnc": true,
"modules": { },
"loginAllowedFrom": "14:00:00",
"loginAllowedTo": "23:00:00",
"kycData": { }
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "OK"
}

Delete a user

Delete a user by providing orgUserId. (Requires READWRITE permissions for User)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId

required

string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "barabara_allen"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"orgUserId": "barbara.allen",
"orgId": 12,
"deleted": true
}
}

apikms

Generate API key pair

Requires READWRITE permission for APIKMS

Authorizations:

UserAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

access required	integer 4 - READWRITE, 2 - WRITE, 1 - READ
expirySeconds required	integer
ipWhitelist	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"access": 3,
"expirySeconds": 999999999999,
"ipWhitelist": ["string"
]
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"apiKey": "MCowDuMmyApiKey",
"apiSecret": "MC4CDuMmyApiSecret",
"expiryEpochSeconds": 999999999999,
"ipWhitelist": ["1.1.1.1",
"2.2.2.2"
],
"access": "1"
},
"error": null
}

Fetch API key pair

Requires READWRITE permission for APIKMS

Authorizations:

UserAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

apiKey

required

string

Responses

Request samples

Payload

Content type

application/json

{"apiKey": "MCowDuMmyApiKey"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": [{"apiKey": "MCowDuMmyApiKey",
"apiSecret": "MC4CDuMmyApiSecret",
"expiryEpochSeconds": 999999999999,
"ipWhitelist": ["1.1.1.1",
"2.2.2.2"
],
"access": "1"
}
],
"error": null
}

Delete API key pair

Requires READWRITE permission for APIKMS

Authorizations:

UserAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

apiKey

required

string

Responses

Request samples

Payload

Content type

application/json

{"apiKey": "MCowDuMmyApiKey"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": "OK",
"error": null
}

Rotate API key pair

Requires READWRITE permission for APIKMS

Authorizations:

UserAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

apiKey

required

string

Responses

Request samples

Payload

Content type

application/json

{"apiKey": "MCowDuMmyApiKey"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"apiKey": "MCowDuMmyApiKey",
"apiSecret": "MC4CDuMmyApiSecret",
"expiryEpochSeconds": 999999999999,
"ipWhitelist": ["1.1.1.1",
"2.2.2.2"
],
"access": "1"
},
"error": null
}

asset

Fetch symbols of your org

Fetch supported assets with which you can make trades. Requires READ permissions for Org.

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"symbol": "BTC_AED",
"policies": {"NAME": "BTC_AED",
"QUANTITY_PRECISION": 8,
"PRICE_PRECISION": 6,
"ASSET_ENABLE": false
}
},
"error": null
}

Fetch assets for your org

Get asset metadata that you can use in your app. Requires READ permissions for Org.

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"asset": "BTC",
"chainsAndNetworks": [{"chain": "ETHEREUM",
"network": "MAINNET"
},
{"chain": "BITCOIN",
"network": "MAINNET"
}
],
"policies": {"NAME": "BTC",
"ICON": "https://fuze.finance/symbol/btc.jpg",
"ASSET_ENABLE": false,
"LOCAL_CURRENCY": "AED",
"MARKET_CAP": 100000,
"CURRENT_PRICE": 1000,
"HIGH_24HR": 1000,
"LOW_24HR": 1000,
"PRICE_CHANGE_PERCENT_24H": 10.1
}
},
"error": null
}

audit

Get audit details for your org.

Get an audit trail of events(user creation, policy changes etc.) tied to your orgId. Requires READ permissions for Audit.

Authorizations:

ApiKeyAuth

query Parameters

entityType	string entity to fetch the audit details for. Example: Orders
pageNumber	integer offset of the page. Default is 0.
pageSize	integer number of records to fetch in a page. Default is 50.
search	string search on the basis of name/email.
fromDate	string used for date range. should be in YYYY-MM-DD
toDate	string used for date range. should be in YYYY-MM-DD

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"createdBy": "michael_scott",
"eventType": "CREATE",
"entityType": "Orders",
"metadata": "{\"key1\": \"value1\"}",
"createdAt": 1676444477
},
"error": null
}

bank

Create an entry in the thirdParty table

Create an entry in the thirdParty table. (Requires READWRITE permission for Bank)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId	string
name	string
type	string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "test@test.com",
"name": "TESTNAME",
"type": "SELF"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "SUCCESS"
}

deletes an entry in the third party table

deletes an entry in the third party table. (Requires READWRITE permission for bank)

Authorizations:

ApiKeyAuth

path Parameters

thirdPartyUuid

required

string

thirdPartyUuid which needs to be deleted

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "SUCCESS"
}

fetch all the third parties for the org

fetch all the third parties for the org. (Requires READWRITE permission for bank)

Authorizations:

ApiKeyAuth

query Parameters

status	string status of each invoice. Example: PAID
pageNumber	integer offset of the page. Default is 0.
pageSize	integer number of records to fetch in a page. Default is 50.
fromDate	string used for date range. should be in YYYY-MM-DD
toDate	string used for date range. should be in YYYY-MM-DD

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"name": "TESTNAME",
"accountNumber": "12312312",
"bankSwiftCode": "ABCDXXXXXX",
"iban": "AE1231412ADA",
"bankCode": "002",
"currency": "AED",
"paymentMethod": "SWIFT"
}
]
}

Create an fiat account for the third party

Create an fiat account for the third party. (Requires READWRITE permission for Bank)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

thirdPartyUuid	string
accountNumner	string
bankSwiftCode	string
iban	string
bankCode	string
currency	string
paymentMethod	string

Responses

Request samples

Payload

Content type

application/json

{"thirdPartyUuid": "aasdasd-asdasd-asdads",
"accountNumner": "123123",
"bankSwiftCode": "ABCDXXXXXX",
"iban": "AE12314ADA312312",
"bankCode": "002",
"currency": "AED",
"paymentMethod": "SWIFT"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "SUCCESS"
}

deletes an entry in the third party account table

deletes an entry in the third party account table. (Requires READWRITE permission for bank)

Authorizations:

ApiKeyAuth

path Parameters

clientIdentifier

required

string

third party account clientIdentifier which needs to be deleted

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "SUCCESS"
}

Create a crypto wallet entry for the third-party

Create a crypto wallet entry for the third-party. (Requires READWRITE permission for Bank)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

thirdPartyUuid	string
asset	string
address	string
chain	string
network	string

Responses

Request samples

Payload

Content type

application/json

{"thirdPartyUuid": "aasdasd-asdasd-asdads",
"asset": "ETH",
"address": "ASDASD123123ASDAS",
"chain": "ETH",
"network": "ETHEREUM"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "SUCCESS"
}

deletes an entry in the third party wallet table

deletes an entry in the third party wallet table. (Requires READWRITE permission for bank)

Authorizations:

ApiKeyAuth

path Parameters

thirdPartyWalletUuid

required

string

third party wallet uuid which needs to be deleted

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "SUCCESS"
}

Create a crypto wallet entry for the third-party

Create a crypto wallet entry for the third-party. (Requires READWRITE permission for Bank)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

thirdPartyUuid	string
asset	string
address	string
chain	string
network	string

Responses

Request samples

Payload

Content type

application/json

{"thirdPartyUuid": "aasdasd-asdasd-asdads",
"asset": "ETH",
"address": "ASDASD123123ASDAS",
"chain": "ETH",
"network": "ETHEREUM"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"notabeneExternalCounterpartyVaspDid": "did:ethr:0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
"nickname": "nickname",
"address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E.",
"asset": "ETH",
"chain": "ETHEREUM",
"walletType": "CUSTODIAL",
"provider": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
"status": "APPROVED"
}
}

kyc

Get verified kyc data for an individual

Authorizations:

UserAuth

Responses

Response samples

200
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"legalName": "sample name"
}
}

Get upload link to upload individual kyc file

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId	string
fileName	string
docCategory	string (DocCategory) Enum: "IDENTITY_FRONT" "IDENTITY_BACK" "ADDRESS" "EDD" "LIVELINESS" "W9" "FATCA" "OTHER"
docSubCategory	string or null
docDescription	string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "jim@dundermifflin.com",
"fileName": "JimHalpertPassport.pdf",
"docCategory": "IDENTITY_FRONT",
"docSubCategory": "Passport",
"docDescription": "This is the passport of Jim Halpert."
}

Response samples

200
400
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"url": "https://aws-bucket.s3.me-central-1.amazonaws.com/pre-signed-url",
"expiryTime": 1722432264.949
}
}

Get upload status of kyc files

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId

string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "barabara_allen"
}

Response samples

200
400
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"absentFiles": ["IDENTITY_BACK",
"IDENTITY_FRONT",
"ADDRESS"
]
}
}

Get edd tracker entries for an org

Authorizations:

UserAuth

Request Body schema: application/json

pageNumber	integer <int32>
pageSize	integer <int32>
fromDate	string
toDate	string
status	string (EddStatus) Enum: "PENDING" "COMPLETED"

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 2,
"fromDate": "2024-03-03",
"toDate": "2024-03-04",
"status": "PENDING"
}

Response samples

200
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"orgId": 10,
"orgUserId": "barbara_allen_1",
"uuid": "4acc9473-e0cd-4106-b388-1d3e44dd86bf",
"status": "PENDING",
"createdAt": "2023-08-28T16:09:47.537Z",
"updatedAt": "2023-08-28T16:09:47.537Z"
}
]
}

Update edd tracker entry

Authorizations:

UserAuth

Request Body schema: application/json

uuid	string
orgUserId	string
status required	string

Responses

Request samples

Payload

Content type

application/json

{"uuid": "4acc9473-e0cd-4106-b388-1d3e44dd86cf",
"orgUserId": "barbara_allen",
"status": "COMPLETED"
}

Response samples

200
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": "OK"
}

Fetch kyc files for an org and user

Authorizations:

UserAuth

Request Body schema: application/json

orgUserId

string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "FUZE01234"
}

Response samples

200
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"uuid": "f1a74abc-9d39-45fd-ab7c-cf816cba2e02",
"filePath": "orgId-10/orgUserId-barbara_allen_1/docCategory-EDD/1721916149845-barbara_allen_1_edd_1.pdf",
"docCategory": "EDD",
"docSubCategory": "doc-sub-category",
"docDescription": "doc-description",
"uploadStatus": "UPLOADED"
}
]
}

Update kyc file for an org and user

Authorizations:

UserAuth

Request Body schema: application/json

orgUserId	string
uuid	string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "FUZE01234",
"uuid": "f1a74abc-9d39-45fd-ab7c-cf816cba2e02"
}

Response samples

200
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": "OK"
}

Delete a kyc file for an org and user

Authorizations:

UserAuth

Request Body schema: application/json

orgUserId	string
uuid	string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "FUZE01234",
"uuid": "f1a74abc-9d39-45fd-ab7c-cf816cba2e02"
}

Response samples

200
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": "OK"
}

Generate download link for a kyc file

Authorizations:

UserAuth

Request Body schema: application/json

orgUserId	string
uuid	string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "FUZE01234",
"uuid": "f1a74abc-9d39-45fd-ab7c-cf816cba2e02"
}

Response samples

200
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"url": "https://fuze.finance/path/to/file.pdf",
"expiryTime": 1721922798.244
}
}

custody

estimates the fee for a new transaction

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

asset	string
chain	string

Responses

Request samples

Payload

Content type

application/json

{"asset": "ETH",
"chain": "ETHEREUM"
}

Response samples

200
400
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"low": {"networkFee": "0.000000000000000001"
},
"medium": {"networkFee": "0.000000000000000001"
},
"high": {"networkFee": "0.000000000000000001"
}
}
}

Get supported assets in custody

Get supported assets in custody (Requires READ permission on custody)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"supportedAssets": {"ETH": [{"network": "SEPOLIA",
"chain": "ETHEREUM"
}
],
"BTC": [{"network": "TESTNET",
"chain": "BITCOIN"
}
],
"USDC": [{"network": "GOERLI",
"chain": "ETHEREUM",
"contractAddress": "0x07865c6E87B9F70255377e024ace6630C1Eaa37F"
}
]
}
}
}

Get custody details of an org for asset and chain

Get custody details of an org for asset and chain (Requires READ permission on custody)

Authorizations:

ApiKeyAuth

path Parameters

asset required	string asset for which custody of org needs to be fetched
chain required	string chain of the asset for which custody of org needs to be fetched

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"fireblocks": {"vault": {"id": 1,
"name": "orgId 20",
"hiddenOnUI": false,
"autoFuel": false,
"assetsWithAddresses": [{"asset": {"id": 1,
"total": 0,
"balance": 0,
"lockedAmount": 0,
"available": 0,
"pending": 0,
"frozen": 0,
"staked": 0,
"blockHeight": -1
},
"addresses": {"id": 1,
"orgId": 1,
"orgWalletId": 1,
"address": "adsafsdasd",
"asset": "BTC",
"network": "TESTNET",
"chain": "BITCOIN",
"status": "APPROVED"
},
"explorerLink": "https://abcd.etherscan.io/address/0xf4455548aa4B5C76bf40Cc7C5b17B4F8A3f85B8f"
}
]
}
}
}
}

Get custody details of an org for asset

Get custody details of an org for asset (Requires READ permission on custody)

Authorizations:

ApiKeyAuth

path Parameters

asset

required

string

asset for which custody of org needs to be fetched

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"fireblocks": {"vault": {"id": 1,
"name": "orgId 20",
"hiddenOnUI": false,
"autoFuel": false,
"assetsWithAddresses": [{"asset": {"id": 1,
"total": 0,
"balance": 0,
"lockedAmount": 0,
"available": 0,
"pending": 0,
"frozen": 0,
"staked": 0,
"blockHeight": -1
},
"addresses": {"id": 1,
"orgId": 1,
"orgWalletId": 1,
"address": "adsafsdasd",
"asset": "BTC",
"network": "TESTNET",
"chain": "BITCOIN",
"status": "APPROVED"
},
"explorerLink": "https://abcd.etherscan.io/address/0xf4455548aa4B5C76bf40Cc7C5b17B4F8A3f85B8f"
}
]
}
}
}
}

enables asset in custody for user

enables asset in custody for user. (Requires READWRITE permission on custody)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId	string
asset	string
chain	string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "string",
"asset": "ETH",
"chain": "ETHEREUM"
}

Response samples

200
400
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"fireblocks": {"id": 1,
"address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
"legacyAddress": "",
"enterpriseAddress": "",
"tag": "prod",
"eosAccountName": "",
"status": "ENABLED",
"activationTxId": ""
}
}
}

fetches custody transactions for a user

fetches custody transactions for a user. (Requires READ permission on custody)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId	string
asset	string
chain	string
custodyType	string Enum: "SEGREGATED" "OMNIBUS"
status	string
entry	string Enum: "DEPOSIT" "WITHDRAWAL"

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "string",
"asset": "ETH",
"chain": "ETHEREUM",
"custodyType": "SEGREGATED",
"status": ["COMPLETED",
"FAILED",
"REJECTED",
"QUEUED"
],
"entry": "DEPOSIT"
}

Response samples

200
400
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"txns": [{"id": 1,
"txHash": "e556ab72-da2e-4a10-9524-9f39c132b4b7",
"status": "COMPLETED",
"amount": 1,
"currency": "ETH",
"chain": "ETHEREUM",
"entry": "DEPOSIT"
}
]
}
}

fetches a custody transaction for a user by transactionId

fetches a custody transaction for a user. (Requires READ permission on custody)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId	string
transactionId	number

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "barbara_allen",
"transactionId": 11
}

Response samples

200
400
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"id": 1,
"txHash": "e556ab72-da2e-4a10-9524-9f39c132b4b7",
"sourceAddress": "0xeth",
"destinationAddress": "0xeth",
"status": "COMPLETED",
"amount": 1,
"currency": "ETH",
"chain": "ETHEREUM",
"entry": "DEPOSIT"
}
}

fetches whitelisted external addresses for a user

fetches whitelisted external addresses for a user. (Requires READWRITE permission on custody)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId	string
asset	string
chain	string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "string",
"asset": "ETH",
"chain": "ETHEREUM"
}

Response samples

200
400
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"fireblocks": {"id": 1,
"orgId": 1,
"orgWalletId": 1,
"address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
"asset": "ETH",
"network": "TESTNET",
"chain": "ETHEREUM",
"status": "APPROVED"
}
}
}

create a whitelisted external wallet

create a whitelisted external wallet. (Requires READWRITE permission on custody)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId	string or null
notabeneExternalCounterpartyVaspDid	string or null
nickname	string
address	string
memo	string or null
asset	string
chain	string
walletType	string
provider	string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "orgUserId",
"notabeneExternalCounterpartyVaspDid": "did:ethr:0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
"nickname": "nickname",
"address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E.",
"memo": "12345",
"asset": "ETH",
"chain": "ETHEREUM",
"walletType": "CUSTODIAL",
"provider": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E"
}

Response samples

200
400
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"orgId": 1,
"userId": 1,
"notabeneExternalCounterpartyVaspDid": "did:ethr:0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
"nickname": "nickname",
"address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E.",
"asset": "ETH",
"chain": "ETHEREUM",
"walletType": "CUSTODIAL",
"provider": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
"status": "APPROVED",
"notes": "notes",
"vaspMetadata": "metadata",
"createdAt": "2023-08-28T16:09:47.537Z",
"updatedAt": "2023-08-28T16:09:47.537Z"
}
}

check if the address is valid

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

address	string
chain	string

Responses

Request samples

Payload

Content type

application/json

{"address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
"chain": "ETHEREUM"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"isValid": true,
"address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
"chain": "ETHEREUM"
}
}

delete external wallet

deletes an external wallet of a user by its id

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

id which needs to be deleted

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": "OK"
}

Checks if an external wallet already exists for an org

Create a crypto deposit wallet for the third party. (Requires READWRITE permission for Bank)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

address	string
asset	string
chain	string
memo	string

Responses

Request samples

Payload

Content type

application/json

{"address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
"asset": "ETH",
"chain": "ETHEREUM",
"memo": "fakememo"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "OK"
}

finance

Gets all the accounts for the org

Authorizations:

UserAuth

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"id": 1,
"orgId": 1,
"shortName": "Account1",
"beneficiaryName": "Account1",
"bankName": "ENBD",
"bankCountry": "UAE",
"currency": "AED",
"isVerified": true,
"isEnabled": true,
"isDefault": true,
"accountNumber": "account1",
"transferDetails": "{swift: \"123123\"}"
}
]
}

add a bank account

add a bank account. (Requires READWRITE permission for finance)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

beneficiaryName	string
bankName	string
bankCountry	string
currency	string
accountNumber	string
transferDetails	string

Responses

Request samples

Payload

Content type

application/json

{"beneficiaryName": "Account1",
"bankName": "ENBD",
"bankCountry": "UAE",
"currency": "AED",
"accountNumber": "account1",
"transferDetails": "{swiftcode : \"swiftBank\"}"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"id": 12,
"orgId": 1,
"shortName": "Account1",
"beneficiaryName": "Account1",
"bankName": "ENBD",
"bankCountry": "UAE",
"currency": "AED",
"isVerified": true,
"isEnabled": true,
"isDefault": true,
"accountNumber": "account1",
"transferDetails": "{swift: \"123123\"}"
},
"error": null
}

delete a bank account

delete a bank account. (Requires READWRITE permission for finance)

Authorizations:

ApiKeyAuth

path Parameters

accountId

required

string

accountId of the account that needs to be deleted

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
404
500

Content type

application/json

{"code": 200,
"data": {"numDeleted": 1
},
"error": null
}

initiate a transaction to a fiat bank account.

initiate a transaction to a fiat bank account. (Requires READWRITE permission for finance)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

accountId	integer
txnId	string
amount	integer
transactionType	string (BankTransferType) Enum: "DEPOSIT" "WITHDRAW" "SETTLEMENT"
currency	string
fundingAmount	integer
fundingCurrency	string

Responses

Request samples

Payload

Content type

application/json

{"accountId": 10,
"txnId": "Txn1",
"amount": 1,
"transactionType": "DEPOSIT",
"currency": "AED",
"fundingAmount": 1,
"fundingCurrency": "AED"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": [{"id": 12,
"orgId": 1,
"accountId": "Account1",
"txnId": "Txn1",
"referenceId": "123123",
"amount": 123,
"type": "DEPOSIT",
"status": "PENDING",
"currency": "AED",
"fundingAmount": 123,
"fundingCurrency": "AED"
}
],
"error": null
}

list of all fiat transactions.

list of all fiat transactions. (Requires READ permissions for Finance.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

pageNumber	integer
pageSize	integer
orgUserId	string
type	string (BankTransferType) Enum: "DEPOSIT" "WITHDRAW" "SETTLEMENT"
status	string (BankTransferStatus) Enum: "PENDING" "COMPLETED" "CANCELED" "EXPIRED"
fromDate	string
toDate	string
fuzeReferenceId	string

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 2,
"orgUserId": "barbara_allen",
"type": "DEPOSIT",
"status": "PENDING",
"fromDate": "2024-03-03",
"toDate": "2024-03-04",
"fuzeReferenceId": "12345-1312314-12312312"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": [{"orgId": 1,
"accountId": "Account1",
"txnId": "Txn1",
"referenceId": "123123",
"amount": 123,
"type": "DEPOSIT",
"status": "PENDING",
"currency": "AED",
"createdAt": 1676444477,
"closingBalance": 100
}
],
"error": null
}

Get current balance for the account

Get current balance for the account. (Requires READ permissions for finance.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"availableToTrade": 100,
"availableToWithdraw": 50,
"netBuySellForToday": 0
},
"error": null
}

Get current balance for the account

Get current balance for the account. (Requires READ permissions for finance.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"availableToTrade": 100,
"availableToWithdraw": 50,
"netBuySellForToday": 0
},
"error": null
}

Gets all the fuze maintained accounts for the org

Authorizations:

UserAuth

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"id": 1,
"orgId": 1,
"shortName": "Account1",
"beneficiaryName": "Account1",
"bankName": "ENBD",
"bankCountry": "UAE",
"currency": "AED",
"isVerified": true,
"isEnabled": true,
"isDefault": true,
"accountNumber": "account1",
"transferDetails": "{swift: \"123123\"}"
}
]
}

Gets all the fuze target accounts for the org

Authorizations:

UserAuth

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"fuzeAccountId": 1,
"shortName": "Account Name",
"beneficiaryName": "Beneficiary Name",
"bankName": "ENBD",
"bankCountry": "UAE",
"currency": "AED",
"isVerified": true,
"isDefault": true,
"bankAccountNumber": "ACC1234",
"transferDetails": "{swift: \"123123\"}",
"ibanProvider": "Zand"
}
]
}

get all orders for an org

Returns the created orders for the org. (Requires READ permission on finance.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

pageNumber	integer
pageSize	integer
fromDate	string
toDate	string
transactionType	string
sort	string

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 2,
"fromDate": "2023-08-22",
"toDate": "2023-08-23",
"transactionType": "BUY",
"sort": "createdAt:DESC"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"createdAt": "2023-08-28T16:09:47.537Z",
"updatedAt": "2023-08-28T16:09:47.537Z",
"side": "BUY",
"symbol": "BTC_AED",
"filled": 0.1,
"averagePrice": 100,
"externalId": "abcd",
"orgUserId": "fake_user",
"orgMarkup": 1,
"orgVat": 5,
"fuzeMarkup": 5,
"fuzeVat": 0.5,
"status": "COMPLETED",
"orgSettlementId": "b986d0eb-a7df-4fc9-b440-3ffa73a4b1f9",
"baseAveragePrice": 100,
"netExecutedAmount": 49,
"totalExecutedAmount": 50,
"commissionAmount": 1
},
"error": null
}

export orders for an org

Exports the orders for the org. (Requires READ permission on finance.)

Authorizations:

UserAuth

Request Body schema: application/json

fromDate required	string
toDate required	string
orgUserId	string
status	string
side	string
sort	string

Responses

Request samples

Payload

Content type

application/json

{"fromDate": "2023-08-22",
"toDate": "2023-08-23",
"orgUserId": "orgUserId",
"status": "OPEN,CLOSED",
"side": "BUY,SELL",
"sort": "createdAt:DESC"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "OK"
}

get fx rate between two currencies

get fx rate between two currencies. (Requires READ permission on finance.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

fromCurrency	string
toCurrency	string

Responses

Request samples

Payload

Content type

application/json

{"fromCurrency": "USD",
"toCurrency": "AED"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": 3,
"error": null
}

Cancels the transaction

Authorizations:

UserAuth

Request Body schema: application/json

referenceId	string
transactionStatus	string
transactionType	string

Responses

Request samples

Payload

Content type

application/json

{"referenceId": "asdf1234",
"transactionStatus": "CANCELED",
"transactionType": "DEPOSIT"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "OK"
}

swap between two currencies for same org

swap between two currencies for same org. (Requires READWRITE permission for finance)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

fromCurrency	string
fromAmount	integer
toCurrency	string
toAmount	integer

Responses

Request samples

Payload

Content type

application/json

{"fromCurrency": "USD",
"fromAmount": 100,
"toCurrency": "AED",
"toAmount": 367
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "OK"
}

loyalty

buy/sell loyalty points

reward tokens, or sell rewarded tokens. (Requires READWRITE permissions for loyalty).

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId required	string
symbol required	string
quoteQuantity required	number quoteQuantity is the local currency amount you want to buy or sell crypto for. Eg: If if you want to buy 1000 AED worth of BTC, you’ll have quoteQuantity 1000 on BTC_AED. If you’re selling 1000 AED quoteQuantity of BTC, quoteQuantity is 1000. Not quantity should be zero in both cases.
operation required	string Enum: "BUY" "SELL"
type	string (OrderType) Enum: "MARKET" "LIMIT"
clientOrderId	string this is an idempotency key to avoid duplicate orders due to network failures

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "barabara_allen",
"symbol": "ETH_AED",
"quoteQuantity": 1000,
"operation": "BUY",
"type": "MARKET",
"clientOrderId": "unique-uuid"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"id": 101,
"orgId": 12,
"orgUserId": "michael_scott",
"symbol": "BTC_AED",
"side": "BUY",
"type": "MARKET",
"kind": "FILL_OR_KILL",
"status": "COMPLETED",
"quantity": 1,
"filled": 1,
"executedAmount": 1,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatRate": 0.05,
"vatAmount": 0
},
"error": null
}

fetch the details of a particular order

Returns the details of a particular order. (Requires READ permission on Loyalty.)

Authorizations:

ApiKeyAuth

path Parameters

orderId

required

string

orderId of the order for which details needs to be fetched

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"id": 101,
"orgId": 12,
"orgUserId": "michael_scott",
"symbol": "BTC_AED",
"side": "BUY",
"type": "MARKET",
"kind": "FILL_OR_KILL",
"status": "COMPLETED",
"quantity": 1,
"filled": 1,
"executedAmount": 1,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatRate": 0.05,
"vatAmount": 0
},
"error": null
}

org

Fetch balance of your org

Fetch token balances of your org. Requires READ permissions for Org.

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"orgId": 1,
"balance": {"AED": 10,
"USD": 5
}
},
"error": null
}

otc

create an otc order for the user

Returns the created order along with details. (Requires READWRITE permission on OTC.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

One of

orgUserId required	string
symbol required	string
quoteQuantity required	number quoteQuantity is the local currency amount you want to buy or sell crypto for. Eg: If if you want to buy 1000 AED worth of BTC, you’ll have quoteQuantity 1000 on BTC_AED. If you’re selling 1000 AED quoteQuantity of BTC, quoteQuantity is 1000. Not quantity should be zero in both cases.
operation required	string Enum: "BUY" "SELL"
type	string (OrderType) Enum: "MARKET" "LIMIT"
clientOrderId	string this is an idempotency key to avoid duplicate orders due to network failures

Responses

Request samples

Payload

Content type

application/json

Example

CreateOrderRequestBodyQuoteQuantity

{"orgUserId": "barabara_allen",
"symbol": "ETH_AED",
"quoteQuantity": 1000,
"operation": "BUY",
"type": "MARKET",
"clientOrderId": "unique-uuid"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"id": 101,
"orgId": 12,
"orgUserId": "michael_scott",
"symbol": "BTC_AED",
"side": "BUY",
"type": "MARKET",
"kind": "FILL_OR_KILL",
"status": "COMPLETED",
"quantity": 1,
"filled": 1,
"executedAmount": 1,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatRate": 0.05,
"vatAmount": 0
},
"error": null
}

get all orders for a user

Returns the created orders for the user. (Requires READ permission on OTC.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId required	string
pageNumber	integer <int32>
pageSize	integer <int32>
fromDate	string <date>
toDate	string <date>
status	string
productType	string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "barbara_allen",
"pageNumber": 1,
"pageSize": 1,
"fromDate": "2023-03-02",
"toDate": "2023-03-02",
"status": "OPEN",
"productType": "LOYALTY"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": [{"id": 101,
"orgId": 12,
"orgUserId": "barbara.allen",
"symbol": "BTC_AED",
"side": "BUY",
"status": "COMPLETED",
"quantity": 1,
"filled": 1,
"executedAmount": 1,
"vatRate": 0.05,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatAmount": 0
},
{"id": 102,
"orgId": 12,
"orgUserId": "larry.meyers",
"symbol": "ETH_AED",
"status": "COMPLETED",
"side": "BUY",
"quantity": 2,
"filled": 1,
"executedAmount": 2,
"vatRate": 0.05,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatAmount": 0
}
],
"error": null
}

fetch the details of a particular order

Returns the details of a particular order. (Requires READ permission on OTC.)

Authorizations:

ApiKeyAuth

path Parameters

orderId

required

string

orderId of the order for which details needs to be fetched

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"id": 101,
"orgId": 12,
"orgUserId": "michael_scott",
"symbol": "BTC_AED",
"side": "BUY",
"type": "MARKET",
"kind": "FILL_OR_KILL",
"status": "COMPLETED",
"quantity": 1,
"filled": 1,
"executedAmount": 1,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatRate": 0.05,
"vatAmount": 0
},
"error": null
}

generate a quote for the user

Returns the quote. Either quantity or quoteQuantity must be provided, but not both. (Requires WRITE permission on OTC.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

One of

quantity required	number
orgUserId	string
symbol	string
operation	string

Responses

Request samples

Payload

Content type

application/json

{"quoteQuantity": 200,
"orgUserId": "barabara_allen",
"symbol": "ETH_AED",
"operation": "BUY"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"id": 10,
"orgId": 12,
"orgUserId": "barbara.allen",
"expiryTime": 99999999999,
"quantity": 1,
"price": 100,
"symbol": "ETH_AED",
"operation": "BUY"
},
"error": null
}

Paginated query to fetch multiple orders by orderIds for an org

Returns list of orders for the org. (Requires READ permission on Trading.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

pageNumber	integer <int32>
pageSize	integer <int32>
orderIds required	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 2,
"orderIds": [101,
102
]
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": [{"id": 101,
"orgId": 12,
"orgUserId": "barbara.allen",
"symbol": "BTC_AED",
"side": "BUY",
"status": "COMPLETED",
"quantity": 1,
"filled": 1,
"executedAmount": 1,
"vatRate": 0.05,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatAmount": 0
},
{"id": 102,
"orgId": 12,
"orgUserId": "larry.meyers",
"symbol": "ETH_AED",
"status": "COMPLETED",
"side": "BUY",
"quantity": 2,
"filled": 1,
"executedAmount": 2,
"vatRate": 0.05,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatAmount": 0
}
],
"error": null
}

report

get all CAS for an Org

Returns the CAS statements for the org.

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

pageNumber	integer <int32>
pageSize	integer <int32>
fromDate	string <date>
toDate	string <date>

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 1,
"fromDate": "2023-03-02",
"toDate": "2023-03-02"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": [{"uuid": "2ba8a592-312b-4849-8f5b-e9a60f51be58",
"entityName": "CAS",
"entityId": 0,
"docDescription": "statement-2024-12-02 to 2024-12-10"
}
],
"error": null
}

Download consolidated settlement report for an org

Authorizations:

UserAuth

Request Body schema: application/json

uuid

required

string

Responses

Request samples

Payload

Content type

application/json

{"uuid": "2ba8a592-312b-4849-8f5b-e9a60f51be58"
}

Response samples

200
400
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"url": "https://fuze.finance/path/to/file.pdf",
"expiryTime": 1721922798.244
}
}

Fetch all successful transactions for an org for given orgSettlementId

Fetches all successful transactions for an org against a given orgSettlementId. Note: Pagination is applicable only for json response.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

orgSettlementId	string
toJson	boolean
pageNumber	number or null
pageSize	number or null

Responses

Request samples

Payload

Content type

application/json

{"orgSettlementId": "95606754-8c6e-45b7-b7e4-1ae9ccffb31f",
"toJson": true,
"pageNumber": 0,
"pageSize": 50
}

Response samples

200
400
404
500

Content type

application/json

{"code": 200,
"data": [{"id": 66624,
"createdAt": "2024-03-28T06:59:03.751Z",
"orgUserId": "test.org",
"orgId": 135,
"side": "BUY",
"quantity": 0.002,
"quoteQuantity": 0,
"symbol": "BTC_AED",
"orgCurrency": "AED",
"orgMarkupAmount": 0,
"orgVatAmount": 0,
"costPrice": 140.59078,
"netExecutedAmount": 515.9681626,
"totalExecutedAmount": 516.50992917,
"orgSettlementId": "95606754-8c6e-45b7-b7e4-1ae9ccffb31f'",
"updatedAt": "2024-03-28T06:59:04.825Z",
"commissionAmount": 0,
"vatAmount": 0,
"finalAveragePrice": 258242.065381
},
{"id": 66625,
"createdAt": "2024-03-28T07:00:11.791Z",
"orgUserId": "test.org",
"orgId": 135,
"side": "BUY",
"quantity": 0.00193707,
"quoteQuantity": 500,
"symbol": "BTC_AED",
"orgCurrency": "AED",
"orgMarkupAmount": 0,
"orgVatAmount": 0,
"costPrice": 136.23969249,
"netExecutedAmount": 499.99967144,
"totalExecutedAmount": 500.5246711,
"orgSettlementId": "95606754-8c6e-45b7-b7e4-1ae9ccffb31f",
"updatedAt": "2024-03-28T07:00:12.868Z",
"commissionAmount": 0,
"vatAmount": 0,
"finalAveragePrice": 258379.754532
}
],
"error": null
}

Send consolidated settlement report for an org via email for a given time period

Sends consolidated settlement report for an org via email for a given time period

Authorizations:

JWT

Request Body schema: application/json

from	string
to	string
orgUserId	string
orgId	integer

Responses

Request samples

Payload

Content type

application/json

{"from": "2023-05-01",
"to": "2023-05-31",
"orgUserId": "user_1",
"orgId": 135
}

Response samples

200
400
404
500

Content type

application/csv

{
  "code": 200,
  "error": null,
  "data": "Your request to send transactions via email is registered successfully"
}

payment

Request invoice by a customer

Request invoice by a customer. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

targetOrgUuid required	string
currency required	string
amount required	number
idempotencyKey	string
notes	string

Responses

Request samples

Payload

Content type

application/json

{"targetOrgUuid": "ABC123123",
"currency": "USD",
"amount": 100,
"idempotencyKey": "asbasda",
"notes": "test test"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"uuid": "d0cf3a76-9579-4571-96a6-3fd23557b59a",
"targetOrgUuid": "FUZE308435",
"currency": "USD",
"amount": 10000,
"status": "CREATED",
"type": "REQUEST",
"notes": "Payment for Property",
"cancellationReason": null,
"createdAt": "2024-05-22T07:47:16.592Z"
},
"error": null
}

Generate upload link to upload invoice file

Generate upload link to upload invoice file. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

fileName required	string
orgId	number or null
entityName	string or null

Responses

Request samples

Payload

Content type

application/json

{"fileName": "example.pdf",
"orgId": 1,
"entityName": "INVOICES"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"url": "https://test.s3.amazonaws.com/invoices/test.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJ2J",
"expiryTime": 1717332855.723
},
"error": null
}

Generate download link for an invoice file

Authorizations:

UserAuth

Request Body schema: application/json

invoiceId

required

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"invoiceId": 1
}

Response samples

200
403
404
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"url": "https://fuze.finance/path/to/file.pdf",
"expiryTime": 1721922798.244,
"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f"
}
}

Fetch invoice for a customer

Fetch invoice for a customer. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

path Parameters

invoiceId

required

string

invoiceId for which the api needs to be called

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"uuid": "d0cf3a76-9579-4571-96a6-3fd23557b59a",
"targetOrgUuid": "FUZE308435",
"currency": "USD",
"amount": 10000,
"status": "CREATED",
"type": "REQUEST",
"notes": "Payment for Property",
"cancellationReason": null,
"createdAt": "2024-05-22T07:47:16.592Z"
},
"error": null
}

Cancel invoice for a customer

Cancel invoice for a customer. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

path Parameters

invoiceId

required

string

invoiceId for which the api needs to be called

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

reason

string

Responses

Request samples

Payload

Content type

application/json

{"reason": "Customer rejected the buy"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "SUCCESS"
}

Get all invoices for a customer

Get all invoices for a customer. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

query Parameters

status	string status of each invoice. Example: PAID
pageNumber	integer offset of the page. Default is 0.
pageSize	integer number of records to fetch in a page. Default is 50.
fromDate	string used for date range. should be in YYYY-MM-DD
toDate	string used for date range. should be in YYYY-MM-DD

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"sent": [{"uuid": "d0cf3a76-9579-4571-96a6-3fd23557b59a",
"orgId": 1,
"targetOrgId": 2,
"targetOrgUuid": "FUZE308435",
"externalId": "test1",
"idempotencyKey": "test2",
"currency": "USD",
"amount": 10000,
"status": "CREATED",
"type": "REQUEST",
"notes": "Payment for Property",
"cancellationReason": null,
"createdAt": "2024-05-22T07:47:16.592Z",
"sourceName": "source",
"targetName": "target"
}
],
"received": [{"uuid": "d0cf3a76-9579-4571-96a6-3fd23557b59a",
"orgId": 1,
"targetOrgId": 2,
"targetOrgUuid": "FUZE308435",
"externalId": "test1",
"idempotencyKey": "test2",
"currency": "USD",
"amount": 10000,
"status": "CANCELLED",
"type": "REQUEST",
"notes": "Payment for Property",
"cancellationReason": "Reason to cancel",
"createdAt": "2024-05-22T07:47:16.592Z",
"sourceName": "source",
"targetName": "target"
}
]
},
"error": null
}

Request payment by a customer

Request payment by a customer. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId required	string
symbol required	string
quantity required	number quantity is how much you’re buying or selling. Eg: If you’re buying 0.01 BTC, the quantity is 0.01. If you’re selling 0.01 BTC, quantity is 0.01.
operation required	string Enum: "BUY" "SELL"
quoteId	string generated quote id for the crypto to fiat leg
invoiceId	string invoice that the client is paying

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "barabara_allen",
"symbol": "ETH_AED",
"quantity": 0.01,
"operation": "BUY",
"quoteId": "unique-uuid",
"invoiceId": "unique-uuid"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "SUCCESS"
}

Search in the address book

Search in the address book. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

email	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"email": "test@test.com",
"name": "test"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"uuid": "FUZE121212",
"status": "PENDING",
"nickName": "TEST",
"email": "test@test.com"
}
}

Create an entry in the address book

Create an entry in the address book. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

email	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"email": "test@test.com",
"name": "TESTNAME"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"uuid": "FUZE121212",
"status": "PENDING",
"nickName": "TEST",
"email": "test@test.com"
}
}

Delete from the address book

Delete from the address book. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

path Parameters

addressBookId

required

string

addressBookId which needs to be deleted

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "SUCCESS"
}

Get all payouts for a dealer

Get all payouts for a dealer. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

query Parameters

status	string status of each invoice. Example: PAID
pageNumber	integer offset of the page. Default is 0.
pageSize	integer number of records to fetch in a page. Default is 50.
fromDate	string used for date range. should be in YYYY-MM-DD
toDate	string used for date range. should be in YYYY-MM-DD

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"orgId": 10,
"amount": 10,
"currency": "AED"
}
]
}

Get earnings for a dealer

Get earnings for a dealer. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"pendingPayouts": 100,
"totalEarned": 100
}
}

Get invoice file from AWS S3 bucket

Authorizations:

UserAuth

query Parameters

bucket required	string name of the S3 bucket.
key required	string key for the object in the bucket.

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"type": "buffer",
"data": [1,
2,
3
]
}
}

Create a property

Create a property. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

name	string
businessName	string
beneficiaryName	string
bankName	string
bankCountry	string
transferDetails	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Property Name",
"businessName": "A123TZ456",
"beneficiaryName": "Beneficiary Name",
"bankName": "ENBD",
"bankCountry": "UAE",
"transferDetails": "{\"iban\": \"IBAN01234\"}"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"name": "Property Name",
"businessName": "A123TZ456",
"account": {"beneficiaryName": "Beneficiary Name",
"bankName": "ENBD",
"bankCountry": "UAE",
"transferDetails": "{\"iban\": \"IBAN01234\"}"
}
}
}

Fetch the list of properties

Fetch the list of properties. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"name": "Property Name1",
"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"businessName": "A123TZ456",
"account": {"beneficiaryName": "Beneficiary Name1",
"bankName": "ENBD",
"bankCountry": "UAE",
"transferDetails": "{\"iban\": \"IBAN01234\"}"
}
},
{"name": "Property Name2",
"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"businessName": "A123OP789",
"account": {"beneficiaryName": "Beneficiary Name2",
"bankName": "ENBD",
"bankCountry": "UAE",
"transferDetails": "{\"iban\": \"IBAN56789\"}"
}
}
]
}

Create an invoice for a property

Create an invoice for a property. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

targetOrgUuid required	string
currency required	string
amount required	number
idempotencyKey	string
notes	string

Responses

Request samples

Payload

Content type

application/json

{"targetOrgUuid": "ABC123123",
"currency": "USD",
"amount": 100,
"idempotencyKey": "asbasda",
"notes": "test test"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"uuid": "d0cf3a76-9579-4571-96a6-3fd23557b59a",
"targetOrgUuid": "FUZE308435",
"currency": "USD",
"amount": 10000,
"status": "CREATED",
"type": "REQUEST",
"notes": "Payment for Property",
"cancellationReason": null,
"createdAt": "2024-05-22T07:47:16.592Z"
},
"error": null
}

Create third-party for payment gateway

Create third-party for payment gateway. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

email

required

string

type

required

string

Enum: "FIRST_PARTY" "THIRD_PARTY"

clientIdentifier

required

string

required

object

fullName required	string
entityType required	string Enum: "individual" "business"
email required	string
addressLine1 required	string
addressLine2	string
city required	string
state	string
country required	string
postalCode required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "sherlockholmes@baker.st",
"type": "THIRD_PARTY",
"clientIdentifier": "SH123456",
"kycData": {"fullName": "Sherlock Holmes",
"entityType": "individual",
"email": "sherlockholmes@baker.st",
"addressLine1": "221B Baker Street",
"addressLine2": "221B Baker Street",
"city": "London",
"state": "London",
"country": "GB",
"postalCode": "NW1 6XE"
}
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"name": "Sherlock Holmes",
"email": "sherlockholmes@baker.st",
"type": "THIRD_PARTY",
"status": "ACTIVE",
"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"clientIdentifier": "SH123456",
"createdAt": "2023-08-28T16:09:47.537Z"
}
}

Get third party details for the clientIdentifier

Get third party details for the clientIdentifier. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

clientIdentifier

required

string

Responses

Request samples

Payload

Content type

application/json

{"clientIdentifier": "SH123456"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"name": "Sherlock Holmes",
"email": "sherlockholmes@baker.st",
"type": "THIRD_PARTY",
"status": "ACTIVE",
"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"clientIdentifier": "SH123456",
"createdAt": "2023-08-28T16:09:47.537Z"
}
}

Get third-party list for payment gateway

Get third-party list for payment gateway. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

pageNumber	integer <int32>
pageSize	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 1
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"name": "Sherlock Holmes",
"email": "sherlockholmes@baker.st",
"type": "THIRD_PARTY",
"status": "ACTIVE",
"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"clientIdentifier": "SH123456"
}
]
}

Create a crypto deposit wallet for the third party

Create a crypto deposit wallet for the third party. (Requires READWRITE permission for Bank)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

clientIdentifier required	string
symbol required	string
chain required	string

Responses

Request samples

Payload

Content type

application/json

{"clientIdentifier": "sherlockholmes",
"symbol": "USDC_AED",
"chain": "ETHEREUM"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"clientIdentifier": "sherlockholmes",
"address": "0x44FC533C19F28b33dcbdF2346691Ae7a1Ad2295b",
"chain": "ETHEREUM",
"network": "SEPOLIA",
"asset": "ETH",
"status": "APPROVED",
"createdAt": "2024-12-23T13:38:00.999Z",
"symbol": "ETH_AED",
"memo": "12345"
}
}

Get the list of crypto deposit wallets for the third party

Get the list of crypto deposit wallets for the third party. (Requires READWRITE permission for Bank)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"clientIdentifier": "sherlockholmes",
"address": "0x44FC533C19F28b33dcbdF2346691Ae7a1Ad2295b",
"chain": "ETHEREUM",
"network": "SEPOLIA",
"asset": "ETH",
"status": "APPROVED",
"createdAt": "2024-12-23T13:38:00.999Z",
"symbol": "ETH_AED"
}
]
}

Create a payin for a third party

Create a payin for a third party. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

clientIdentifier required	string
symbol required	string
chain required	number
quantity required	number
clientOrderId	string

Responses

Request samples

Payload

Content type

application/json

{"clientIdentifier": "sherlockholmes",
"symbol": "USDC_USD",
"chain": "ETHEREUM",
"quantity": 123.45,
"clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"clientIdentifier": "sherlockholmes",
"clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"status": "CREATED",
"walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f4sk",
"chain": "ETHEREUM",
"network": "TESTNET",
"symbol": "USDC_USD",
"quantity": 123.45,
"quoteQuantity": 123.45,
"expiryTime": 1717332855
},
"error": null
}

Get status of a payin for a third party

Get status of a payin for a third party. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

clientOrderId

required

string

Responses

Request samples

Payload

Content type

application/json

{"clientOrderId": "SH123456"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"clientIdentifier": "sherlockholmes",
"clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"status": "CREATED",
"walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f4sk",
"chain": "ETHEREUM",
"network": "TESTNET",
"symbol": "USDC_USD",
"quantity": 123.45,
"quoteQuantity": 123.45,
"expiryTime": 1717332855
},
"error": null
}

Get list of payins for a merchant

Get list of payins for a merchant. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

pageNumber	integer <int32>
pageSize	integer <int32>
fromDate	string <date>
toDate	string <date>
status	string Enum: "KYC_PENDING" "CREATED" "TXN_CREATED" "INITIATED" "UNDERPAID" "PAID" "OVERPAID" "SETTLED" "CANCELLED" "REJECTED" "QUOTE_EXPIRED"

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 1,
"fromDate": "2023-03-02",
"toDate": "2023-03-02",
"status": "KYC_PENDING"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": [{"clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"status": "CREATED",
"createdAt": "2024-05-22T07:47:16.592Z",
"symbol": "USDC_USD",
"quantity": 123.45,
"quoteQuantity": 123.45
}
],
"error": null
}

Create quote for a payout for a third party

Create quote a payout for a third party. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

clientIdentifier required	string
symbol required	string
operation	string Enum: "BUY" "SELL"
chain required	string
quantity required	number
clientOrderId	string

Responses

Request samples

Payload

Content type

application/json

{"clientIdentifier": "sherlockholmes",
"symbol": "USDC_USD",
"operation": "BUY",
"chain": "ETHEREUM",
"quantity": 123.45,
"clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"id": 1,
"clientIdentifier": "sherlockholmes",
"symbol": "USDC_USD",
"quantity": 123.45,
"price": 123.45,
"expiryTime": 1717332855,
"operation": "SELL"
},
"error": null
}

Create a payout for a third party

Create a payout for a third party. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

clientIdentifier required	string
address required	string
chain required	string
quoteId required	number
clientOrderId	string

Responses

Request samples

Payload

Content type

application/json

{"clientIdentifier": "sherlockholmes",
"address": "0x742d35Cc6634C0532925a3b844Bc454e4438f4sk",
"chain": "ETHEREUM",
"quoteId": 123,
"clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": "SUCCESS",
"error": null
}

Get status of a payout for a third party

Get status of a payout for a third party. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

clientOrderId

required

string

Responses

Request samples

Payload

Content type

application/json

{"clientOrderId": "SH123456"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "SUCCESS"
}

Get list of payouts for a merchant

Get list of payouts for a merchant. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

pageNumber	integer <int32>
pageSize	integer <int32>
fromDate	string <date>
toDate	string <date>
status	string Enum: "KYC_PENDING" "CREATED" "TXN_CREATED" "INITIATED" "UNDERPAID" "PAID" "OVERPAID" "SETTLED" "CANCELLED" "REJECTED" "QUOTE_EXPIRED"

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 1,
"fromDate": "2023-03-02",
"toDate": "2023-03-02",
"status": "KYC_PENDING"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": [{"clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"status": "CREATED",
"createdAt": "2024-05-22T07:47:16.592Z",
"symbol": "USDC_USD",
"quantity": 123.45,
"quoteQuantity": 123.45
}
],
"error": null
}

Validate an address for a given chain

Validate an address for a given chain. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

address required	string
chain required	string

Responses

Request samples

Payload

Content type

application/json

{"address": "0x742d35Cc6634C0532925a3b844Bc454e4438f4sk",
"chain": "ETHEREUM"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"isValid": true
}
}

Internal transfer of asset between users

Internal transfer of asset between users. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

sourceOrgUserId required	string
destinationOrgUserId required	string
currency required	string
quantity required	number

Responses

Request samples

Payload

Content type

application/json

{"sourceOrgUserId": "barbara_allen",
"destinationOrgUserId": "barbara_allen_1",
"currency": "BTC",
"quantity": 0.01
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "OK"
}

Create third-party for remittance

Create third-party for remittance. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

name	string
email	string
address	string
nationality	string
country	string
idType	string
idNumber	string
type	string
clientIdentifier	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Nick",
"email": "nickfury@gmail.com",
"address": "1-A, Baker Street",
"nationality": "British",
"country": "UK",
"idType": "EID",
"idNumber": "123456789",
"type": "ORIGINATOR",
"clientIdentifier": "NICK123456"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"name": "John Doe",
"email": "john.doe@example.com",
"type": "ORIGINATOR",
"status": "PENDING",
"clientIdentifier": "JD123456"
}
}

Create third-party with beneficiary account for remittance

Create third-party with beneficiary account for remittance. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

name

string

email

string

address

string

nationality

string

country

string

idType

string

idNumber

string

type

string

clientIdentifier

string

object

clientIdentifier	string
uuid	string
status	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Nick",
"email": "nickfury@gmail.com",
"address": "1-A, Baker Street",
"nationality": "British",
"country": "UK",
"idType": "EID",
"idNumber": "123456789",
"type": "ORIGINATOR",
"clientIdentifier": "NICK123456",
"account": {"clientIdentifier": "NICK123456",
"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"status": "PENDING"
}
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"name": "John Doe",
"email": "john.doe@example.com",
"type": "ORIGINATOR",
"status": "PENDING",
"clientIdentifier": "JD123456",
"account": {"clientIdentifier": "JD123456",
"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"status": "PENDING"
}
}
}

Get third party list i.e. originator list

Get third party list i.e. originator list. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

Request Body schema: application/json

pageNumber	integer <int32>
pageSize	integer <int32>
search	string

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 1,
"search": "Nick"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"name": "John Doe",
"email": "john.doe@example.com",
"type": "ORIGINATOR",
"status": "PENDING",
"clientIdentifier": "JD123456"
}
}

Get third-party for remittance

Get third-party for remittance. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

clientIdentifier

required

string

Responses

Request samples

Payload

Content type

application/json

{"clientIdentifier": "SH123456"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"name": "John Doe",
"email": "john.doe@example.com",
"type": "ORIGINATOR",
"status": "PENDING",
"clientIdentifier": "JD123456"
}
}

Create an account for the third party

Create an account for the third party. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

clientIdentifier

string

object

accountNumber	string
ifscCode	string
name	string
relationship	string

currency

string

country

string

accountType

string

Responses

Request samples

Payload

Content type

application/json

{"clientIdentifier": "NICK123456",
"accountData": {"accountNumber": "123456789",
"ifscCode": "ICIC0000001",
"name": "Nick Fury",
"relationship": "FAMILY"
},
"currency": "USD",
"country": "UK",
"accountType": "BANK"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"clientIdentifier": "JD123456",
"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"status": "PENDING"
}
}

Get third-party account for remittance

Get third-party account for remittance. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

clientIdentifier

required

string

Responses

Request samples

Payload

Content type

application/json

{"clientIdentifier": "SH123456"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"status": "ACTIVE"
}
}

Deletes an account for the third party

Deletes an account for the third party. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

clientIdentifier

required

string

Responses

Request samples

Payload

Content type

application/json

{"clientIdentifier": "SH123456"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": "SUCCESS"
}

Create quote for remittance for a third party

Create quote for remittance for a third party. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

quoteId	number
quantity	number
fromCurrency	string
toCurrency	string

Responses

Request samples

Payload

Content type

application/json

{"quoteId": 1,
"quantity": 100,
"fromCurrency": "AED",
"toCurrency": "INR"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"quoteId": 1,
"fromCurrency": "AED",
"toCurrency": "INR",
"quantity": 100,
"price": 20,
"expiryTime": 1717332855
}
}

Create payment for remittance quote for a third party

Create payment for remittance quote for a third party. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

quantity	number
quoteId	number

Responses

Request samples

Payload

Content type

application/json

{"quantity": 100,
"quoteId": 2
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"fromCurrency": "AED",
"toCurrency": "INR",
"quantity": 100,
"status": "PENDING"
}
}

Get payment details for remittance quote for a third party

Get payment details for remittance quote for a third party. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

uuid

string

Responses

Request samples

Payload

Content type

application/json

{"uuid": "SH123456"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"fromCurrency": "AED",
"toCurrency": "INR",
"quantity": 100,
"status": "SUCCESS"
}
}

Create a payout for a third party

Create a payout for a third party. (Requires READWRITE permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

currency	string
amount	number
clientOrderId	string
uuid	string
purpose	string

Responses

Request samples

Payload

Content type

application/json

{"currency": "INR",
"amount": 100,
"clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"purpose": "SALARY"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"id": 1,
"amount": 100,
"status": "PENDING",
"currency": "AED",
"paymentReferenceNumber": "",
"paymentDate": ""
}
}

Get payout list for an originator

Get payout list for an originator. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

pageNumber	integer <int32>
pageSize	integer <int32>
search	string
currency	string
fromDate	string
toDate	string

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 1,
"search": "Nick",
"currency": "INR",
"fromDate": "2023-03-02",
"toDate": "2023-03-02"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
"fromCurrency": "AED",
"toCurrency": "INR",
"status": "SUCCESS"
}
]
}

Get payout info for an originator

Get payout info for an originator. (Requires READ permission for Payment)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

clientOrderId

required

string

Responses

Request samples

Payload

Content type

application/json

{"clientOrderId": "SH123456"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"status": "PENDING",
"currency": "AED",
"amountDeducted": 100,
"amountSent": 100,
"createdAt": "2023-03-02",
"referenceId": "123456",
"paymentReferenceNumber": "123456",
"paymentDate": "2023-03-02"
}
}

policy

create policy for the org

create policy for the org. (Requires READWRITE permission for policy)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId	string
policyName	string
parameters	object
action	string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "admin@fuze.finance",
"policyName": "ASSET_EXPOSURE",
"parameters": { },
"action": "ACCEPT"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"id": 1,
"orgId": 9,
"orgUserId": "admin@fuze.finance",
"name": "ASSET_ENABLE",
"parameters": [{"symbol": "AED",
"enable": true
}
],
"action": "ACCEPT",
"isActive": true,
"createdAt": 1676444477,
"updatedAt": 1676444477
}
}

delete policy for your org

delete policy for your org. (Requires READWRITE permission for policy)

Authorizations:

ApiKeyAuth

path Parameters

policyId

required

string

policyId of the org that needs to be deleted

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"numDeleted": 1
}
}

Fetch policy for your org

Fetch policy for your org. (Requires READ permission for policy)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId	string
policyName	string
action	string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "barbara_allen",
"policyName": "ASSET_EXPOSURE",
"action": "ACCEPT"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"id": 1,
"orgId": 9,
"orgUserId": "admin@fuze.finance",
"name": "ASSET_ENABLE",
"parameters": [{"symbol": "AED",
"enable": true
}
],
"action": "ACCEPT",
"isActive": true,
"createdAt": 1676444477,
"updatedAt": 1676444477
}
]
}

price

Fetch historical price

Fetches historical prices of a currency pair averaged over a window of 60 seconds. (Requires READ permissions for Price.)

Authorizations:

ApiKeyAuth

query Parameters

symbol	string The symbol for which historical prices are required
fromTimestampInSecs	number start time stamp for the history of prices
toTimestampInSecs	number end time stamp for the history of prices
avgtimeBucketInSecs	number time bucket for averaging the price points

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": [{"timestamp": 1676900940000,
"value": 1705.519242424242
},
{"timestamp": 1676901000000,
"value": 1705.109122807016
}
]
}

Fetch current price of a symbol

Fetches current price of a currency pair.

Authorizations:

PublicAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

symbol	string
side	string
quantity	number or null
quoteQuantity	number or null

Responses

Request samples

Payload

Content type

application/json

{"symbol": "BTC_USD",
"side": "BUY",
"quantity": 1,
"quoteQuantity": 1
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"timestamp": 1676900940000,
"value": 1705.519242424242
}
}

Fetch current price of a symbol

Fetches current price of a currency pair. (Requires READ permissions for Price.)

Authorizations:

ApiKeyAuth

path Parameters

symbol

required

string

The symbol for which current price needs to be fetched.

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"timestamp": 1676900940000,
"value": 1705.519242424242
}
}

Fetch candle price for the symbol

Fetches candle price of a currency pair. (Requires READ permissions for Price.)

Authorizations:

ApiKeyAuth

path Parameters

symbol

required

string

The symbol for which candle price needs to be fetched.

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
403
500

Content type

application/json

{"code": 200,
"data": {"timestamp": 1676900940000,
"buy": 1705.51,
"sell": 1705.51,
"price": 1705.51,
"pricesWithMarkups": {"buy": 1705.51,
"sell": 1705.51,
"price": 1705.51
}
}
}

revenue

create revenue policy for the org

create revenue policy for the org. (Requires READWRITE permission for revenue)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId required	string
policyName required	string
parameters required	object
action required	string Enum: "ACCEPT" "REJECT" "NOTIFY"

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "admin@fuze.finance",
"policyName": "ORG_VAT",
"parameters": { },
"action": "ACCEPT"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"id": 1,
"orgId": 9,
"orgUserId": "admin@fuze.finance",
"name": "ASSET_ENABLE",
"parameters": [{"symbol": "AED",
"enable": true
}
],
"action": "ACCEPT",
"isActive": true,
"createdAt": 1676444477,
"updatedAt": 1676444477
}
}

Get markup history

Get markup history (Requires READWRITE permission for policy)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

pageNumber	integer
pageSize	integer
orgUserId	string
sort	string

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 2,
"orgUserId": "*",
"sort": "createdAt:DESC"
}

Response samples

200
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"newValue": "{\"MARKUP\" : [{\"symbol\" : \"BTC_AED\", \"markup\" : \"0.01\"}]}",
"oldValue": "{\"MARKUP\" : [{\"symbol\" : \"BTC_AED\", \"markup\" : \"0.02\"}]}",
"entityCreateUserId": "fake_user",
"entityCreateTime": "2023-08-28T16:09:47.537Z"
}
]
}

trading

create a trading order for the user

Returns the created order along with details. (Requires READWRITE permission on Trading.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

One of

orgUserId required	string
symbol required	string
quoteQuantity required	number quoteQuantity is the local currency amount you want to buy or sell crypto for. Eg: If if you want to buy 1000 AED worth of BTC, you’ll have quoteQuantity 1000 on BTC_AED. If you’re selling 1000 AED quoteQuantity of BTC, quoteQuantity is 1000. Not quantity should be zero in both cases.
operation required	string Enum: "BUY" "SELL"
type	string (OrderType) Enum: "MARKET" "LIMIT"
clientOrderId	string this is an idempotency key to avoid duplicate orders due to network failures

Responses

Request samples

Payload

Content type

application/json

Example

CreateOrderRequestBodyQuoteQuantity

{"orgUserId": "barabara_allen",
"symbol": "ETH_AED",
"quoteQuantity": 1000,
"operation": "BUY",
"type": "MARKET",
"clientOrderId": "unique-uuid"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"id": 101,
"orgId": 12,
"orgUserId": "michael_scott",
"symbol": "BTC_AED",
"side": "BUY",
"type": "MARKET",
"kind": "FILL_OR_KILL",
"status": "COMPLETED",
"quantity": 1,
"filled": 1,
"executedAmount": 1,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatRate": 0.05,
"vatAmount": 0
},
"error": null
}

get all orders for a user

Returns the created orders for the user. (Requires READ permission on Trading.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId required	string
pageNumber	integer <int32>
pageSize	integer <int32>
fromDate	string <date>
toDate	string <date>
status	string
productType	string

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "barbara_allen",
"pageNumber": 1,
"pageSize": 1,
"fromDate": "2023-03-02",
"toDate": "2023-03-02",
"status": "OPEN",
"productType": "LOYALTY"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": [{"id": 101,
"orgId": 12,
"orgUserId": "barbara.allen",
"symbol": "BTC_AED",
"side": "BUY",
"status": "COMPLETED",
"quantity": 1,
"filled": 1,
"executedAmount": 1,
"vatRate": 0.05,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatAmount": 0
},
{"id": 102,
"orgId": 12,
"orgUserId": "larry.meyers",
"symbol": "ETH_AED",
"status": "COMPLETED",
"side": "BUY",
"quantity": 2,
"filled": 1,
"executedAmount": 2,
"vatRate": 0.05,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatAmount": 0
}
],
"error": null
}

Paginated query to fetch multiple orders by orderIds for an org

Returns list of orders for the org. (Requires READ permission on Trading.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

pageNumber	integer <int32>
pageSize	integer <int32>
orderIds required	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"pageNumber": 1,
"pageSize": 2,
"orderIds": [101,
102
]
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": [{"id": 101,
"orgId": 12,
"orgUserId": "barbara.allen",
"symbol": "BTC_AED",
"side": "BUY",
"status": "COMPLETED",
"quantity": 1,
"filled": 1,
"executedAmount": 1,
"vatRate": 0.05,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatAmount": 0
},
{"id": 102,
"orgId": 12,
"orgUserId": "larry.meyers",
"symbol": "ETH_AED",
"status": "COMPLETED",
"side": "BUY",
"quantity": 2,
"filled": 1,
"executedAmount": 2,
"vatRate": 0.05,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatAmount": 0
}
],
"error": null
}

fetch the details of a particular order

Returns the details of a particular order. (Requires READ permission on Trading.)

Authorizations:

ApiKeyAuth

path Parameters

orderId

required

string

orderId of the order for which details needs to be fetched

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"id": 101,
"orgId": 12,
"orgUserId": "michael_scott",
"symbol": "BTC_AED",
"side": "BUY",
"type": "MARKET",
"kind": "FILL_OR_KILL",
"status": "COMPLETED",
"quantity": 1,
"filled": 1,
"executedAmount": 1,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatRate": 0.05,
"vatAmount": 0
},
"error": null
}

cancel a limit order

Cancels a LIMIT order. (Requires WRITE permission on Trading.)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

orgUserId required	string
orderId required	number the orderId of the order to cancel

Responses

Request samples

Payload

Content type

application/json

{"orgUserId": "barabara_allen",
"orderId": 1001
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"id": 101,
"orgId": 12,
"orgUserId": "michael_scott",
"symbol": "BTC_AED",
"side": "BUY",
"type": "MARKET",
"kind": "FILL_OR_KILL",
"status": "COMPLETED",
"quantity": 1,
"filled": 1,
"executedAmount": 1,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatRate": 0.05,
"vatAmount": 0
},
"error": null
}

fetch orders for a given settlementID (orgSettlementID)

Fetches all orders for a given settlementID

Authorizations:

ApiKeyAuth

path Parameters

settlementId

required

string

settlementId for which order needs to be fetched

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"data": {"id": 101,
"orgId": 12,
"orgUserId": "michael_scott",
"symbol": "BTC_AED",
"side": "BUY",
"type": "MARKET",
"kind": "FILL_OR_KILL",
"status": "COMPLETED",
"quantity": 1,
"filled": 1,
"executedAmount": 1,
"commissionRate": 0.01,
"commissionAmount": 0.01,
"vatRate": 0.05,
"vatAmount": 0
},
"error": null
}

webhook

overwrite the webhook

overwrite the webhook for an organisation (Requires READWRITE permission on Webhook)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Request Body schema: application/json

url	string
secret	string

Responses

Request samples

Payload

Content type

application/json

{"url": "https://abcd.webhook.net/",
"secret": "fake-secret"
}

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": {"orgId": 12,
"url": "https://abcd.webhook.net/",
"status": "ACTIVE"
}
}

fetch the webhook

fetch the webhook for an organisation (Requires READ permission on Webhook)

Authorizations:

ApiKeyAuth

header Parameters

X-SIGNATURE required	string
X-TIMESTAMP required	number

Responses

Response samples

200
400
403
500

Content type

application/json

{"code": 200,
"error": null,
"data": [{"orgId": 12,
"url": "https://abcd.webhook.net/",
"status": "ACTIVE"
}
]
}