Fuze HQ
API docs by Redocly

Fuze Documentation (0.0.7)

Download OpenAPI specification:

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

Fuze Documentation

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
required
orgUserId
string
object

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
required
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
required
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
required
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
required
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
required
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
required
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
required
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 pnl of a user

Fetch pnl 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
required
orgUserId
string

Org user id

fromDate
string

date from which to fetch PnL

toDate
string

date till which to fetch PnL

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "johndoe123",
  • "fromDate": "2025-07-01",
  • "toDate": "2025-07-01"
}

Response samples

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

Fetch pnl chart of a user

Fetch pnl chart 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
required
orgUserId
string

Org user id

fromDate
string

date from which to fetch PnL

toDate
string

date till which to fetch PnL

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "johndoe123",
  • "fromDate": "2025-07-01",
  • "toDate": "2025-07-01"
}

Response samples

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

adcb

Get accounts for the user

Get accounts for the user. (Requires READWRITE permission for adcb)

Authorizations:
UserAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
object (GetAccountsBody)

Responses

Request samples

Content type
application/json
{ }

Response samples

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

Get default account for the user

Get default account for the user. (Requires READWRITE permission for adcb)

Authorizations:
UserAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
object (GetDefaultAccountBody)

Responses

Request samples

Content type
application/json
{ }

Response samples

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

initiate fund transfer for the user

initiate fund transfer for the user. (Requires READWRITE permission for adcb)

Authorizations:
UserAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
object (InitiateFundTransferBody)

Responses

Request samples

Content type
application/json
{ }

Response samples

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

signup for adcb user

signup for adcb user. (Requires READWRITE permission for adcb)

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

Responses

Response samples

Content type
application/json
{
  • "status": 403,
  • "message": "You're not authorized"
}

Edits tnc for a already present User

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

Authorizations:
UserAuth

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "data": null,
  • "error": "Invalid Request"
}

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
}

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

Responses

Response samples

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

Fetch balances of a adcb user

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

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
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 pnl of a user

Fetch pnl 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
required
orgUserId
string

Org user id

fromDate
string

date from which to fetch PnL

toDate
string

date till which to fetch PnL

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "johndoe123",
  • "fromDate": "2025-07-01",
  • "toDate": "2025-07-01"
}

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
required
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
}

Fetch RM verification status

Returns whether the given RM code is currently verified. Requires READ permission for the org. This does not perform verification; it only reports status.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
rmCode
string

Responses

Request samples

Content type
application/json
{
  • "rmCode": "RM123"
}

Response samples

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

watchlist

Fetch watchlists for a user

Fetch watchlists 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
required
orgUserId
required
string

Responses

Request samples

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

Response samples

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

Create watchlist for a user

Create watchlist for a user. (Requires READWRITE permission for User)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string
name
required
string
Array of objects or null (WatchlistItemDTO)

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "barabara_allen",
  • "name": "My Watchlist",
  • "watchlistItems": [
    ]
}

Response samples

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

Update watchlist for a user

Update watchlist for a user. (Requires READWRITE permission for User)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string
name
required
string
id
required
integer <int64>
Array of objects or null (WatchlistItemDTO)
Array of objects or null (WatchlistItemDTO)

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "barabara_allen",
  • "name": "Update Watchlist",
  • "id": 124,
  • "addWatchlistItems": [
    ],
  • "deleteWatchlistItems": [
    ]
}

Response samples

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

Delete watchlist for a user

Delete watchlist for a user. (Requires READWRITE permission for User)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string
name
string
id
required
integer <int64>
Array of objects or null (WatchlistItemDTO)

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "barabara_allen",
  • "name": "Update Watchlist",
  • "id": 124,
  • "watchlistItems": [
    ]
}

Response samples

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

Fetch watchlists for a user

Fetch watchlists 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
required
orgUserId
required
string

Responses

Request samples

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

Response samples

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

Create watchlist for a user

Create watchlist for a user. (Requires READWRITE permission for User)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string
name
required
string
Array of objects or null (WatchlistItemDTO)

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "barabara_allen",
  • "name": "My Watchlist",
  • "watchlistItems": [
    ]
}

Response samples

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

Update watchlist for a user

Update watchlist for a user. (Requires READWRITE permission for User)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string
name
required
string
id
required
integer <int64>
Array of objects or null (WatchlistItemDTO)
Array of objects or null (WatchlistItemDTO)

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "barabara_allen",
  • "name": "Update Watchlist",
  • "id": 124,
  • "addWatchlistItems": [
    ],
  • "deleteWatchlistItems": [
    ]
}

Response samples

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

Delete watchlist for a user

Delete watchlist for a user. (Requires READWRITE permission for User)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string
name
string
id
required
integer <int64>
Array of objects or null (WatchlistItemDTO)

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "barabara_allen",
  • "name": "Update Watchlist",
  • "id": 124,
  • "watchlistItems": [
    ]
}

Response samples

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

asset

Fetch news for your symbol

Get news for a given symbol. Requires READ permissions for Org. If no symbol is provided, gets news for all symbols active for the org.

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

Responses

Response samples

Content type
application/json
{}

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
}

Fetch news for your symbol

Get news for a given symbol. Requires READ permissions for Org. If no symbol is provided, gets news for all symbols active for the org.

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

Responses

Response samples

Content type
application/json
{}

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
required
access
required
integer

3 - READWRITE, 2 - WRITE, 1 - READ

expirySeconds
required
integer
ipWhitelist
Array of strings

Responses

Request samples

Content type
application/json
{
  • "access": 3,
  • "expirySeconds": 999999999999,
  • "ipWhitelist": [
    ]
}

Response samples

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

Responses

Request samples

Content type
application/json
{
  • "apiKey": "MCowDuMmyApiKey"
}

Response samples

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

List API key pairs

Requires READWRITE permission for APIKMS

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

Responses

Response samples

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

Responses

Request samples

Content type
application/json
{
  • "apiKey": "MCowDuMmyApiKey"
}

Response samples

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
required
apiKey
required
string

Responses

Request samples

Content type
application/json
{
  • "apiKey": "MCowDuMmyApiKey"
}

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
}

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
required
orgUserId
string
name
string
type
string

Responses

Request samples

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

Response samples

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

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
required
thirdPartyUuid
string
accountNumner
string
bankSwiftCode
string
iban
string
bankCode
string
currency
string
paymentMethod
string

Responses

Request samples

Content type
application/json
{
  • "thirdPartyUuid": "aasdasd-asdasd-asdads",
  • "accountNumner": "123123",
  • "bankSwiftCode": "ABCDXXXXXX",
  • "iban": "AE12314ADA312312",
  • "bankCode": "002",
  • "currency": "AED",
  • "paymentMethod": "SWIFT"
}

Response samples

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

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
required
clientIdentifier
required
string

Unique identifier for the client

asset
required
string

Asset for the wallet

nickname
required
string

Nickname for the wallet

address
required
string

Wallet address of the external party

chain
required
string

Blockchain for the wallet

memo
string

Memo for the wallet

walletType
required
string
Enum: "CUSTODIAL" "DECENTRALIZED"

Type of the wallet

vaspDid
string
vaspName
string
vaspWebsite
string
required
Self Declaration Proof (object) or Cryptographic Signature Proof (object) or No Ownership Proof (object) or Screenshot Proof (object) (WalletOwnershipProof)
walletPurpose
required
string
Enum: "DEPOSIT" "WITHDRAWAL"

Responses

Request samples

Content type
application/json
{
  • "clientIdentifier": "sherlock_holmes",
  • "asset": "ETH",
  • "nickname": "nickname",
  • "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f4sk",
  • "chain": "ETHEREUM",
  • "memo": "memo",
  • "walletType": "DECENTRALIZED",
  • "vaspDid": "did:ethr:0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
  • "vaspName": "vasp-name",
  • "vaspWebsite": "https://vasp.website",
  • "ownershipProof": {
    },
  • "walletPurpose": "WITHDRAWAL"
}

Response samples

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

base

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
required
pageNumber
integer <int32>
pageSize
integer <int32>
fromDate
string <date>
toDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 1,
  • "fromDate": "2023-03-02",
  • "toDate": "2023-03-02"
}

Response samples

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

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
required
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": {
    }
}

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
required
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": {
    }
}

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

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

update external wallet

updates an external wallet of a user by its id

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

id which needs to be updated

header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number

Responses

Response samples

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
required
address
string
asset
string
chain
string
memo
string

Responses

Request samples

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

Response samples

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

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
required
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
required
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
required
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": [
    ]
}

Gets all the fuze target accounts for the org

Gets all the fuze target 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
required
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
required
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
required
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
required
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
required
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"
}

kyc

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
required
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
required
orgUserId
string

Responses

Request samples

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

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
required
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
required
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
required
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
required
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
required
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"
}

Get Kyc Form(s) status for an entity

Kyc Form(s) would help you understand the entity's KYC lifecycle journey. The output gives a verbose description of the status of each KYC form that is associated to the entity, corresponding status & pending steps.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
entityType
string
Value: "Users"
entityId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "entityType": "Users",
  • "entityId": 12
}

Response samples

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

Get details for a specific KYC Form

@summary Get details for a specific KYC Form

Authorizations:
ApiKeyAuth

Responses

Response samples

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

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
required
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
Value: "MARKET"
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
}

oauth

Generate OAuth Access Token

Returns an accessToken for the given clientId, clientSecret and scope.

Authorizations:
JWT
Request Body schema: -
required
grantType
required
string
Value: "client_credentials"

The OAuth 2.0 grant type. Must be client_credentials.

clientId
required
string

The client ID issued to the client during the registration process.

clientSecret
required
string

The client secret issued to the client during the registration process.

scope
string

The scope of the access token to be requested. Space separated MODULE:PERMISSION values (eg. <module_1>:<permission_1> <module_2>:<permission_2> ... <module_n>:<permission_n>)

Responses

Response samples

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

Test oauth endpoint

Echoes back the request body if oauth middleware is successful

Authorizations:
JWT

Responses

Response samples

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

User

WebhookOpenLoopUser

One of
required
object
required
object
Example
{
  • "event": {
    },
  • "data": {
    }
}

Create user

Create a user for the organisation.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
One of
orgUserId
required
string

Unique identifier of the user. This will be used to identify the user in the system.

userType
required
string
Value: "INTERNAL"

Type of the user.

Responses

Request samples

Content type
application/json
Example
{
  • "orgUserId": "sherlock_holmes",
  • "userType": "INTERNAL"
}

Response samples

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

Get user

Get a user for the organisation.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

Responses

Request samples

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

Response samples

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

List users

List users for the organisation.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
pageNumber
number

Page number for pagination.

pageSize
number

Number of entries to be returned in one paginated response.

orgUserId
string

Unique identifier of the user.

email
string

Email of the user.

userType
string
Enum: "CONSUMER" "INTERNAL"

Type of the user.

userStatus
string
Enum: "PENDING" "ACTIVE" "INACTIVE" "DELETED"

Status of the user.

Responses

Request samples

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 10,
  • "orgUserId": "sherlock_holmes",
  • "email": "sherlockholmes@baker.st",
  • "userType": "CONSUMER",
  • "userStatus": "ACTIVE"
}

Response samples

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

Get user balance

Get balance across all the currencies for a user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

Responses

Request samples

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

Response samples

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

Update EDD tracker

Update the EDD tracker for a user. This is used to track the progress of EDD for a user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

status
required
string
Enum: "PENDING" "COMPLETED"

Status of the EDD tracker.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "status": "COMPLETED"
}

Response samples

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

Get user PnL

Get user PnL.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

fromDate
string

Start date from which to fetch PnL.

toDate
string

End date until which to fetch PnL.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "fromDate": "2025-07-01",
  • "toDate": "2025-07-01"
}

Response samples

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

Counter Party

Create counter-party

Create a counter-party for a user. This counter-party will be used to create accounts and wallets.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

counterPartyId
required
string

Unique identifier of the counterparty. This will be used to identify the counterparty in the system.

name
required
string

Name of the counterparty.

email
required
string

Email of the counterparty.

type
required
string
Enum: "FIRST_PARTY" "THIRD_PARTY"

Type of the counter party.

required
object

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000",
  • "name": "Sherlock Holmes",
  • "email": "sherlockholmes@baker.st",
  • "type": "FIRST_PARTY",
  • "kycData": {
    }
}

Response samples

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

Get counter-party

Get a counter-party for a user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

counterPartyId
required
string

Unique identifier of the counterparty.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000"
}

Response samples

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

List counter-parties

List counter-parties for a user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

type
string
Enum: "FIRST_PARTY" "THIRD_PARTY"

Type of the counter party.

status
string
Enum: "ACTIVE" "INACTIVE" "PENDING" "ON_HOLD"

Status of the counterparty.

email
string

Email of the counterparty.

counterPartyId
string

Unique identifier of the counterparty.

pageNumber
number

Page number for pagination.

pageSize
number

Number of entries to be returned in one paginated response.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "type": "FIRST_PARTY",
  • "status": "ACTIVE",
  • "email": "sherlockholmes@baker.st",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000",
  • "pageNumber": 1,
  • "pageSize": 10
}

Response samples

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

Account

WebhookOpenLoopAccount

One of
required
object
required
object
Example
{
  • "event": {
    },
  • "data": {
    }
}

List account currencies

List supported fiat currencies for creating accounts.

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 internal account

Create an internal account for a user. The account will be used to deposit fiat funds for the user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

required
object

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "accountDetails": {
    }
}

Response samples

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

Create external account

Create an external account for a user's counter-party. The account will be used to withdraw fiat funds for the user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

counterPartyId
required
string

Unique identifier of the counterparty.

required
object

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000",
  • "accountDetails": {
    }
}

Response samples

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

Get account

Get an account for a user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

accountId
required
string

Unique identifier of the account.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "accountId": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

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

List accounts

List accounts for a user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

counterPartyId
string

Unique identifier of the counterparty.

accountId
string

Unique identifier of the account.

currency
string

Currency of the account.

accountType
string
Enum: "INTERNAL" "EXTERNAL"

Type of the account.

pageNumber
number

Page number for pagination.

pageSize
number

Number of entries to be returned in one paginated response.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000",
  • "accountId": "123e4567-e89b-12d3-a456-426614174000",
  • "currency": "USD",
  • "accountType": "INTERNAL",
  • "pageNumber": 1,
  • "pageSize": 10
}

Response samples

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

Wallet

WebhookOpenLoopWallet

One of
required
object
required
object
Example
{
  • "event": {
    },
  • "data": {
    }
}

List wallet currencies

List supported crypto currencies for creating wallets.

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 internal wallet

Create an internal wallet for a user or a user's counter-party. The wallet will be used to deposit crypto funds for the user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

counterPartyId
string or null

Unique identifier of the counterparty.

required
object

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000",
  • "walletDetails": {
    }
}

Response samples

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

Create external wallet

Create an external wallet for a user's counter-party. The wallet will be used to deposit or withdraw crypto funds for the user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

counterPartyId
required
string

Unique identifier of the counterparty.

purpose
required
string
Enum: "DEPOSIT_SOURCE" "WITHDRAWAL"

Use DEPOSIT_SOURCE for whitelisting wallets to receive funds and WITHDRAWAL for whitelisting wallets to withdraw funds.

required
object

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000",
  • "purpose": "WITHDRAWAL",
  • "walletDetails": {
    }
}

Response samples

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

Get wallet

Get a wallet (internal or external) for a user. Requires READ permission for OpenLoop.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

walletId
required
string

Unique identifier of the wallet.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "walletId": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

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

List wallets

List wallets for a user. This unified endpoint replaces the separate internal and external wallet list endpoints. Use walletType parameter to filter by internal/external wallets.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

counterPartyId
string or null

Unique identifier of the counterparty.

walletId
string

Unique identifier of the wallet.

currency
string

Currency of the wallet.

chain
string

Blockchain of the wallet.

walletType
string
Enum: "INTERNAL" "EXTERNAL"

Type of the wallet to filter by.

pageNumber
number

Page number for pagination.

pageSize
number

Number of entries to be returned in one paginated response.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000",
  • "walletId": "123e4567-ea9b-12d3-a456-426614174000",
  • "currency": "USDC",
  • "chain": "ETHEREUM",
  • "walletType": "INTERNAL",
  • "pageNumber": 0,
  • "pageSize": 50
}

Response samples

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

Price

Get current price

Get the current price for a symbol. This endpoint is used to get the conversion rate between fiat and crypto currencies.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
symbol
required
string

The trading pair symbol for the price. It is always in the format of "BASE_QUOTE", where BASE is the crypto currency and QUOTE is the fiat currency.

Responses

Request samples

Content type
application/json
{
  • "symbol": "USDC_USD"
}

Response samples

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

List historical prices

List historical prices for a symbol. This endpoint is used to get the conversion rates between fiat and crypto currencies over a period of time.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
symbol
required
string

The trading pair symbol for the price. It is always in the format of "BASE_QUOTE", where BASE is the crypto currency and QUOTE is the fiat currency.

fromTimestampInSecs
required
number

The start time in seconds since epoch for the historical prices.

toTimestampInSecs
required
number

The end time in seconds since epoch for the historical prices.

timeBucketInSecs
required
number

The time bucket in seconds for the historical prices.

Responses

Request samples

Content type
application/json
{
  • "symbol": "USDC_USD",
  • "fromTimestampInSecs": 1696147200000,
  • "toTimestampInSecs": 1696233600000,
  • "timeBucketInSecs": 3600
}

Response samples

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

Order

Create quote

Create a quote for a fiat-to-crypto (BUY operation) or crypto-to-fiat (SELL operation).

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
One of
orgUserId
required
string

Unique identifier of the user.

symbol
required
string

The trading pair symbol for the quote. It is always in the format of "BASE_QUOTE", where BASE is the crypto currency and QUOTE is the fiat currency.

operation
required
string
Enum: "BUY" "SELL"

The operation type for the quote.

quantity
required
number

The crypto amount for the quote.

Responses

Request samples

Content type
application/json
Example
{
  • "orgUserId": "sherlock_holmes",
  • "symbol": "USDC_USD",
  • "operation": "BUY",
  • "quantity": 100
}

Response samples

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

Create order

Create an order for a user. This endpoint supports different kinds of orders.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
Any of
orgUserId
required
string

Unique identifier of the user.

clientOrderId
string

Unique identifier for the order. This is used to map an order in the client's system to that in Fuze.

symbol
required
string

The trading pair symbol for the quote. It is always in the format of "BASE_QUOTE", where BASE is the crypto currency and QUOTE is the fiat currency.

operation
required
string
Enum: "BUY" "SELL"

The operation type for the order.

type
required
string
Value: "RFQ"

The type of the order.

quantity
number

The crypto amount for the order.

quoteQuantity
number

The fiat amount for the order.

quoteId
required
number

The unique identifier of the quote. This will be generated when the quote is created.

Responses

Request samples

Content type
application/json
Example
{
  • "orgUserId": "sherlock_holmes",
  • "clientOrderId": "order_123456",
  • "symbol": "USDC_USD",
  • "operation": "BUY",
  • "type": "RFQ",
  • "quantity": 100,
  • "quoteQuantity": 101,
  • "quoteId": 123456
}

Response samples

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

Cancel order

Cancel an order for a user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

orderId
required
number

The unique identifier of the order to be cancelled.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "orderId": 123456
}

Response samples

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

Get order

Get an order for a user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

orderId
required
number

The unique identifier of the order.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "orderId": 123456
}

Response samples

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

List orders

List orders for a user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

Unique identifier of the user.

status
string
Enum: "OPEN" "COMPLETED" "CANCELLED" "REJECTED"

Status of the order.

pageNumber
required
integer <int32>
pageSize
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "status": "OPEN",
  • "pageNumber": 1,
  • "pageSize": 10
}

Response samples

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

Transfer

WebhookOpenLoopUserTxn

One of
required
object
required
object
Example
{
  • "event": {
    },
  • "data": {
    }
}

Create internal transfer

Create an internal transfer between two users of the same organisation.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
transferId
string

The ID of the transfer. This will be used to identify the transfer in the system.

required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "transferId": "123e4567-ea9b-12d3-a456-426614174000",
  • "from": {
    },
  • "to": {
    }
}

Response samples

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

Create external transfer

Create an external fiat transfer (withdrawal to an external account) or crypto transfer (withdrawal to an external wallet) for a user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
One of
required
object
required
object
transferId
string

The ID of the transfer.

Responses

Request samples

Content type
application/json
Example
{
  • "from": {
    },
  • "to": {
    },
  • "transferId": "123e4567-ea9b-12d3-a456-426614174000"
}

Response samples

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

Get a transfer

Get a transfer for a user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

The ID of the user in the organization.

currency
required
string

The currency of the transfer.

transferId
required
string

The ID of the transfer.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "currency": "USDC",
  • "transferId": "123e4567-ea9b-12d3-a456-426614174000"
}

Response samples

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

List transfers

List transfers for a user.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
orgUserId
required
string

The ID of the user in the organization.

currency
required
string

The currency of the transfer.

transferId
string

The ID of the transfer.

pageNumber
integer <int32>
pageSize
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "currency": "USDC",
  • "transferId": "123e4567-ea9b-12d3-a456-426614174000",
  • "pageNumber": 1,
  • "pageSize": 10
}

Response samples

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

Payment

List currencies

List supported crypto currencies for payments.

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

Responses

Response samples

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

Webhook

Upsert webhook for an organisation

Upsert webhook for an organisation. Requires READWRITE permission for OpenLoop.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
url
required
string
secret
required
string

Responses

Request samples

Content type
application/json
{}

Response samples

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

Get all webhooks for an organisation

Get webhook for an organisation. Requires READ permission for OpenLoop.

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

Responses

Response samples

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

Miscellaneous

List countries

List supported countries.

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

Responses

Response samples

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

List assets

List supported crypto assets.

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

Responses

Response samples

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

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
required
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
Value: "MARKET"
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
required
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. 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
required
One of
quantity
required
number
orgUserId
string
symbol
string
operation
string

Responses

Request samples

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

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
required
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
}

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
required
pageNumber
integer <int32>
pageSize
integer <int32>
fromDate
string <date>
toDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 1,
  • "fromDate": "2023-03-02",
  • "toDate": "2023-03-02"
}

Response samples

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

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
required
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
}

Email payment gateway report for an org

Sends payment gateway report for an org via email. (Requires READ permissions on report)

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
from
required
string
to
required
string
type
required
string
emailIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "from": "2025-07-14",
  • "to": "2025-07-17",
  • "type": "PAYIN",
  • "emailIds": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "error": null,
  • "data": "Payment gateway payout report generated and sent successfully"
}

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
required
from
string
to
string
orgUserId
string
orgId
integer

Responses

Request samples

Content type
application/json
{
  • "from": "2023-05-01",
  • "to": "2023-05-31",
  • "orgUserId": "user_1",
  • "orgId": 135
}

Response samples

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
required
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
required
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
{}

Generate download link for an invoice file

Generate download link for an invoice file

Authorizations:
UserAuth
Request Body schema: application/json
required
invoiceId
required
number <int32>

Responses

Request samples

Content type
application/json
{
  • "invoiceId": 1
}

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
required
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
required
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"
}

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": {
    }
}

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": {
    }
}

Fetch conversion rate for a currency pair.

Fetch conversion rate for a currency pair. (Requires READWRITE permission for Payment)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
symbol
required
string
operation
required
string
Enum: "BUY" "SELL"
product
string
Value: "PAYMENTS"

Responses

Request samples

Content type
application/json
{
  • "symbol": "BTC_AED",
  • "operation": "BUY",
  • "product": "PAYMENTS"
}

Response samples

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

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
required
email
required
string
type
required
string
Enum: "FIRST_PARTY" "THIRD_PARTY"
clientIdentifier
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "email": "sherlockholmes@baker.st",
  • "type": "THIRD_PARTY",
  • "clientIdentifier": "SH123456",
  • "kycData": {
    }
}

Response samples

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

Update third-party for payment gateway (used for updating KYC data for existing third-party)

Update 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
required
clientIdentifier
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "clientIdentifier": "SH123456",
  • "kycData": {
    }
}

Response samples

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

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
required
clientIdentifier
required
string

Responses

Request samples

Content type
application/json
{
  • "clientIdentifier": "SH123456"
}

Response samples

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

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
required
pageNumber
integer <int32>
pageSize
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 1
}

Response samples

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

Generate upload link to upload kyc-files

Generate upload link to upload kyc-files. (Requires READWRITE permission for Payment)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
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
{}

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
required
clientIdentifier
required
string
symbol
required
string
chain
required
string

Responses

Request samples

Content type
application/json
{
  • "clientIdentifier": "sherlockholmes",
  • "symbol": "USDC_AED",
  • "chain": "ETHEREUM"
}

Response samples

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

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

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

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
required
clientIdentifier
required
string
symbol
required
string
chain
required
number
quantity
required
number
clientOrderId
string

Responses

Request samples

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

Response samples

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

Responses

Request samples

Content type
application/json
{
  • "clientOrderId": "SH123456"
}

Response samples

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

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 1,
  • "fromDate": "2023-03-02",
  • "toDate": "2023-03-02",
  • "status": "KYC_PENDING"
}

Response samples

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

Unique identifier for the client

symbol
required
string

Symbol for the payout

quantity
number

Quantity for the payout

quoteQuantity
number

Quote quantity for the payout

clientOrderId
string

Unique identifier for the payout

address
required
string

Wallet address of the external party

chain
required
string

Blockchain for the wallet

memo
string

Memo for the wallet

walletType
required
string
Enum: "CUSTODIAL" "DECENTRALIZED"

Type of the wallet

vaspDid
string
vaspName
string
vaspWebsite
string
required
Self Declaration Proof (object) or Cryptographic Signature Proof (object) or No Ownership Proof (object) or Screenshot Proof (object) (WalletOwnershipProof)

Responses

Request samples

Content type
application/json
{
  • "clientIdentifier": "sherlock_holmes",
  • "symbol": "USDC_USD",
  • "quantity": 123.45,
  • "quoteQuantity": 123.45,
  • "clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f",
  • "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f4sk",
  • "chain": "ETHEREUM",
  • "memo": "memo",
  • "walletType": "DECENTRALIZED",
  • "vaspDid": "did:ethr:0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
  • "vaspName": "vasp-name",
  • "vaspWebsite": "https://vasp.website",
  • "ownershipProof": {
    }
}

Response samples

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
required
clientOrderId
required
string

Responses

Request samples

Content type
application/json
{
  • "clientOrderId": "SH123456"
}

Response samples

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
required
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

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 1,
  • "fromDate": "2023-03-02",
  • "toDate": "2023-03-02",
  • "status": "KYC_PENDING"
}

Response samples

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

Responses

Request samples

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

Response samples

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

Whitelist wallet

Whitelist a wallet for deposit.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
clientIdentifier
required
string

The client identifier of the end-user or third party.

address
required
string

Blockchain wallet address to whitelist.

memo
string

Optional memo or tag associated with the wallet address.

chain
required
string

Blockchain network chain of the wallet address.

asset
required
string

Cryptocurrency asset of the wallet address.

nickname
string

Optional nickname for the whitelisted wallet.

walletType
required
string
Enum: "DECENTRALIZED" "CUSTODIAL"

Type of the wallet (e.g., DECENTRALIZED, CUSTODIAL).

vaspDid
string

Optional VASP DID associated with the wallet.

vaspName
string

Optional VASP name associated with the wallet.

vaspWebsite
string

Optional VASP website URL associated with the wallet.

required
Self Declaration Proof (object) or Cryptographic Signature Proof (object) or No Ownership Proof (object) or Screenshot Proof (object) (WalletOwnershipProof)

Responses

Request samples

Content type
application/json
{
  • "clientIdentifier": "sherlockholmes2212",
  • "address": "0xb35E6371A047206a7C08A649f387CbAA3d949410",
  • "memo": "memo",
  • "chain": "ETHEREUM",
  • "asset": "ETH",
  • "nickname": "My Wallet",
  • "walletType": "DECENTRALIZED",
  • "vaspDid": "did:example:123456789abcdefghi",
  • "vaspName": "Example VASP",
  • "vaspWebsite": "https://vasp.example.com",
  • "ownershipProof": {
    }
}

Response samples

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

Get list of VASPs

Get list of Virtual Asset Service Providers (VASPs). Can be filtered by request query param. (Requires READ permission for Payment)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
query
string

Responses

Request samples

Content type
application/json
{
  • "query": "abinance"
}

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
required
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"
}

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
required
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
required
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.

Authorizations:
PublicAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
symbol
string
side
string
quantity
number or null
quoteQuantity
number or null

Responses

Request samples

Content type
application/json
{
  • "symbol": "BTC_USD",
  • "side": "BUY",
  • "quantity": 1,
  • "quoteQuantity": 1
}

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": {
    }
}

PaymentGateway

Fetches transactions made on the payment link.

Fetches transactions made on the payment link.

Authorizations:
PublicAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
uuid
required
string <uuid> <= 128 characters

UUID of the public payment link.

Responses

Request samples

Content type
application/json
{
  • "uuid": "793da5d5-b971-4d55-af84-3a40fee24e6e"
}

Response samples

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

Selects asset details for a payment link

Selects asset details for a payment link

Authorizations:
PublicAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
uuid
required
string <uuid> <= 128 characters

UUID of the public payment link.

asset
string

The cryptocurrency asset using which the payment would be made.

chain
string

The blockchain network chain for the asset.

Responses

Request samples

Content type
application/json
{
  • "uuid": "793da5d5-b971-4d55-af84-3a40fee24e6e",
  • "asset": "ETH",
  • "chain": "ETHEREUM"
}

Response samples

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

Returns the quote for a public payment link.

Returns the quote for a public payment link using the provided UUID.

Authorizations:
PublicAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
uuid
required
string <uuid> <= 128 characters

UUID of the public payment link.

Responses

Request samples

Content type
application/json
{
  • "uuid": "793da5d5-b971-4d55-af84-3a40fee24e6e"
}

Response samples

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

Fetch merchant profile for payment links.

Fetch merchant display image, name and support email for a payment link.

Authorizations:
PublicAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
uuid
required
string <uuid> <= 128 characters

UUID of the public payment link.

Responses

Request samples

Content type
application/json
{
  • "uuid": "793da5d5-b971-4d55-af84-3a40fee24e6e"
}

Response samples

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

Create a third party.

Create a third party. (Requires READWRITE permission for PaymentGateway)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
email
string

Email of third party.

clientIdentifier
string

The client identifier of the third party.

object

Responses

Request samples

Content type
application/json
{
  • "email": "sherlockholmes@baker.st",
  • "clientIdentifier": "sherlock_holmes",
  • "kycData": {
    }
}

Response samples

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

Get list of payins for a payment link

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

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
uuid
string

UUID of payment link.

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

Content type
application/json
{
  • "uuid": "ff3f899e-04a9-48a0-81e3-547ec5c03a42",
  • "pageNumber": 1,
  • "pageSize": 1,
  • "fromDate": "2023-03-02",
  • "toDate": "2023-03-02",
  • "status": "KYC_PENDING"
}

Response samples

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

Generate upload link to upload invoice.

Generate upload link to upload invoice for payment links. (Requires READWRITE permission for PaymentGateway)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
fileName
required
string <= 256 characters

Name of the file to be uploaded.

Responses

Request samples

Content type
application/json
{
  • "fileName": "identity_front.jpeg"
}

Response samples

Content type
application/json
{}

Update merchant profile for payment links

Update merchant display image or name for payment links. (Requires READWRITE permission for PaymentGateway)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string

Request signature for authentication

X-TIMESTAMP
required
number

Epoch timestamp for request validation

Request Body schema: application/json
required
displayImageUuid
string <uuid> <= 128 characters

Optional UUID of the uploaded display image.

merchantName
string <= 128 characters

Optional merchant name to update.

supportEmail
string <= 128 characters

Optional support email of the merchant.

Responses

Request samples

Content type
application/json
{
  • "displayImageUuid": "9f1c88f2-4f4d-4d85-a7b8-0a3b15b0b6ab",
  • "merchantName": "Acme Corp",
  • "supportEmail": "support@email.com"
}

Response samples

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

Fetch merchant profile for payment links

Fetch merchant display image, name and for payment links. (Requires READWRITE permission for PaymentGateway)

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string

Request signature for authentication

X-TIMESTAMP
required
number

Epoch timestamp for request validation

Responses

Response samples

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

public-rfi

Get RFI form UI config

Retrieves the UI configuration for an RFI form by UUID for public access

Authorizations:
JWT
path Parameters
uuid
required
string

Form UUID

Responses

Save RFI form progress

Saves the current progress of an RFI form for public access

Authorizations:
JWT
Request Body schema: application/json
required
Schema not provided

Responses

Submit RFI form

Submits a completed RFI form for public access

Authorizations:
JWT
Request Body schema: application/json
required
Schema not provided

Responses

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
required
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
required
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
required
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
Value: "MARKET"
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
required
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
required
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

Upsert webhook for an organisation.

Upsert webhook for an organisation. Requires READWRITE permission for Webhook.

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
url
required
string
secret
required
string

Responses

Request samples

Content type
application/json
{}

Response samples

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

Get all webhooks for an organisation.

Get webhook for an organisation. Requires READ permission for Webhook.

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

Responses

Response samples

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

b2b-payment

Get user balance

Get balances for all fiat currencies and stablecoins held by a user(aka sub-account).

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

Unique identifier of the user within the organization.

Responses

Request samples

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

Response samples

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

List counter parties

List all counter parties for the user(aka sub-account)

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

Unique identifier of the user.

type
string
Enum: "FIRST_PARTY" "THIRD_PARTY"

Type of the counter party.

status
string
Enum: "ACTIVE" "INACTIVE" "PENDING" "ON_HOLD"

Status of the counterparty.

email
string

Email of the counterparty.

counterPartyId
string

Unique identifier of the counterparty.

pageNumber
number

Page number for pagination.

pageSize
number

Number of entries to be returned in one paginated response.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "type": "FIRST_PARTY",
  • "status": "ACTIVE",
  • "email": "sherlockholmes@baker.st",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000",
  • "pageNumber": 1,
  • "pageSize": 10
}

Response samples

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

Create counter party

Create a counter-party for a user(aka sub-account). This counter-party will be used to create accounts and wallets.

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

Unique identifier of the user.

counterPartyId
required
string

Unique identifier of the counterparty. This will be used to identify the counterparty in the system.

name
required
string

Name of the counterparty.

email
required
string

Email of the counterparty.

type
required
string
Enum: "FIRST_PARTY" "THIRD_PARTY"

Type of the counter party.

required
object

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000",
  • "name": "Sherlock Holmes",
  • "email": "sherlockholmes@baker.st",
  • "type": "FIRST_PARTY",
  • "kycData": {
    }
}

Response samples

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

Get counter party

Get a counter-party for a user(aka sub-account).

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

Unique identifier of the user.

counterPartyId
required
string

Unique identifier of the counterparty.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000"
}

Response samples

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

List accounts

List all accounts (internal and external) for the user(aka sub-account). Use accountType parameter to filter by INTERNAL or EXTERNAL accounts.

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

Unique identifier of the user.

counterPartyId
string

Unique identifier of the counterparty.

accountId
string

Unique identifier of the account.

currency
string

Currency of the account.

accountType
string
Enum: "INTERNAL" "EXTERNAL"

Type of the account.

pageNumber
number

Page number for pagination.

pageSize
number

Number of entries to be returned in one paginated response.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000",
  • "accountId": "123e4567-e89b-12d3-a456-426614174000",
  • "currency": "USD",
  • "accountType": "INTERNAL",
  • "pageNumber": 1,
  • "pageSize": 10
}

Response samples

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

List orders

List all orders for the user(aka sub-account)

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

Unique identifier of the user.

status
string
Enum: "OPEN" "COMPLETED" "CANCELLED" "REJECTED"

Status of the order.

pageNumber
required
integer <int32>
pageSize
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "status": "OPEN",
  • "pageNumber": 1,
  • "pageSize": 10
}

Response samples

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

List transfers

List all transfers for the user(aka sub-account)

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

The ID of the user in the organization.

currency
required
string

The currency of the transfer.

transferId
string

The ID of the transfer.

pageNumber
integer <int32>
pageSize
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "currency": "USDC",
  • "transferId": "123e4567-ea9b-12d3-a456-426614174000",
  • "pageNumber": 1,
  • "pageSize": 10
}

Response samples

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

List users

List all users(aka sub-accounts) for the organisation

Authorizations:
UserAuth
Request Body schema: application/json
pageNumber
number

Page number for pagination.

pageSize
number

Number of entries to be returned in one paginated response.

orgUserId
string

Unique identifier of the user.

email
string

Email of the user.

userType
string
Enum: "CONSUMER" "INTERNAL"

Type of the user.

userStatus
string
Enum: "PENDING" "ACTIVE" "INACTIVE" "DELETED"

Status of the user.

Responses

Request samples

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 10,
  • "orgUserId": "sherlock_holmes",
  • "email": "sherlockholmes@baker.st",
  • "userType": "CONSUMER",
  • "userStatus": "ACTIVE"
}

Response samples

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

List wallets

List all wallets (internal and external) for the user(aka sub-account). Use walletType parameter to filter by INTERNAL or EXTERNAL wallets

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

Unique identifier of the user.

counterPartyId
string or null

Unique identifier of the counterparty.

walletId
string

Unique identifier of the wallet.

currency
string

Currency of the wallet.

chain
string

Blockchain of the wallet.

walletType
string
Enum: "INTERNAL" "EXTERNAL"

Type of the wallet to filter by.

pageNumber
number

Page number for pagination.

pageSize
number

Number of entries to be returned in one paginated response.

Responses

Request samples

Content type
application/json
{
  • "orgUserId": "sherlock_holmes",
  • "counterPartyId": "123e4567-ea9b-12d3-a456-426614174000",
  • "walletId": "123e4567-ea9b-12d3-a456-426614174000",
  • "currency": "USDC",
  • "chain": "ETHEREUM",
  • "walletType": "INTERNAL",
  • "pageNumber": 0,
  • "pageSize": 50
}

Response samples

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

Third Party

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
required
name
string
email
string
address
string
nationality
string
country
string
idType
string
idNumber
string
type
string
clientIdentifier
string

Responses

Request samples

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

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

Create third-party with a beneficiary account for remittance

Create third-party with a 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
required
name
string
email
string
address
string
nationality
string
country
string
idType
string
idNumber
string
type
string
clientIdentifier
string
object

Responses

Request samples

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": {
    }
}

Response samples

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

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
required
pageNumber
integer <int32>
pageSize
integer <int32>
search
string

Responses

Request samples

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 1,
  • "search": "Nick"
}

Response samples

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

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
required
clientIdentifier
required
string

Responses

Request samples

Content type
application/json
{
  • "clientIdentifier": "SH123456"
}

Response samples

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

Create third party account

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
required
clientIdentifier
string
object
currency
string
country
string
accountType
string

Responses

Request samples

Content type
application/json
{
  • "clientIdentifier": "NICK123456",
  • "accountData": {
    },
  • "currency": "USD",
  • "country": "UK",
  • "accountType": "BANK"
}

Response samples

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

Delete third party account

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
required
clientIdentifier
required
string

Responses

Request samples

Content type
application/json
{
  • "clientIdentifier": "SH123456"
}

Response samples

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

Beneficiary

Get third-party account

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
required
clientIdentifier
required
string

Responses

Request samples

Content type
application/json
{
  • "clientIdentifier": "SH123456"
}

Response samples

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

Verify beneficiary

Verify beneficiary for remittance

Authorizations:
OAuth2
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
receiverClientIdentifier
required
string
currency
required
string
Value: "INR"
accountType
required
string
Value: "BANK"
country
required
string
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "receiverClientIdentifier": "RECEIVER_OCT_INR_4",
  • "currency": "INR",
  • "accountType": "BANK",
  • "country": "IN",
  • "accountData": {
    }
}

Response samples

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

Conversion

Create quote

Create quote for remittance for a third party

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
quantity
required
number
fromCurrency
required
string
toCurrency
required
string
orgUserId
required
string

Responses

Request samples

Content type
application/json
{
  • "quantity": 100,
  • "fromCurrency": "AED",
  • "toCurrency": "INR",
  • "orgUserId": "org-user"
}

Response samples

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

Create order

Create payment for remittance quote

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
quantity
required
number
quoteId
required
number
orgUserId
required
string

Responses

Request samples

Content type
application/json
{
  • "quantity": 100,
  • "quoteId": 2,
  • "orgUserId": "org-user"
}

Response samples

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

Get order details

Get payment details for remittance quote

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
uuid
required
string

Responses

Request samples

Content type
application/json
{
  • "uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f\""
}

Response samples

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

Payout

Create third party payout

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
required
currency
string
amount
number
clientOrderId
string
uuid
string
purpose
string

Responses

Request samples

Content type
application/json
{
  • "currency": "INR",
  • "amount": 100,
  • "clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f",
  • "uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
  • "purpose": "SALARY"
}

Response samples

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

Create payout

Create a payout with beneficiary details

Authorizations:
ApiKeyAuth
header Parameters
X-SIGNATURE
required
string
X-TIMESTAMP
required
number
Request Body schema: application/json
required
One of
email
string
name
required
string
address
required
string
nationality
required
string
idType
required
string
idNumber
required
string
senderClientIdentifier
required
string
country
required
string
dob
required
string <date>
clientOrderId
required
string
amount
required
number
purpose
required
string
required
object

Responses

Request samples

Content type
application/json
Example
{
  • "email": "test@test.com",
  • "name": "test",
  • "address": "1-A, Baker's street",
  • "nationality": "INDIAN",
  • "idType": "EID",
  • "idNumber": "123456",
  • "senderClientIdentifier": "DIRECT_REMIT_SENDER_1",
  • "country": "AE",
  • "dob": "1990-09-09",
  • "clientOrderId": "DIRECT_REMIT_1",
  • "amount": 10,
  • "purpose": "SALARY",
  • "account": {
    }
}

Response samples

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

Get payout list

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
required
pageNumber
integer <int32>
pageSize
integer <int32>
search
string
currency
string
fromDate
string
toDate
string

Responses

Request samples

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 1,
  • "search": "Nick",
  • "currency": "INR",
  • "fromDate": "2023-03-02",
  • "toDate": "2023-03-02"
}

Response samples

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

Get payout info

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
required
clientOrderId
required
string

Responses

Request samples

Content type
application/json
{
  • "clientOrderId": "SH123456"
}

Response samples

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

Org Data

Fetch balance

Fetch balances of your organization

Authorizations:
OAuth2

Responses

Response samples

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