Fuze HQ
API docs by Redocly

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

Content type
application/json
{
  • "orgUserId": "barbara_allen",
  • "modules": {
    }
}

Response samples

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

Content type
application/json
Example
{
  • "orgUserId": "johndoe123",
  • "userType": "CONSUMER",
  • "kyc": true,
  • "tnc": true,
  • "kycData": { }
}

Response samples

Content type
application/json
Example
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "orgUserId": "barabara_allen"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": {
    }
}

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

Content type
application/json
{
  • "orgUserId": "barabara_allen"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "orgUserId": "johndoe123"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": [
    ]
}

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

Content type
application/json
{
  • "orgUserId": "johndoe123"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "code": 200,
  • "data": [
    ],
  • "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

Content type
application/json
{
  • "orgUserId": "johndoe123",
  • "tnc": true,
  • "modules": { },
  • "loginAllowedFrom": "14:00:00",
  • "loginAllowedTo": "23:00:00",
  • "kycData": { }
}

Response samples

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

Content type
application/json
{
  • "orgUserId": "barabara_allen"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

apikms

Rotate API key pair

Requires READWRITE permission for APIKMS

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "error": null
}

kyc

Get verified kyc data for an individual

Get verified kyc data for an individual

Authorizations:
UserAuth

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

Get upload link to upload individual kyc file

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

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

Content type
application/json
{}

Get upload status of kyc files

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

Content type
application/json
{
  • "orgUserId": "barabara_allen"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

Get verified kyc data for an individual

Get verified kyc data for an individual

Authorizations:
UserAuth

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

Get edd tracker entries for an org

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

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 2,
  • "fromDate": "2024-03-03",
  • "toDate": "2024-03-04",
  • "status": "PENDING"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": [
    ]
}

Update edd tracker entry

Update edd tracker entry

Authorizations:
UserAuth
Request Body schema: application/json
uuid
string
orgUserId
string
status
required
string

Responses

Request samples

Content type
application/json
{
  • "uuid": "4acc9473-e0cd-4106-b388-1d3e44dd86cf",
  • "orgUserId": "barbara_allen",
  • "status": "COMPLETED"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": "OK"
}

Fetch kyc files for an org and user

Fetch kyc files for an org and user

Authorizations:
UserAuth
Request Body schema: application/json
orgUserId
string

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "FUZE01234"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": [
    ]
}

Update kyc file for an org and user

Update kyc file for an org and user

Authorizations:
UserAuth
Request Body schema: application/json
orgUserId
string
uuid
string

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "FUZE01234",
  • "uuid": "f1a74abc-9d39-45fd-ab7c-cf816cba2e02"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": "OK"
}

Delete a kyc file for an org and user

Delete a kyc file for an org and user

Authorizations:
UserAuth
Request Body schema: application/json
orgUserId
string
uuid
string

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "FUZE01234",
  • "uuid": "f1a74abc-9d39-45fd-ab7c-cf816cba2e02"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": "OK"
}

custody

estimates the fee for a new transaction

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

Content type
application/json
{
  • "asset": "ETH",
  • "chain": "ETHEREUM"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "orgUserId": "string",
  • "asset": "ETH",
  • "chain": "ETHEREUM"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "orgUserId": "string",
  • "asset": "ETH",
  • "chain": "ETHEREUM",
  • "custodyType": "SEGREGATED",
  • "status": [
    ],
  • "entry": "DEPOSIT"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "orgUserId": "barbara_allen",
  • "transactionId": 11
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "orgUserId": "string",
  • "asset": "ETH",
  • "chain": "ETHEREUM"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

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

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

check if the address is valid

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

Content type
application/json
{
  • "address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
  • "chain": "ETHEREUM"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

finance

Gets all the accounts for the org

Gets all the accounts for the org

Authorizations:
UserAuth

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": [
    ]
}

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

Content type
application/json
{
  • "beneficiaryName": "Account1",
  • "bankName": "ENBD",
  • "bankCountry": "UAE",
  • "currency": "AED",
  • "accountNumber": "account1",
  • "transferDetails": "{swiftcode : \"swiftBank\"}"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "accountId": 10,
  • "txnId": "Txn1",
  • "amount": 1,
  • "transactionType": "DEPOSIT",
  • "currency": "AED",
  • "fundingAmount": 1,
  • "fundingCurrency": "AED"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": [
    ],
  • "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

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

Content type
application/json
{
  • "code": 200,
  • "data": [
    ],
  • "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

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "error": null
}

Gets all the fuze maintained accounts for the org

Gets all the fuze maintained accounts for the org

Authorizations:
UserAuth

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": [
    ]
}

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

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 2,
  • "fromDate": "2023-08-22",
  • "toDate": "2023-08-23",
  • "transactionType": "BUY",
  • "sort": "createdAt:DESC"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

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

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

Content type
application/json
{
  • "fromCurrency": "USD",
  • "toCurrency": "AED"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": 3,
  • "error": null
}

Cancels the transaction

Cancels the transaction

Authorizations:
UserAuth
Request Body schema: application/json
referenceId
string
transactionStatus
string
transactionType
string

Responses

Request samples

Content type
application/json
{
  • "referenceId": "asdf1234",
  • "transactionStatus": "CANCELED",
  • "transactionType": "DEPOSIT"
}

Response samples

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

Content type
application/json
{
  • "fromCurrency": "USD",
  • "fromAmount": 100,
  • "toCurrency": "AED",
  • "toAmount": 367
}

Response samples

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

Content type
application/json
{
  • "orgUserId": "barabara_allen",
  • "symbol": "ETH_AED",
  • "quoteQuantity": 1000,
  • "operation": "BUY",
  • "type": "MARKET",
  • "clientOrderId": "unique-uuid"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
Example
{
  • "orgUserId": "barabara_allen",
  • "symbol": "ETH_AED",
  • "quoteQuantity": 1000,
  • "operation": "BUY",
  • "type": "MARKET",
  • "clientOrderId": "unique-uuid"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

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

Content type
application/json
{
  • "code": 200,
  • "data": [
    ],
  • "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

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "error": null
}

generate a quote for the user

Returns the quote. (Requires WRITE permission on OTC.)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
orgUserId
string
symbol
string
operation
string
quantity
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "barabara_allen",
  • "symbol": "ETH_AED",
  • "operation": "BUY",
  • "quantity": 2
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 2,
  • "orderIds": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": [
    ],
  • "error": null
}

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

Content type
application/json
{
  • "targetOrgUuid": "ABC123123",
  • "currency": "USD",
  • "amount": 100,
  • "idempotencyKey": "asbasda",
  • "notes": "test test"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "fileName": "example.pdf",
  • "orgId": 1,
  • "entityName": "INVOICES"
}

Response samples

Content type
application/json
{}

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

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "reason": "Customer rejected the buy"
}

Response samples

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

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "orgUserId": "barabara_allen",
  • "symbol": "ETH_AED",
  • "quantity": 0.01,
  • "operation": "BUY",
  • "quoteId": "unique-uuid",
  • "invoiceId": "unique-uuid"
}

Response samples

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

Content type
application/json
{
  • "email": "test@test.com",
  • "name": "test"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "email": "test@test.com",
  • "name": "TESTNAME"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

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

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": [
    ]
}

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

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "name": "Property Name",
  • "businessName": "A123TZ456",
  • "beneficiaryName": "Beneficiary Name",
  • "bankName": "ENBD",
  • "bankCountry": "UAE",
  • "transferDetails": "{\"iban\": \"IBAN01234\"}"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": [
    ]
}

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

Content type
application/json
{
  • "targetOrgUuid": "ABC123123",
  • "currency": "USD",
  • "amount": 100,
  • "idempotencyKey": "asbasda",
  • "notes": "test test"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "error": null
}

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

Content type
application/json
{
  • "sourceOrgUserId": "barbara_allen",
  • "destinationOrgUserId": "barbara_allen_1",
  • "currency": "BTC",
  • "quantity": 0.01
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": "OK"
}

payments

Get invoice file from AWS S3 bucket

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

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "orgUserId": "admin@fuze.finance",
  • "policyName": "ASSET_EXPOSURE",
  • "parameters": { },
  • "action": "ACCEPT"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "orgUserId": "barbara_allen",
  • "policyName": "ASSET_EXPOSURE",
  • "action": "ACCEPT"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": [
    ]
}

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

Content type
application/json
{
  • "code": 200,
  • "data": [
    ]
}

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

Content type
application/json
{
  • "code": 200,
  • "data": {
    }
}

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

Content type
application/json
{
  • "code": 200,
  • "data": {
    }
}

report

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

Content type
application/json
{
  • "orgSettlementId": "95606754-8c6e-45b7-b7e4-1ae9ccffb31f",
  • "toJson": true,
  • "pageNumber": 0,
  • "pageSize": 50
}

Response samples

Content type
{
  • "code": 200,
  • "data": [
    ],
  • "error": null
}

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

Content type
application/json
{
  • "orgUserId": "admin@fuze.finance",
  • "policyName": "ORG_VAT",
  • "parameters": { },
  • "action": "ACCEPT"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {
    }
}

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

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 2,
  • "orgUserId": "*",
  • "sort": "createdAt:DESC"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": [
    ]
}

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

Content type
application/json
Example
{
  • "orgUserId": "barabara_allen",
  • "symbol": "ETH_AED",
  • "quoteQuantity": 1000,
  • "operation": "BUY",
  • "type": "MARKET",
  • "clientOrderId": "unique-uuid"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

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

Content type
application/json
{
  • "code": 200,
  • "data": [
    ],
  • "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

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 2,
  • "orderIds": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": [
    ],
  • "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

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "orgUserId": "barabara_allen",
  • "orderId": 1001
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{
  • "code": 200,
  • "data": {
    },
  • "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

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": {}
}