Update acl for a user. (Requires READWRITE permission for ACL and user)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId | string | ||
object | |||
|
{- "orgUserId": "barbara_allen",
- "modules": {
- "MANAGE_USERS": "NONE"
}
}
{- "code": 200,
- "error": null,
- "data": "OK"
}
Edits tnc for a already present user by providing orgUserId. (Requires READWRITE permissions for Base)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
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 |
{- "orgUserId": "johndoe123",
- "tnc": true,
- "modules": { },
- "loginAllowedFrom": "14:00:00",
- "loginAllowedTo": "23:00:00",
- "kycData": { }
}
{- "code": 200,
- "error": null,
- "data": "OK"
}
Create a new User by providing orgUserId. (Requires READWRITE permissions for User)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
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 |
{- "orgUserId": "johndoe123",
- "userType": "CONSUMER",
- "kyc": true,
- "tnc": true,
- "kycData": { }
}
{- "code": 200,
- "error": null,
- "data": {
- "orgUserId": "michael_scott",
- "orgId": 12,
- "tnc": true,
- "kyc": true,
- "firstName": "Michael",
- "lastName": "Scott",
- "userType": "EMPLOYEE",
- "userStatus": "ACTIVE",
- "modules": {
- "MANAGE_USERS": "NONE"
}
}
}
Get User by orgUserId provided at creation time. (Requires READ permission on user)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId required | string |
{- "orgUserId": "barabara_allen"
}
{- "code": 200,
- "data": {
- "orgUserId": "barbara.allen",
- "orgId": 12,
- "tnc": true,
- "kyc": true,
- "firstName": "Barbara",
- "lastName": "Allen",
- "userType": "CONSUMER",
- "aclStr": "",
- "userStatus": "ACTIVE"
}
}
Freeze a user by passing orgUserId. Once done, further operations on the user will be rejected. (Requires READWRITE permission on User)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId required | string |
{- "orgUserId": "barabara_allen"
}
{- "code": 200,
- "error": null,
- "data": {
- "orgUserId": "barbara.allen",
- "orgId": 12,
- "deleted": true
}
}
Fetch a summary of balances for a user. (Requires READ permission for User)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId required | string Org user id |
{- "orgUserId": "johndoe123"
}
{- "code": 200,
- "error": null,
- "data": [
- {
- "currency": "BTC",
- "value": 10
}, - {
- "currency": "ETH",
- "value": 0.1
}
]
}
Unfreeze an account by passing orgUserId. (Requires READWRITE permission on User)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId required | string Org user id |
{- "orgUserId": "johndoe123"
}
{- "code": 200,
- "error": null,
- "data": {
- "orgUserId": "barbara.allen",
- "orgId": 12
}
}
Fetch all users for your org. (Requires READ permissions for Org.)
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 |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": [
- {
- "orgUserId": "barbara_allen",
- "firstName": "Barbara",
- "lastName": "Allen",
- "kyc": true,
- "tnc": true,
- "userStatus": "ACTIVE",
- "userType": "CONSUMER",
- "createdAt": 1676446107,
- "permissions": {
- "MANAGE_USERS": "READWRITE",
- "RISK_CONTROL": "READWRITE",
- "REPORTS_AND_SETTLEMENT": "READWRITE",
- "CONSUMER_ACCOUNTS": "READWRITE",
- "PROOF_OF_RESERVES": "READWRITE",
- "AUDIT_LOGS": "READWRITE",
- "APIS": "READWRITE",
- "BUSINESS_MONITORING": "READWRITE",
- "FUND_MANAGEMENT": "READWRITE",
- "KNOW_YOUR_TRANSACTION": "READWRITE"
}
}
], - "error": null
}
Edits a already present user by providing orgUserId. (Requires READWRITE permissions for User)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
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 |
{- "orgUserId": "johndoe123",
- "tnc": true,
- "modules": { },
- "loginAllowedFrom": "14:00:00",
- "loginAllowedTo": "23:00:00",
- "kycData": { }
}
{- "code": 200,
- "error": null,
- "data": "OK"
}
Delete a user by providing orgUserId. (Requires READWRITE permissions for User)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId required | string |
{- "orgUserId": "barabara_allen"
}
{- "code": 200,
- "error": null,
- "data": {
- "orgUserId": "barbara.allen",
- "orgId": 12,
- "deleted": true
}
}
Requires READWRITE permission for APIKMS
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "newApiKey": "MCowDuMmyApiKey",
- "newApiSecret": "MC4CDuMmyApiSecret",
- "expiryEpochSeconds": 999999999999,
- "ipWhitelist": "dd",
- "access": "1"
}, - "error": null
}
Fetch supported assets with which you can make trades. Requires READ permissions for Org.
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "symbol": "BTC_AED",
- "policies": {
- "NAME": "BTC_AED",
- "QUANTITY_PRECISION": 8,
- "PRICE_PRECISION": 6,
- "ASSET_ENABLE": false
}
}, - "error": null
}
Get asset metadata that you can use in your app. Requires READ permissions for Org.
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "asset": "BTC",
- "policies": {
- "NAME": "BTC",
- "ASSET_ENABLE": false,
- "LOCAL_CURRENCY": "AED",
- "MARKET_CAP": 100000,
- "CURRENT_PRICE": 1000,
- "HIGH_24HR": 1000,
- "LOW_24HR": 1000,
- "PRICE_CHANGE_PERCENT_24H": 10.1
}
}, - "error": null
}
Get an audit trail of events(user creation, policy changes etc.) tied to your orgId. Requires READ permissions for Audit.
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 |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "createdBy": "michael_scott",
- "eventType": "CREATE",
- "entityType": "Orders",
- "metadata": "{\"key1\": \"value1\"}",
- "createdAt": 1676444477
}, - "error": null
}
Create an entry in the thirdParty table. (Requires READWRITE permission for Bank)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId | string |
name | string |
type | string |
{- "orgUserId": "test@test.com",
- "name": "TESTNAME",
- "type": "SELF"
}
{- "code": 200,
- "error": null,
- "data": "SUCCESS"
}
deletes an entry in the third party table. (Requires READWRITE permission for bank)
thirdPartyUuid required | string thirdPartyUuid which needs to be deleted |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "error": null,
- "data": "SUCCESS"
}
fetch all the third parties for the org. (Requires READWRITE permission for bank)
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 |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "error": null,
- "data": [
- {
- "name": "TESTNAME",
- "accountNumber": "12312312",
- "bankSwiftCode": "ABCDXXXXXX",
- "iban": "AE1231412ADA",
- "bankCode": "002",
- "currency": "AED",
- "paymentMethod": "SWIFT"
}
]
}
Create an fiat account for the third party. (Requires READWRITE permission for Bank)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
thirdPartyUuid | string |
accountNumner | string |
bankSwiftCode | string |
iban | string |
bankCode | string |
currency | string |
paymentMethod | string |
{- "thirdPartyUuid": "aasdasd-asdasd-asdads",
- "accountNumner": "123123",
- "bankSwiftCode": "ABCDXXXXXX",
- "iban": "AE12314ADA312312",
- "bankCode": "002",
- "currency": "AED",
- "paymentMethod": "SWIFT"
}
{- "code": 200,
- "error": null,
- "data": "SUCCESS"
}
deletes an entry in the third party account table. (Requires READWRITE permission for bank)
thirdPartyAccountUuid required | string third party account uuid which needs to be deleted |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "error": null,
- "data": "SUCCESS"
}
Create a crypto wallet entry for the third-party. (Requires READWRITE permission for Bank)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
thirdPartyUuid | string |
asset | string |
address | string |
chain | string |
network | string |
{- "thirdPartyUuid": "aasdasd-asdasd-asdads",
- "asset": "ETH",
- "address": "ASDASD123123ASDAS",
- "chain": "ETH",
- "network": "ETHEREUM"
}
{- "code": 200,
- "error": null,
- "data": "SUCCESS"
}
deletes an entry in the third party wallet table. (Requires READWRITE permission for bank)
thirdPartyWalletUuid required | string third party wallet uuid which needs to be deleted |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "error": null,
- "data": "SUCCESS"
}
Get upload link to upload individual kyc file
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId | string |
fileName | string |
docCategory | string (DocCategory) Enum: "IDENTITY_FRONT" "IDENTITY_BACK" "ADDRESS" "EDD" "LIVELINESS" "W9" "FATCA" "OTHER" |
docSubCategory | string or null |
docDescription | string |
{- "orgUserId": "jim@dundermifflin.com",
- "fileName": "JimHalpertPassport.pdf",
- "docCategory": "IDENTITY_FRONT",
- "docSubCategory": "Passport",
- "docDescription": "This is the passport of Jim Halpert."
}
{- "code": 200,
- "error": null,
- "data": {
- "uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
- "expiryTime": 1722432264.949
}
}
Get upload status of kyc files
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId | string |
{- "orgUserId": "barabara_allen"
}
{- "code": 200,
- "error": null,
- "data": {
- "absentFiles": [
- "IDENTITY_BACK",
- "IDENTITY_FRONT",
- "ADDRESS"
]
}
}
Get edd tracker entries for an org
pageNumber | integer <int32> |
pageSize | integer <int32> |
fromDate | string |
toDate | string |
status | string (EddStatus) Enum: "PENDING" "COMPLETED" |
{- "pageNumber": 1,
- "pageSize": 2,
- "fromDate": "2024-03-03",
- "toDate": "2024-03-04",
- "status": "PENDING"
}
{- "code": 200,
- "error": null,
- "data": [
- {
- "orgId": 10,
- "orgUserId": "barbara_allen_1",
- "uuid": "4acc9473-e0cd-4106-b388-1d3e44dd86bf",
- "status": "PENDING",
- "createdAt": "2023-08-28T16:09:47.537Z",
- "updatedAt": "2023-08-28T16:09:47.537Z"
}
]
}
Update edd tracker entry
uuid | string |
orgUserId | string |
status required | string |
{- "uuid": "4acc9473-e0cd-4106-b388-1d3e44dd86cf",
- "orgUserId": "barbara_allen",
- "status": "COMPLETED"
}
{- "code": 200,
- "error": null,
- "data": "OK"
}
Fetch kyc files for an org and user
orgUserId | string |
{- "orgUserId": "FUZE01234"
}
{- "code": 200,
- "error": null,
- "data": [
- {
- "uuid": "f1a74abc-9d39-45fd-ab7c-cf816cba2e02",
- "filePath": "orgId-10/orgUserId-barbara_allen_1/docCategory-EDD/1721916149845-barbara_allen_1_edd_1.pdf",
- "docCategory": "EDD",
- "docSubCategory": "doc-sub-category",
- "docDescription": "doc-description",
- "uploadStatus": "UPLOADED"
}
]
}
Update kyc file for an org and user
orgUserId | string |
uuid | string |
{- "orgUserId": "FUZE01234",
- "uuid": "f1a74abc-9d39-45fd-ab7c-cf816cba2e02"
}
{- "code": 200,
- "error": null,
- "data": "OK"
}
Delete a kyc file for an org and user
orgUserId | string |
uuid | string |
{- "orgUserId": "FUZE01234",
- "uuid": "f1a74abc-9d39-45fd-ab7c-cf816cba2e02"
}
{- "code": 200,
- "error": null,
- "data": "OK"
}
Generate download link for a kyc file
orgUserId | string |
uuid | string |
{- "orgUserId": "FUZE01234",
- "uuid": "f1a74abc-9d39-45fd-ab7c-cf816cba2e02"
}
{- "code": 200,
- "error": null,
}
Get current balance for the account. (Requires READ permissions for base.)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "availableToTrade": 100,
- "availableToWithdraw": 50,
- "netBuySellForToday": 0
}, - "error": null
}
estimates the fee for a new transaction
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
asset | string |
chain | string |
{- "asset": "ETH",
- "chain": "ETHEREUM"
}
{- "code": 200,
- "error": null,
- "data": {
- "low": {
- "networkFee": "0.000000000000000001"
}, - "medium": {
- "networkFee": "0.000000000000000001"
}, - "high": {
- "networkFee": "0.000000000000000001"
}
}
}
Get supported assets in custody (Requires READ permission on custody)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "error": null,
- "data": {
- "supportedAssets": {
- "ETH": [
- {
- "network": "SEPOLIA",
- "chain": "ETHEREUM"
}
], - "BTC": [
- {
- "network": "TESTNET",
- "chain": "BITCOIN"
}
], - "USDC": [
- {
- "network": "GOERLI",
- "chain": "ETHEREUM",
- "contractAddress": "0x07865c6E87B9F70255377e024ace6630C1Eaa37F"
}
]
}
}
}
Get custody details of an org for asset and chain (Requires READ permission on custody)
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 |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "error": null,
- "data": {
- "fireblocks": {
- "vault": {
- "id": 1,
- "name": "orgId 20",
- "hiddenOnUI": false,
- "autoFuel": false,
- "assetsWithAddresses": [
- {
- "asset": {
- "id": 1,
- "total": 0,
- "balance": 0,
- "lockedAmount": 0,
- "available": 0,
- "pending": 0,
- "frozen": 0,
- "staked": 0,
- "blockHeight": -1
}, - "addresses": {
- "id": 1,
- "orgId": 1,
- "orgWalletId": 1,
- "address": "adsafsdasd",
- "asset": "BTC",
- "network": "TESTNET",
- "chain": "BITCOIN",
- "status": "APPROVED"
},
}
]
}
}
}
}
Get custody details of an org for asset (Requires READ permission on custody)
asset required | string asset for which custody of org needs to be fetched |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "error": null,
- "data": {
- "fireblocks": {
- "vault": {
- "id": 1,
- "name": "orgId 20",
- "hiddenOnUI": false,
- "autoFuel": false,
- "assetsWithAddresses": [
- {
- "asset": {
- "id": 1,
- "total": 0,
- "balance": 0,
- "lockedAmount": 0,
- "available": 0,
- "pending": 0,
- "frozen": 0,
- "staked": 0,
- "blockHeight": -1
}, - "addresses": {
- "id": 1,
- "orgId": 1,
- "orgWalletId": 1,
- "address": "adsafsdasd",
- "asset": "BTC",
- "network": "TESTNET",
- "chain": "BITCOIN",
- "status": "APPROVED"
},
}
]
}
}
}
}
enables asset in custody for user. (Requires READWRITE permission on custody)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId | string |
asset | string |
chain | string |
{- "orgUserId": "string",
- "asset": "ETH",
- "chain": "ETHEREUM"
}
{- "code": 200,
- "error": null,
- "data": {
- "fireblocks": {
- "id": 1,
- "address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
- "legacyAddress": "",
- "enterpriseAddress": "",
- "tag": "prod",
- "eosAccountName": "",
- "status": "ENABLED",
- "activationTxId": ""
}
}
}
fetches custody transactions for a user. (Requires READ permission on custody)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId | string |
asset | string |
chain | string |
custodyType | string Enum: "SEGREGATED" "OMNIBUS" |
status | string |
entry | string Enum: "DEPOSIT" "WITHDRAWAL" |
{- "orgUserId": "string",
- "asset": "ETH",
- "chain": "ETHEREUM",
- "custodyType": "SEGREGATED",
- "status": [
- "COMPLETED",
- "FAILED",
- "REJECTED",
- "QUEUED"
], - "entry": "DEPOSIT"
}
{- "code": 200,
- "error": null,
- "data": {
- "txns": [
- {
- "id": 1,
- "txHash": "e556ab72-da2e-4a10-9524-9f39c132b4b7",
- "status": "COMPLETED",
- "amount": 1,
- "currency": "ETH",
- "chain": "ETHEREUM",
- "entry": "DEPOSIT"
}
]
}
}
fetches a custody transaction for a user. (Requires READ permission on custody)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId | string |
transactionId | number |
{- "orgUserId": "barbara_allen",
- "transactionId": 11
}
{- "code": 200,
- "error": null,
- "data": {
- "id": 1,
- "txHash": "e556ab72-da2e-4a10-9524-9f39c132b4b7",
- "sourceAddress": "0xeth",
- "destinationAddress": "0xeth",
- "status": "COMPLETED",
- "amount": 1,
- "currency": "ETH",
- "chain": "ETHEREUM",
- "entry": "DEPOSIT"
}
}
fetches whitelisted external addresses for a user. (Requires READWRITE permission on custody)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId | string |
asset | string |
chain | string |
{- "orgUserId": "string",
- "asset": "ETH",
- "chain": "ETHEREUM"
}
{- "code": 200,
- "error": null,
- "data": {
- "fireblocks": {
- "id": 1,
- "orgId": 1,
- "orgWalletId": 1,
- "address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
- "asset": "ETH",
- "network": "TESTNET",
- "chain": "ETHEREUM",
- "status": "APPROVED"
}
}
}
create a whitelisted external wallet. (Requires READWRITE permission on custody)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId | string or null |
notabeneExternalCounterpartyVaspDid | string or null |
nickname | string |
address | string |
memo | string or null |
asset | string |
chain | string |
walletType | string |
provider | string |
{- "orgUserId": "orgUserId",
- "notabeneExternalCounterpartyVaspDid": "did:ethr:0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
- "nickname": "nickname",
- "address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E.",
- "memo": "12345",
- "asset": "ETH",
- "chain": "ETHEREUM",
- "walletType": "CUSTODIAL",
- "provider": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E"
}
{- "code": 200,
- "error": null,
- "data": {
- "orgId": 1,
- "userId": 1,
- "notabeneExternalCounterpartyVaspDid": "did:ethr:0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
- "nickname": "nickname",
- "address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E.",
- "asset": "ETH",
- "chain": "ETHEREUM",
- "walletType": "CUSTODIAL",
- "provider": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
- "status": "APPROVED",
- "notes": "notes",
- "vaspMetadata": "metadata",
- "createdAt": "2023-08-28T16:09:47.537Z",
- "updatedAt": "2023-08-28T16:09:47.537Z"
}
}
check if the address is valid
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
address | string |
chain | string |
{- "address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
- "chain": "ETHEREUM"
}
{- "code": 200,
- "error": null,
- "data": {
- "isValid": true,
- "address": "0x5B6f2822b0b235700Bd736A00D666e2531252A7E",
- "chain": "ETHEREUM"
}
}
Gets all the accounts for the org
{- "code": 200,
- "error": null,
- "data": [
- {
- "id": 1,
- "orgId": 1,
- "shortName": "Account1",
- "beneficiaryName": "Account1",
- "bankName": "ENBD",
- "bankCountry": "UAE",
- "currency": "AED",
- "isVerified": true,
- "isEnabled": true,
- "isDefault": true,
- "accountNumber": "account1",
- "transferDetails": "{swift: \"123123\"}"
}
]
}
add a bank account. (Requires READWRITE permission for finance)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
beneficiaryName | string |
bankName | string |
bankCountry | string |
currency | string |
accountNumber | string |
transferDetails | string |
{- "beneficiaryName": "Account1",
- "bankName": "ENBD",
- "bankCountry": "UAE",
- "currency": "AED",
- "accountNumber": "account1",
- "transferDetails": "{swiftcode : \"swiftBank\"}"
}
{- "code": 200,
- "data": {
- "id": 12,
- "orgId": 1,
- "shortName": "Account1",
- "beneficiaryName": "Account1",
- "bankName": "ENBD",
- "bankCountry": "UAE",
- "currency": "AED",
- "isVerified": true,
- "isEnabled": true,
- "isDefault": true,
- "accountNumber": "account1",
- "transferDetails": "{swift: \"123123\"}"
}, - "error": null
}
delete a bank account. (Requires READWRITE permission for finance)
accountId required | string accountId of the account that needs to be deleted |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "numDeleted": 1
}, - "error": null
}
initiate a transaction to a fiat bank account. (Requires READWRITE permission for finance)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
accountId | integer |
txnId | string |
amount | integer |
transactionType | string (BankTransferType) Enum: "DEPOSIT" "WITHDRAW" "SETTLEMENT" |
currency | string |
fundingAmount | integer |
fundingCurrency | string |
{- "accountId": 10,
- "txnId": "Txn1",
- "amount": 1,
- "transactionType": "DEPOSIT",
- "currency": "AED",
- "fundingAmount": 1,
- "fundingCurrency": "AED"
}
{- "code": 200,
- "data": [
- {
- "id": 12,
- "orgId": 1,
- "accountId": "Account1",
- "txnId": "Txn1",
- "referenceId": "123123",
- "amount": 123,
- "type": "DEPOSIT",
- "status": "PENDING",
- "currency": "AED",
- "fundingAmount": 123,
- "fundingCurrency": "AED"
}
], - "error": null
}
list of all fiat transactions. (Requires READ permissions for Finance.)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
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 |
{- "pageNumber": 1,
- "pageSize": 2,
- "orgUserId": "barbara_allen",
- "type": "DEPOSIT",
- "status": "PENDING",
- "fromDate": "2024-03-03",
- "toDate": "2024-03-04",
- "fuzeReferenceId": "12345-1312314-12312312"
}
{- "code": 200,
- "data": [
- {
- "orgId": 1,
- "accountId": "Account1",
- "txnId": "Txn1",
- "referenceId": "123123",
- "amount": 123,
- "type": "DEPOSIT",
- "status": "PENDING",
- "currency": "AED",
- "createdAt": 1676444477,
- "closingBalance": 100
}
], - "error": null
}
Get current balance for the account. (Requires READ permissions for finance.)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "availableToTrade": 100,
- "availableToWithdraw": 50,
- "netBuySellForToday": 0
}, - "error": null
}
Gets all the fuze maintained accounts for the org
{- "code": 200,
- "error": null,
- "data": [
- {
- "id": 1,
- "orgId": 1,
- "shortName": "Account1",
- "beneficiaryName": "Account1",
- "bankName": "ENBD",
- "bankCountry": "UAE",
- "currency": "AED",
- "isVerified": true,
- "isEnabled": true,
- "isDefault": true,
- "accountNumber": "account1",
- "transferDetails": "{swift: \"123123\"}"
}
]
}
Gets all the fuze target accounts for the org
{- "code": 200,
- "error": null,
- "data": [
- {
- "fuzeAccountId": 1,
- "shortName": "Account Name",
- "beneficiaryName": "Beneficiary Name",
- "bankName": "ENBD",
- "bankCountry": "UAE",
- "currency": "AED",
- "isVerified": true,
- "isDefault": true,
- "bankAccountNumber": "ACC1234",
- "transferDetails": "{swift: \"123123\"}",
- "ibanProvider": "Zand"
}
]
}
Returns the created orders for the org. (Requires READ permission on finance.)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
pageNumber | integer |
pageSize | integer |
fromDate | string |
toDate | string |
transactionType | string |
sort | string |
{- "pageNumber": 1,
- "pageSize": 2,
- "fromDate": "2023-08-22",
- "toDate": "2023-08-23",
- "transactionType": "BUY",
- "sort": "createdAt:DESC"
}
{- "code": 200,
- "data": {
- "createdAt": "2023-08-28T16:09:47.537Z",
- "updatedAt": "2023-08-28T16:09:47.537Z",
- "side": "BUY",
- "symbol": "BTC_AED",
- "filled": 0.1,
- "averagePrice": 100,
- "externalId": "abcd",
- "orgUserId": "fake_user",
- "orgMarkup": 1,
- "orgVat": 5,
- "fuzeMarkup": 5,
- "fuzeVat": 0.5,
- "status": "COMPLETED",
- "orgSettlementId": "b986d0eb-a7df-4fc9-b440-3ffa73a4b1f9",
- "baseAveragePrice": 100,
- "netExecutedAmount": 49,
- "totalExecutedAmount": 50,
- "commissionAmount": 1
}, - "error": null
}
Exports the orders for the org. (Requires READ permission on finance.)
fromDate required | string |
toDate required | string |
orgUserId | string |
status | string |
side | string |
sort | string |
{- "fromDate": "2023-08-22",
- "toDate": "2023-08-23",
- "orgUserId": "orgUserId",
- "status": "OPEN,CLOSED",
- "side": "BUY,SELL",
- "sort": "createdAt:DESC"
}
{- "code": 200,
- "error": null,
- "data": "OK"
}
get fx rate between two currencies. (Requires READ permission on finance.)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
fromCurrency | string |
toCurrency | string |
{- "fromCurrency": "USD",
- "toCurrency": "AED"
}
{- "code": 200,
- "data": 3,
- "error": null
}
Cancels the transaction
referenceId | string |
transactionStatus | string |
transactionType | string |
{- "referenceId": "asdf1234",
- "transactionStatus": "CANCELED",
- "transactionType": "DEPOSIT"
}
{- "code": 200,
- "error": null,
- "data": "OK"
}
swap between two currencies for same org. (Requires READWRITE permission for finance)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
fromCurrency | string |
fromAmount | integer |
toCurrency | string |
toAmount | integer |
{- "fromCurrency": "USD",
- "fromAmount": 100,
- "toCurrency": "AED",
- "toAmount": 367
}
{- "code": 200,
- "error": null,
- "data": "OK"
}
reward tokens, or sell rewarded tokens. (Requires READWRITE permissions for loyalty).
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId required | string |
symbol required | string |
quoteQuantity required | number quoteQuantity is the local currency amount you want to buy or sell crypto for. Eg: If if you want to buy 1000 AED worth of BTC, you’ll have quoteQuantity 1000 on BTC_AED. If you’re selling 1000 AED quoteQuantity of BTC, quoteQuantity is 1000. Not quantity should be zero in both cases. |
operation required | string Enum: "BUY" "SELL" |
type | string (OrderType) Enum: "MARKET" "LIMIT" |
clientOrderId | string this is an idempotency key to avoid duplicate orders due to network failures |
{- "orgUserId": "barabara_allen",
- "symbol": "ETH_AED",
- "quoteQuantity": 1000,
- "operation": "BUY",
- "type": "MARKET",
- "clientOrderId": "unique-uuid"
}
{- "code": 200,
- "data": {
- "id": 101,
- "orgId": 12,
- "orgUserId": "michael_scott",
- "symbol": "BTC_AED",
- "side": "BUY",
- "type": "MARKET",
- "kind": "FILL_OR_KILL",
- "status": "COMPLETED",
- "quantity": 1,
- "filled": 1,
- "executedAmount": 1,
- "commissionRate": 0.01,
- "commissionAmount": 0.01,
- "vatRate": 0.05,
- "vatAmount": 0
}, - "error": null
}
Returns the details of a particular order. (Requires READ permission on Loyalty.)
orderId required | string orderId of the order for which details needs to be fetched |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "id": 101,
- "orgId": 12,
- "orgUserId": "michael_scott",
- "symbol": "BTC_AED",
- "side": "BUY",
- "type": "MARKET",
- "kind": "FILL_OR_KILL",
- "status": "COMPLETED",
- "quantity": 1,
- "filled": 1,
- "executedAmount": 1,
- "commissionRate": 0.01,
- "commissionAmount": 0.01,
- "vatRate": 0.05,
- "vatAmount": 0
}, - "error": null
}
Fetch token balances of your org. Requires READ permissions for Org.
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "orgId": 1,
- "balance": {
- "AED": 10,
- "USD": 5
}
}, - "error": null
}
Returns the created order along with details. (Requires READWRITE permission on OTC.)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId required | string |
symbol required | string |
quoteQuantity required | number quoteQuantity is the local currency amount you want to buy or sell crypto for. Eg: If if you want to buy 1000 AED worth of BTC, you’ll have quoteQuantity 1000 on BTC_AED. If you’re selling 1000 AED quoteQuantity of BTC, quoteQuantity is 1000. Not quantity should be zero in both cases. |
operation required | string Enum: "BUY" "SELL" |
type | string (OrderType) Enum: "MARKET" "LIMIT" |
clientOrderId | string this is an idempotency key to avoid duplicate orders due to network failures |
{- "orgUserId": "barabara_allen",
- "symbol": "ETH_AED",
- "quoteQuantity": 1000,
- "operation": "BUY",
- "type": "MARKET",
- "clientOrderId": "unique-uuid"
}
{- "code": 200,
- "data": {
- "id": 101,
- "orgId": 12,
- "orgUserId": "michael_scott",
- "symbol": "BTC_AED",
- "side": "BUY",
- "type": "MARKET",
- "kind": "FILL_OR_KILL",
- "status": "COMPLETED",
- "quantity": 1,
- "filled": 1,
- "executedAmount": 1,
- "commissionRate": 0.01,
- "commissionAmount": 0.01,
- "vatRate": 0.05,
- "vatAmount": 0
}, - "error": null
}
Returns the created orders for the user. (Requires READ permission on OTC.)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId required | string |
pageNumber | integer <int32> |
pageSize | integer <int32> |
fromDate | string <date> |
toDate | string <date> |
status | string |
productType | string |
{- "orgUserId": "barbara_allen",
- "pageNumber": 1,
- "pageSize": 1,
- "fromDate": "2023-03-02",
- "toDate": "2023-03-02",
- "status": "OPEN",
- "productType": "LOYALTY"
}
{- "code": 200,
- "data": [
- {
- "id": 101,
- "orgId": 12,
- "orgUserId": "barbara.allen",
- "symbol": "BTC_AED",
- "side": "BUY",
- "status": "COMPLETED",
- "quantity": 1,
- "filled": 1,
- "executedAmount": 1,
- "vatRate": 0.05,
- "commissionRate": 0.01,
- "commissionAmount": 0.01,
- "vatAmount": 0
}, - {
- "id": 102,
- "orgId": 12,
- "orgUserId": "larry.meyers",
- "symbol": "ETH_AED",
- "status": "COMPLETED",
- "side": "BUY",
- "quantity": 2,
- "filled": 1,
- "executedAmount": 2,
- "vatRate": 0.05,
- "commissionRate": 0.01,
- "commissionAmount": 0.01,
- "vatAmount": 0
}
], - "error": null
}
Returns the details of a particular order. (Requires READ permission on OTC.)
orderId required | string orderId of the order for which details needs to be fetched |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "id": 101,
- "orgId": 12,
- "orgUserId": "michael_scott",
- "symbol": "BTC_AED",
- "side": "BUY",
- "type": "MARKET",
- "kind": "FILL_OR_KILL",
- "status": "COMPLETED",
- "quantity": 1,
- "filled": 1,
- "executedAmount": 1,
- "commissionRate": 0.01,
- "commissionAmount": 0.01,
- "vatRate": 0.05,
- "vatAmount": 0
}, - "error": null
}
Returns the quote. (Requires WRITE permission on OTC.)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
orgUserId | string |
symbol | string |
operation | string |
quantity | integer <int32> |
{- "orgUserId": "barabara_allen",
- "symbol": "ETH_AED",
- "operation": "BUY",
- "quantity": 2
}
{- "code": 200,
- "data": {
- "orgId": 12,
- "orgUserId": "barbara.allen",
- "quoteId": 10,
- "expiryTime": 99999999999
}, - "error": null
}
Returns list of orders for the org. (Requires READ permission on Trading.)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
pageNumber | integer <int32> |
pageSize | integer <int32> |
orderIds required | Array of integers |
{- "pageNumber": 1,
- "pageSize": 2,
- "orderIds": [
- 101,
- 102
]
}
{- "code": 200,
- "data": [
- {
- "id": 101,
- "orgId": 12,
- "orgUserId": "barbara.allen",
- "symbol": "BTC_AED",
- "side": "BUY",
- "status": "COMPLETED",
- "quantity": 1,
- "filled": 1,
- "executedAmount": 1,
- "vatRate": 0.05,
- "commissionRate": 0.01,
- "commissionAmount": 0.01,
- "vatAmount": 0
}, - {
- "id": 102,
- "orgId": 12,
- "orgUserId": "larry.meyers",
- "symbol": "ETH_AED",
- "status": "COMPLETED",
- "side": "BUY",
- "quantity": 2,
- "filled": 1,
- "executedAmount": 2,
- "vatRate": 0.05,
- "commissionRate": 0.01,
- "commissionAmount": 0.01,
- "vatAmount": 0
}
], - "error": null
}
Sends consolidated settlement report for an org via email for a given time period
from | string |
to | string |
orgId | string |
{- "from": "2023-05-01",
- "to": "2023-05-31",
- "orgId": 1
}
{- "code": 200,
- "data": "Your request to send transactions via email is registered successfully",
- "error": null
}
Returns the CAS statements for the org.
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
pageNumber | integer <int32> |
pageSize | integer <int32> |
fromDate | string <date> |
toDate | string <date> |
{- "pageNumber": 1,
- "pageSize": 1,
- "fromDate": "2023-03-02",
- "toDate": "2023-03-02"
}
{- "code": 200,
- "data": [
- {
- "uuid": "2ba8a592-312b-4849-8f5b-e9a60f51be58",
- "entityName": "CAS",
- "entityId": 0,
- "docDescription": "statement-2024-12-02 to 2024-12-10"
}
], - "error": null
}
Download consolidated settlement report for an org
uuid required | string |
{- "uuid": "2ba8a592-312b-4849-8f5b-e9a60f51be58"
}
{- "code": 200,
- "error": null,
}
Fetches all successful transactions for an org against a given orgSettlementId. Note: Pagination is applicable only for json response.
orgSettlementId | string |
toJson | boolean |
pageNumber | number or null |
pageSize | number or null |
{- "orgSettlementId": "95606754-8c6e-45b7-b7e4-1ae9ccffb31f",
- "toJson": true,
- "pageNumber": 0,
- "pageSize": 50
}
{- "code": 200,
- "data": [
- {
- "id": 66624,
- "createdAt": "2024-03-28T06:59:03.751Z",
- "orgUserId": "test.org",
- "orgId": 135,
- "side": "BUY",
- "quantity": 0.002,
- "quoteQuantity": 0,
- "symbol": "BTC_AED",
- "orgCurrency": "AED",
- "orgMarkupAmount": 0,
- "orgVatAmount": 0,
- "costPrice": 140.59078,
- "netExecutedAmount": 515.9681626,
- "totalExecutedAmount": 516.50992917,
- "orgSettlementId": "95606754-8c6e-45b7-b7e4-1ae9ccffb31f'",
- "updatedAt": "2024-03-28T06:59:04.825Z",
- "commissionAmount": 0,
- "vatAmount": 0,
- "finalAveragePrice": 258242.065381
}, - {
- "id": 66625,
- "createdAt": "2024-03-28T07:00:11.791Z",
- "orgUserId": "test.org",
- "orgId": 135,
- "side": "BUY",
- "quantity": 0.00193707,
- "quoteQuantity": 500,
- "symbol": "BTC_AED",
- "orgCurrency": "AED",
- "orgMarkupAmount": 0,
- "orgVatAmount": 0,
- "costPrice": 136.23969249,
- "netExecutedAmount": 499.99967144,
- "totalExecutedAmount": 500.5246711,
- "orgSettlementId": "95606754-8c6e-45b7-b7e4-1ae9ccffb31f",
- "updatedAt": "2024-03-28T07:00:12.868Z",
- "commissionAmount": 0,
- "vatAmount": 0,
- "finalAveragePrice": 258379.754532
}
], - "error": null
}
Sends consolidated settlement report for an org via email for a given time period
from | string |
to | string |
{- "from": "2023-05-01",
- "to": "2023-05-31"
}
{ "code": 200, "error": null, "data": "Your request to send transactions via email is registered successfully" }
Request invoice by a customer. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
targetOrgUuid required | string |
currency required | string |
amount required | number |
idempotencyKey | string |
notes | string |
{- "targetOrgUuid": "ABC123123",
- "currency": "USD",
- "amount": 100,
- "idempotencyKey": "asbasda",
- "notes": "test test"
}
{- "code": 200,
- "data": {
- "uuid": "d0cf3a76-9579-4571-96a6-3fd23557b59a",
- "targetOrgUuid": "FUZE308435",
- "currency": "USD",
- "amount": 10000,
- "status": "CREATED",
- "type": "REQUEST",
- "notes": "Payment for Property",
- "cancellationReason": null,
- "createdAt": "2024-05-22T07:47:16.592Z"
}, - "error": null
}
Generate upload link to upload invoice file. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
fileName required | string |
orgId | number or null |
entityName | string or null |
{- "fileName": "example.pdf",
- "orgId": 1,
- "entityName": "INVOICES"
}
{- "code": 200,
- "data": {
- "uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
- "expiryTime": 1717332855.723
}, - "error": null
}
Generate download link for an invoice file
invoiceId required | number <int32> |
{- "invoiceId": 1
}
{- "code": 200,
- "error": null,
- "data": {
- "expiryTime": 1721922798.244,
- "uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f"
}
}
Fetch invoice for a customer. (Requires READ permission for Payment)
invoiceId required | string invoiceId for which the api needs to be called |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "uuid": "d0cf3a76-9579-4571-96a6-3fd23557b59a",
- "targetOrgUuid": "FUZE308435",
- "currency": "USD",
- "amount": 10000,
- "status": "CREATED",
- "type": "REQUEST",
- "notes": "Payment for Property",
- "cancellationReason": null,
- "createdAt": "2024-05-22T07:47:16.592Z"
}, - "error": null
}
Cancel invoice for a customer. (Requires READ permission for Payment)
invoiceId required | string invoiceId for which the api needs to be called |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
reason | string |
{- "reason": "Customer rejected the buy"
}
{- "code": 200,
- "error": null,
- "data": "SUCCESS"
}
Get all invoices for a customer. (Requires READ permission for Payment)
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 |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "sent": [
- {
- "uuid": "d0cf3a76-9579-4571-96a6-3fd23557b59a",
- "orgId": 1,
- "targetOrgId": 2,
- "targetOrgUuid": "FUZE308435",
- "externalId": "test1",
- "idempotencyKey": "test2",
- "currency": "USD",
- "amount": 10000,
- "status": "CREATED",
- "type": "REQUEST",
- "notes": "Payment for Property",
- "cancellationReason": null,
- "createdAt": "2024-05-22T07:47:16.592Z",
- "sourceName": "source",
- "targetName": "target"
}
], - "received": [
- {
- "uuid": "d0cf3a76-9579-4571-96a6-3fd23557b59a",
- "orgId": 1,
- "targetOrgId": 2,
- "targetOrgUuid": "FUZE308435",
- "externalId": "test1",
- "idempotencyKey": "test2",
- "currency": "USD",
- "amount": 10000,
- "status": "CANCELLED",
- "type": "REQUEST",
- "notes": "Payment for Property",
- "cancellationReason": "Reason to cancel",
- "createdAt": "2024-05-22T07:47:16.592Z",
- "sourceName": "source",
- "targetName": "target"
}
]
}, - "error": null
}
Request payment by a customer. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
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 |
{- "orgUserId": "barabara_allen",
- "symbol": "ETH_AED",
- "quantity": 0.01,
- "operation": "BUY",
- "quoteId": "unique-uuid",
- "invoiceId": "unique-uuid"
}
{- "code": 200,
- "error": null,
- "data": "SUCCESS"
}
Search in the address book. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
string | |
name | string |
{- "email": "test@test.com",
- "name": "test"
}
{- "code": 200,
- "error": null,
- "data": {
- "uuid": "FUZE121212",
- "status": "PENDING",
- "nickName": "TEST",
- "email": "test@test.com"
}
}
Create an entry in the address book. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
string | |
name | string |
{- "email": "test@test.com",
- "name": "TESTNAME"
}
{- "code": 200,
- "error": null,
- "data": {
- "uuid": "FUZE121212",
- "status": "PENDING",
- "nickName": "TEST",
- "email": "test@test.com"
}
}
Delete from the address book. (Requires READWRITE permission for Payment)
addressBookId required | string addressBookId which needs to be deleted |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "error": null,
- "data": "SUCCESS"
}
Get all payouts for a dealer. (Requires READ permission for Payment)
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 |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "error": null,
- "data": [
- {
- "uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
- "orgId": 10,
- "amount": 10,
- "currency": "AED"
}
]
}
Get earnings for a dealer. (Requires READ permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "error": null,
- "data": {
- "pendingPayouts": 100,
- "totalEarned": 100
}
}
Create a property. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
name | string |
businessName | string |
beneficiaryName | string |
bankName | string |
bankCountry | string |
transferDetails | string |
{- "name": "Property Name",
- "businessName": "A123TZ456",
- "beneficiaryName": "Beneficiary Name",
- "bankName": "ENBD",
- "bankCountry": "UAE",
- "transferDetails": "{\"iban\": \"IBAN01234\"}"
}
{- "code": 200,
- "error": null,
- "data": {
- "name": "Property Name",
- "businessName": "A123TZ456",
- "account": {
- "beneficiaryName": "Beneficiary Name",
- "bankName": "ENBD",
- "bankCountry": "UAE",
- "transferDetails": "{\"iban\": \"IBAN01234\"}"
}
}
}
Fetch the list of properties. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "error": null,
- "data": [
- {
- "name": "Property Name1",
- "uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
- "businessName": "A123TZ456",
- "account": {
- "beneficiaryName": "Beneficiary Name1",
- "bankName": "ENBD",
- "bankCountry": "UAE",
- "transferDetails": "{\"iban\": \"IBAN01234\"}"
}
}, - {
- "name": "Property Name2",
- "uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
- "businessName": "A123OP789",
- "account": {
- "beneficiaryName": "Beneficiary Name2",
- "bankName": "ENBD",
- "bankCountry": "UAE",
- "transferDetails": "{\"iban\": \"IBAN56789\"}"
}
}
]
}
Create an invoice for a property. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
targetOrgUuid required | string |
currency required | string |
amount required | number |
idempotencyKey | string |
notes | string |
{- "targetOrgUuid": "ABC123123",
- "currency": "USD",
- "amount": 100,
- "idempotencyKey": "asbasda",
- "notes": "test test"
}
{- "code": 200,
- "data": {
- "uuid": "d0cf3a76-9579-4571-96a6-3fd23557b59a",
- "targetOrgUuid": "FUZE308435",
- "currency": "USD",
- "amount": 10000,
- "status": "CREATED",
- "type": "REQUEST",
- "notes": "Payment for Property",
- "cancellationReason": null,
- "createdAt": "2024-05-22T07:47:16.592Z"
}, - "error": null
}
Create third-party for payment gateway. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
email required | string | ||||||||||||||||||
type required | string Enum: "FIRST_PARTY" "THIRD_PARTY" | ||||||||||||||||||
clientIdentifier required | string | ||||||||||||||||||
required | object | ||||||||||||||||||
|
{- "email": "sherlockholmes@baker.st",
- "type": "THIRD_PARTY",
- "clientIdentifier": "SH123456",
- "kycData": {
- "fullName": "Sherlock Holmes",
- "entityType": "individual",
- "email": "sherlockholmes@baker.st",
- "addressLine1": "221B Baker Street",
- "addressLine2": "221B Baker Street",
- "city": "London",
- "state": "London",
- "country": "GB",
- "postalCode": "NW1 6XE"
}
}
{- "code": 200,
- "error": null,
- "data": {
- "name": "Sherlock Holmes",
- "email": "sherlockholmes@baker.st",
- "type": "THIRD_PARTY",
- "status": "ACTIVE",
- "uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
- "clientIdentifier": "SH123456"
}
}
Get third-party list for payment gateway. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "error": null,
- "data": [
- {
- "name": "Sherlock Holmes",
- "email": "sherlockholmes@baker.st",
- "type": "THIRD_PARTY",
- "status": "ACTIVE",
- "uuid": "21a0194f-709e-4c62-8590-464ddb9abd8f",
- "clientIdentifier": "SH123456"
}
]
}
Create a payin for a third party. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
clientIdentifier required | string |
symbol required | string |
chain required | number |
quantity required | number |
clientOrderId | string |
{- "clientIdentifier": "sherlockholmes",
- "symbol": "USDC_USD",
- "chain": "ETHEREUM",
- "quantity": 123.45,
- "clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f"
}
{- "code": 200,
- "data": {
- "clientIdentifier": "sherlockholmes",
- "clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f",
- "status": "CREATED",
- "walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f4sk",
- "chain": "ETHEREUM",
- "network": "TESTNET",
- "symbol": "USDC_USD",
- "quantity": 123.45,
- "expiryTime": 1717332855
}, - "error": null
}
Get status of a payin for a third party. (Requires READWRITE permission for Payment)
clientOrderId required | string clientOrderId of the payin for which details needs to be fetched |
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
{- "code": 200,
- "data": {
- "clientIdentifier": "sherlockholmes",
- "clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f",
- "status": "CREATED",
- "walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f4sk",
- "chain": "ETHEREUM",
- "network": "TESTNET",
- "symbol": "USDC_USD",
- "quantity": 123.45,
- "expiryTime": 1717332855
}, - "error": null
}
Create quote a payout for a third party. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
clientIdentifier required | string |
symbol required | string |
operation | string Enum: "BUY" "SELL" |
chain required | string |
quantity required | number |
clientOrderId | string |
{- "clientIdentifier": "sherlockholmes",
- "symbol": "USDC_USD",
- "operation": "BUY",
- "chain": "ETHEREUM",
- "quantity": 123.45,
- "clientOrderId": "21a0194f-709e-4c62-8590-464ddb9abd8f"
}
{- "code": 200,
- "data": {
- "id": 1,
- "clientIdentifier": "sherlockholmes",
- "symbol": "USDC_USD",
- "quantity": 123.45,
- "price": 123.45,
- "expiryTime": 1717332855,
- "operation": "SELL"
}, - "error": null
}
Create a payout for a third party. (Requires READWRITE permission for Payment)
X-SIGNATURE required | string |
X-TIMESTAMP required | number |
clientIdentifier required | string |
address required | string |
chain required | string |
quoteId required | number |