{ "openapi": "3.0.0", "info": { "title": "HandCash SDK API", "version": "2026-05-19", "termsOfService": "https://market.handcash.io/legal/terms_sdk", "contact": { "name": "HandCash Developer Support", "url": "https://docs.handcash.io", "email": "support@handcash.io" } }, "tags": [ { "name": "Wallet API" }, { "name": "Connect" }, { "name": "Users" }, { "name": "Payment Requests" }, { "name": "Minter" }, { "name": "Items" } ], "components": { "schemas": { "account-aliasAvailabilitySchema": { "type": "object", "properties": { "availability": { "type": "string", "enum": [ "NOT_AVAILABLE", "AVAILABLE" ] } }, "required": [ "availability" ], "additionalProperties": false }, "account-fullPublicProfilesSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "handle": { "type": "string" }, "paymail": { "type": "string", "format": "email" }, "displayName": { "type": "string" }, "avatarUrl": { "type": "string" }, "localCurrencyCode": { "type": "string", "minLength": 3, "maxLength": 3 }, "bitcoinUnit": { "type": "string", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "handle", "paymail", "localCurrencyCode", "createdAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "account-fullUserProfileSchema": { "type": "object", "properties": { "publicProfile": { "type": "object", "properties": { "id": { "type": "string" }, "handle": { "type": "string" }, "paymail": { "type": "string", "format": "email" }, "displayName": { "type": "string" }, "avatarUrl": { "type": "string" }, "localCurrencyCode": { "type": "string", "minLength": 3, "maxLength": 3 }, "bitcoinUnit": { "type": "string", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "handle", "paymail", "localCurrencyCode", "createdAt" ], "additionalProperties": false }, "privateProfile": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "phoneNumber": { "type": "string", "enum": [ "" ], "deprecated": true } }, "additionalProperties": false } }, "additionalProperties": false }, "account-profileAPIDefinition": { "type": "object", "properties": { "alias": { "type": "string" }, "displayName": { "type": "string" }, "profilePictureUrl": { "type": "string" }, "id": { "type": "string" } }, "required": [ "alias" ], "additionalProperties": false }, "account-profilesSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "alias": { "type": "string" }, "displayName": { "type": "string" }, "profilePictureUrl": { "type": "string" }, "id": { "type": "string" } }, "required": [ "alias" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "account-requestEmailCodeSchema": { "type": "object", "properties": { "requestId": { "type": "string" } }, "required": [ "requestId" ], "additionalProperties": false }, "application-applicationsSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "longDescription": { "type": "string" }, "shortDescription": { "type": "string" }, "iconUrl": { "type": "string" }, "bannerUrl": { "type": "string" }, "publisherEmail": { "type": "string", "format": "email" }, "appWebsiteUrl": { "type": "string" }, "appAndroidUrl": { "type": "string" }, "appAppleUrl": { "type": "string" }, "privacyPolicyUrl": { "type": "string" }, "screenUrls": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "USER_PRIVATE_PROFILE", "USER_PUBLIC_PROFILE", "PAY", "FRIENDS", "DECRYPT", "SIGN_DATA", "OWNERSHIP", "ITEMS_READ", "ITEMS_WRITE", "READ_BALANCE", "READ_TRANSACTIONS", "GENERATE_ADDRESS", "ITEM_ISSUE", "DEVICE_ADMIN", "SIGNUP" ] } }, "authenticationSuccessUrl": { "type": "string" }, "authenticationDeclineUrl": { "type": "string" }, "isUserConnected": { "type": "boolean" }, "hasShopItems": { "type": "boolean" }, "isAppExtension": { "type": "boolean" }, "isPromotedOnMarket": { "type": "boolean" }, "isFeaturedOnMarket": { "type": "boolean" }, "extensions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "iconUrl": { "type": "string" }, "authorizationSuccessWebhook": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "id", "name", "screenUrls", "isUserConnected", "hasShopItems", "isAppExtension", "isPromotedOnMarket", "isFeaturedOnMarket", "extensions" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "connect-permissionsSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string", "enum": [ "USER_PRIVATE_PROFILE", "USER_PUBLIC_PROFILE", "PAY", "READ_BALANCE", "GENERATE_ADDRESS", "READ_TRANSACTIONS", "ITEMS_READ", "ITEMS_WRITE" ] } }, "appId": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" } }, "required": [ "items", "appId" ], "additionalProperties": false }, "items-collectionSchema": { "type": "object", "properties": { "id": { "type": "string" }, "isFeatured": { "type": "boolean" }, "origin": { "type": "string" }, "name": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": {} } }, "description": { "type": "string" }, "imageUrl": { "type": "string" }, "totalQuantity": { "type": "number", "format": "float" }, "isHandcashCreated": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "isVisibleInMarket": { "type": "boolean" }, "app": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "iconUrl": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "id", "isFeatured", "origin", "name", "description", "imageUrl", "totalQuantity", "isHandcashCreated", "isVerified", "isVisibleInMarket" ], "additionalProperties": false }, "items-collectionsSchema": { "type": "object", "properties": { "featured": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isFeatured": { "type": "boolean" }, "origin": { "type": "string" }, "name": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": {} } }, "description": { "type": "string" }, "imageUrl": { "type": "string" }, "totalQuantity": { "type": "number", "format": "float" }, "isHandcashCreated": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "isVisibleInMarket": { "type": "boolean" }, "app": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "iconUrl": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "id", "isFeatured", "origin", "name", "description", "imageUrl", "totalQuantity", "isHandcashCreated", "isVerified", "isVisibleInMarket" ], "additionalProperties": false } }, "others": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isFeatured": { "type": "boolean" }, "origin": { "type": "string" }, "name": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": {} } }, "description": { "type": "string" }, "imageUrl": { "type": "string" }, "totalQuantity": { "type": "number", "format": "float" }, "isHandcashCreated": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "isVisibleInMarket": { "type": "boolean" }, "app": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "iconUrl": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "id", "isFeatured", "origin", "name", "description", "imageUrl", "totalQuantity", "isHandcashCreated", "isVerified", "isVisibleInMarket" ], "additionalProperties": false } } }, "additionalProperties": false }, "items-itemCreationOrderSchema": { "type": "object", "properties": { "id": { "type": "string" }, "user": { "type": "string" }, "app": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "referencedCollection": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "type": { "type": "string" }, "status": { "type": "string" }, "pendingInscriptions": { "type": "number", "format": "float" }, "error": { "type": "string" } }, "required": [ "id", "user", "app", "type", "status", "pendingInscriptions" ], "additionalProperties": false }, "items-itemMetricsSchema": { "type": "object", "properties": { "itemsSold": { "type": "number", "format": "float" }, "volumeInUSD": { "type": "number", "format": "float" }, "numberOfActiveListings": { "type": "number", "format": "float" }, "numberOfOwners": { "type": "number", "format": "float" }, "supply": { "type": "number", "format": "float" } }, "required": [ "itemsSold", "volumeInUSD", "numberOfActiveListings", "numberOfOwners", "supply" ], "additionalProperties": false }, "items-itemSchema": { "type": "object", "properties": { "id": { "type": "string" }, "origin": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "alias": { "type": "string" }, "displayName": { "type": "string" }, "profilePictureUrl": { "type": "string" } }, "required": [ "id", "alias", "displayName", "profilePictureUrl" ], "additionalProperties": false }, "collection": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "isFeatured": { "type": "boolean" }, "origin": { "type": "string" }, "name": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": {} } }, "description": { "type": "string" }, "imageUrl": { "type": "string" }, "totalQuantity": { "type": "number", "format": "float" }, "isHandcashCreated": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "isVisibleInMarket": { "type": "boolean" }, "app": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "iconUrl": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "id", "isFeatured", "origin", "name", "description", "imageUrl", "totalQuantity", "isHandcashCreated", "isVerified", "isVisibleInMarket" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": false } ] }, "app": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "iconUrl": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, "name": { "type": "string" }, "groupingValue": { "type": "string" }, "description": { "type": "string" }, "imageUrl": { "type": "string" }, "multimediaUrl": { "type": "string" }, "multimediaType": { "type": "string" }, "rarity": { "type": "string" }, "color": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "anyOf": [ { "type": "string", "x-required": true }, { "type": "number", "format": "float", "x-required": true } ] }, "displayType": { "type": "string" } }, "required": [ "name", "displayType" ], "additionalProperties": false } }, "isHandcashCreated": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "isListing": { "type": "boolean" }, "itemListing": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "paymentRequestUrl": { "type": "string" }, "paymentRequestId": { "type": "string" }, "price": { "type": "number", "format": "float" }, "currencyCode": { "type": "string" }, "denominatedIn": { "type": "string" }, "fiatEquivalent": { "type": "object", "properties": { "amount": { "type": "number", "format": "float" }, "currencyCode": { "type": "string" } }, "required": [ "amount", "currencyCode" ], "additionalProperties": false }, "listedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "status", "paymentRequestUrl", "paymentRequestId", "price", "currencyCode", "denominatedIn", "listedAt" ], "additionalProperties": false }, "count": { "type": "number", "format": "float" }, "royalties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "percentage": { "type": "number", "format": "float" }, "destination": { "type": "string" } }, "required": [ "type", "percentage", "destination" ], "additionalProperties": false } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "name", "description", "url", "enabled" ], "additionalProperties": false } }, "isCurrentUser": { "type": "boolean" }, "floorPriceInUsd": { "type": "number", "format": "float" }, "lastSoldPriceInUsd": { "type": "number", "format": "float" }, "externalId": { "type": "string" }, "priceAlert": { "type": "object", "properties": { "amountInUSD": { "type": "number", "format": "float" }, "groupingValue": { "type": "string" }, "itemName": { "type": "string" }, "contentUrl": { "type": "string" }, "collectionName": { "type": "string" }, "appName": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "amountInUSD", "groupingValue", "itemName", "contentUrl", "collectionName", "appName" ], "additionalProperties": false } }, "required": [ "id", "name", "groupingValue", "description", "imageUrl", "multimediaUrl", "multimediaType", "rarity", "color", "isHandcashCreated", "isVerified", "isListing", "count", "isCurrentUser" ], "additionalProperties": false }, "items-itemsSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "origin": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "alias": { "type": "string" }, "displayName": { "type": "string" }, "profilePictureUrl": { "type": "string" } }, "required": [ "id", "alias", "displayName", "profilePictureUrl" ], "additionalProperties": false }, "collection": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "isFeatured": { "type": "boolean" }, "origin": { "type": "string" }, "name": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": {} } }, "description": { "type": "string" }, "imageUrl": { "type": "string" }, "totalQuantity": { "type": "number", "format": "float" }, "isHandcashCreated": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "isVisibleInMarket": { "type": "boolean" }, "app": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "iconUrl": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "id", "isFeatured", "origin", "name", "description", "imageUrl", "totalQuantity", "isHandcashCreated", "isVerified", "isVisibleInMarket" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": false } ] }, "app": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "iconUrl": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, "name": { "type": "string" }, "groupingValue": { "type": "string" }, "description": { "type": "string" }, "imageUrl": { "type": "string" }, "multimediaUrl": { "type": "string" }, "multimediaType": { "type": "string" }, "rarity": { "type": "string" }, "color": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "anyOf": [ { "type": "string", "x-required": true }, { "type": "number", "format": "float", "x-required": true } ] }, "displayType": { "type": "string" } }, "required": [ "name", "displayType" ], "additionalProperties": false } }, "isHandcashCreated": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "isListing": { "type": "boolean" }, "itemListing": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "paymentRequestUrl": { "type": "string" }, "paymentRequestId": { "type": "string" }, "price": { "type": "number", "format": "float" }, "currencyCode": { "type": "string" }, "denominatedIn": { "type": "string" }, "fiatEquivalent": { "type": "object", "properties": { "amount": { "type": "number", "format": "float" }, "currencyCode": { "type": "string" } }, "required": [ "amount", "currencyCode" ], "additionalProperties": false }, "listedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "status", "paymentRequestUrl", "paymentRequestId", "price", "currencyCode", "denominatedIn", "listedAt" ], "additionalProperties": false }, "count": { "type": "number", "format": "float" }, "royalties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "percentage": { "type": "number", "format": "float" }, "destination": { "type": "string" } }, "required": [ "type", "percentage", "destination" ], "additionalProperties": false } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "name", "description", "url", "enabled" ], "additionalProperties": false } }, "isCurrentUser": { "type": "boolean" }, "floorPriceInUsd": { "type": "number", "format": "float" }, "lastSoldPriceInUsd": { "type": "number", "format": "float" }, "externalId": { "type": "string" }, "priceAlert": { "type": "object", "properties": { "amountInUSD": { "type": "number", "format": "float" }, "groupingValue": { "type": "string" }, "itemName": { "type": "string" }, "contentUrl": { "type": "string" }, "collectionName": { "type": "string" }, "appName": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "amountInUSD", "groupingValue", "itemName", "contentUrl", "collectionName", "appName" ], "additionalProperties": false } }, "required": [ "id", "name", "groupingValue", "description", "imageUrl", "multimediaUrl", "multimediaType", "rarity", "color", "isHandcashCreated", "isVerified", "isListing", "count", "isCurrentUser" ], "additionalProperties": false } } }, "additionalProperties": false }, "items-itemStatsSchema": { "type": "object", "properties": { "listingsCount": { "type": "number", "format": "float" }, "itemsCount": { "type": "number", "format": "float" } }, "required": [ "listingsCount", "itemsCount" ], "additionalProperties": false }, "items-itemTradeHistorySchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "totalVolumeInUSD": { "type": "number", "format": "float" }, "averagePriceInUSD": { "type": "number", "format": "float" } }, "required": [ "date", "totalVolumeInUSD", "averagePriceInUSD" ], "additionalProperties": false } } }, "additionalProperties": false }, "items-itemTransferSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "itemName": { "type": "string" }, "collectionName": { "type": "string" }, "contentUrl": { "type": "string" }, "operation": { "type": "string" }, "origin": { "type": "string" }, "groupingValue": { "type": "string" }, "amountInUSD": { "type": "number", "format": "float" }, "paymentTransactionId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "participant": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "operation", "origin", "groupingValue", "createdAt", "participant" ], "additionalProperties": false } } }, "additionalProperties": false }, "misc-exchangeRateSchema": { "type": "object", "properties": { "exchangeRateVersion": { "type": "string" }, "rate": { "type": "number", "format": "float" }, "fiatSymbol": { "type": "string" }, "estimatedExpireDate": { "type": "string", "format": "date-time" } }, "required": [ "exchangeRateVersion", "rate", "fiatSymbol", "estimatedExpireDate" ], "additionalProperties": false }, "paymentRequest-paymentRequestSchema": { "type": "object", "properties": { "id": { "type": "string" }, "paymentRequestUrl": { "type": "string" }, "paymentRequestQrCodeUrl": { "type": "string" }, "status": { "type": "string" }, "transactionId": { "type": "string" }, "redirectUrl": { "type": "string" }, "expiresAt": { "type": "string" }, "enabledAt": { "type": "string" }, "product": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "longDescription": { "type": "string" }, "imageUrl": { "type": "string" } }, "required": [ "name", "imageUrl" ], "additionalProperties": false }, "paymentAmount": { "type": "object", "properties": { "currencyCode": { "type": "string" }, "amount": { "type": "number", "format": "float" }, "denominatedIn": { "type": "string" } }, "required": [ "currencyCode", "amount", "denominatedIn" ], "additionalProperties": false }, "paymentsCount": { "type": "integer" }, "shop": { "type": "object", "properties": { "collectionId": { "type": "string" }, "packOrder": { "type": "number", "format": "float" }, "collectionOrder": { "type": "number", "format": "float" }, "appId": { "type": "string" } }, "required": [ "collectionId", "packOrder", "collectionOrder", "appId" ], "additionalProperties": false }, "totalUnits": { "type": "integer" }, "remainingUnits": { "type": "integer" }, "priceBeforeDiscount": { "type": "number", "format": "float" } }, "required": [ "id", "paymentRequestUrl", "paymentRequestQrCodeUrl", "status", "redirectUrl", "expiresAt", "product", "paymentAmount" ], "additionalProperties": false }, "paymentRequest-paymentRequestStatsSchema": { "type": "object", "properties": { "totalPayments": { "type": "integer" }, "totalVolume": { "type": "number", "format": "float" }, "uniqueUsers": { "type": "integer" } }, "required": [ "totalPayments", "totalVolume", "uniqueUsers" ], "additionalProperties": false }, "paymentRequest-privatePaymentRequestSchema": { "type": "object", "properties": { "id": { "type": "string" }, "paymentRequestUrl": { "type": "string" }, "paymentRequestQrCodeUrl": { "type": "string" }, "isEnabled": { "type": "boolean" }, "product": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "longDescription": { "type": "string" }, "imageUrl": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false }, "currencyCode": { "type": "string" }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "sendAmount": { "type": "number", "format": "float" }, "destination": { "type": "string" } }, "required": [ "sendAmount", "destination" ], "additionalProperties": false } }, "totalUnits": { "type": "number", "format": "float" }, "remainingUnits": { "type": "number", "format": "float" }, "priceBeforeDiscount": { "type": "number", "format": "float" }, "paymentAmount": { "type": "object", "properties": { "currencyCode": { "type": "string" }, "amount": { "type": "number", "format": "float" }, "denominatedIn": { "type": "string" } }, "required": [ "currencyCode", "amount", "denominatedIn" ], "additionalProperties": false }, "notifications": { "type": "object", "properties": { "webhook": { "type": "object", "properties": { "webhookUrl": { "type": "string" }, "customParameters": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "email": { "type": "string" } }, "additionalProperties": false }, "shop": { "type": "object", "properties": { "collectionId": { "type": "string" }, "packOrder": { "type": "number", "format": "float" }, "collectionOrder": { "type": "number", "format": "float" }, "appId": { "type": "string" } }, "required": [ "collectionId", "packOrder", "collectionOrder", "appId" ], "additionalProperties": false }, "requestedUserData": { "type": "array", "items": { "type": "string" } }, "redirectUrl": { "type": "string" }, "expiresAt": { "type": "string" }, "createdAt": { "type": "string" }, "enabledAt": { "type": "string" } }, "required": [ "id", "paymentRequestUrl", "paymentRequestQrCodeUrl", "isEnabled", "product", "currencyCode", "receivers", "paymentAmount", "expiresAt", "createdAt", "enabledAt" ], "additionalProperties": false }, "paymentRequest-privatePaymentRequestsSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "paymentRequestUrl": { "type": "string" }, "paymentRequestQrCodeUrl": { "type": "string" }, "isEnabled": { "type": "boolean" }, "product": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "longDescription": { "type": "string" }, "imageUrl": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false }, "currencyCode": { "type": "string" }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "sendAmount": { "type": "number", "format": "float" }, "destination": { "type": "string" } }, "required": [ "sendAmount", "destination" ], "additionalProperties": false } }, "totalUnits": { "type": "number", "format": "float" }, "remainingUnits": { "type": "number", "format": "float" }, "priceBeforeDiscount": { "type": "number", "format": "float" }, "paymentAmount": { "type": "object", "properties": { "currencyCode": { "type": "string" }, "amount": { "type": "number", "format": "float" }, "denominatedIn": { "type": "string" } }, "required": [ "currencyCode", "amount", "denominatedIn" ], "additionalProperties": false }, "notifications": { "type": "object", "properties": { "webhook": { "type": "object", "properties": { "webhookUrl": { "type": "string" }, "customParameters": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "email": { "type": "string" } }, "additionalProperties": false }, "shop": { "type": "object", "properties": { "collectionId": { "type": "string" }, "packOrder": { "type": "number", "format": "float" }, "collectionOrder": { "type": "number", "format": "float" }, "appId": { "type": "string" } }, "required": [ "collectionId", "packOrder", "collectionOrder", "appId" ], "additionalProperties": false }, "requestedUserData": { "type": "array", "items": { "type": "string" } }, "redirectUrl": { "type": "string" }, "expiresAt": { "type": "string" }, "createdAt": { "type": "string" }, "enabledAt": { "type": "string" } }, "required": [ "id", "paymentRequestUrl", "paymentRequestQrCodeUrl", "isEnabled", "product", "currencyCode", "receivers", "paymentAmount", "expiresAt", "createdAt", "enabledAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false }, "wallet-addressSchema": { "type": "object", "properties": { "base58Address": { "type": "string" }, "publicKey": { "type": "string" } }, "required": [ "base58Address" ], "additionalProperties": false }, "wallet-balancesSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "object", "properties": { "code": { "type": "string" }, "logoUrl": { "type": "string" }, "symbol": { "type": "string" } }, "required": [ "code", "logoUrl", "symbol" ], "additionalProperties": false }, "units": { "type": "number", "format": "float" }, "fiatEquivalent": { "type": "object", "properties": { "currencyCode": { "type": "string" }, "units": { "type": "number", "format": "float" } }, "required": [ "currencyCode", "units" ], "additionalProperties": false } }, "required": [ "units" ], "additionalProperties": false } } }, "additionalProperties": false }, "wallet-depositInfoSchema": { "type": "object", "properties": { "id": { "type": "string" }, "alias": { "type": "string" }, "paymail": { "type": "string", "format": "email" }, "base58Address": { "type": "string" } }, "required": [ "id", "alias", "paymail", "base58Address" ], "additionalProperties": false }, "wallet-spendableBalancesSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "spendableBalance": { "type": "number", "format": "float" }, "currencyCode": { "type": "string" } }, "required": [ "spendableBalance", "currencyCode" ], "additionalProperties": false } } }, "additionalProperties": false }, "wallet-transactionHistorySchema": { "type": "object", "properties": { "from": { "type": "number", "format": "float" }, "to": { "type": "number", "format": "float" }, "items": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "type": { "type": "string" }, "time": { "type": "number", "format": "float" }, "note": { "type": "string" }, "currency": { "type": "object", "properties": { "code": { "type": "string" }, "logoUrl": { "type": "string" }, "symbol": { "type": "string" } }, "required": [ "code", "logoUrl", "symbol" ], "additionalProperties": false }, "units": { "type": "number", "format": "float" }, "satoshiFees": { "type": "number", "format": "float" }, "fiatEquivalent": { "type": "object", "properties": { "currencyCode": { "type": "string" }, "units": { "type": "number", "format": "float" } }, "required": [ "currencyCode", "units" ], "additionalProperties": false }, "participants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "alias": { "type": "string" }, "displayName": { "type": "string" }, "profilePictureUrl": { "type": "string" }, "responseNote": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "type", "displayName", "profilePictureUrl", "responseNote" ], "additionalProperties": false } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "format": { "type": "string" }, "value": {} }, "required": [ "format", "value" ], "additionalProperties": false } }, "app": { "type": "object", "properties": { "name": { "type": "string" }, "iconUrl": { "type": "string" } }, "required": [ "name", "iconUrl" ], "additionalProperties": false }, "item": { "type": "object", "properties": { "imageUrl": { "type": "string" }, "name": { "type": "string" }, "collectionName": { "type": "string" }, "origin": { "type": "string" }, "groupingValue": { "type": "string" } }, "required": [ "imageUrl", "name", "collectionName", "origin", "groupingValue" ], "additionalProperties": false } }, "required": [ "transactionId", "type", "time", "note", "units", "satoshiFees" ], "additionalProperties": false } } }, "required": [ "from", "to" ], "additionalProperties": false }, "wallet-transactionRecordSchema": { "type": "object", "properties": { "transactionId": { "type": "string" }, "type": { "type": "string" }, "time": { "type": "number", "format": "float" }, "note": { "type": "string" }, "currency": { "type": "object", "properties": { "code": { "type": "string" }, "logoUrl": { "type": "string" }, "symbol": { "type": "string" } }, "required": [ "code", "logoUrl", "symbol" ], "additionalProperties": false }, "units": { "type": "number", "format": "float" }, "satoshiFees": { "type": "number", "format": "float" }, "fiatEquivalent": { "type": "object", "properties": { "currencyCode": { "type": "string" }, "units": { "type": "number", "format": "float" } }, "required": [ "currencyCode", "units" ], "additionalProperties": false }, "participants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "alias": { "type": "string" }, "displayName": { "type": "string" }, "profilePictureUrl": { "type": "string" }, "responseNote": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "type", "displayName", "profilePictureUrl", "responseNote" ], "additionalProperties": false } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "format": { "type": "string" }, "value": {} }, "required": [ "format", "value" ], "additionalProperties": false } }, "app": { "type": "object", "properties": { "name": { "type": "string" }, "iconUrl": { "type": "string" } }, "required": [ "name", "iconUrl" ], "additionalProperties": false }, "item": { "type": "object", "properties": { "imageUrl": { "type": "string" }, "name": { "type": "string" }, "collectionName": { "type": "string" }, "origin": { "type": "string" }, "groupingValue": { "type": "string" } }, "required": [ "imageUrl", "name", "collectionName", "origin", "groupingValue" ], "additionalProperties": false } }, "required": [ "transactionId", "type", "time", "note", "units", "satoshiFees" ], "additionalProperties": false }, "wallet-transactionTemplateSchema": { "type": "object", "properties": { "unsignedTransactionHex": { "type": "string" }, "unsignedTransactionTemplateId": { "type": "string" }, "requiredSignatures": { "type": "array", "items": { "type": "object", "properties": { "inputIndex": { "type": "integer" }, "derivationPath": { "type": "string" }, "signatureHash": { "type": "string" } }, "required": [ "inputIndex", "derivationPath", "signatureHash" ], "additionalProperties": false }, "minItems": 1 } }, "required": [ "unsignedTransactionHex", "unsignedTransactionTemplateId", "requiredSignatures" ], "additionalProperties": false } }, "securitySchemes": { "AppId": { "type": "apiKey", "name": "app-id", "in": "header" }, "AppSecret": { "type": "apiKey", "name": "app-secret", "in": "header" }, "PublicKey": { "type": "apiKey", "in": "header", "name": "oauth-publickey", "description": "Public key used to verify the payload's signature." }, "Signature": { "type": "apiKey", "in": "header", "name": "oauth-signature", "description": "Signature generated by signing the request payload with the associated private key." }, "Nonce": { "type": "apiKey", "in": "header", "name": "oauth-nonce", "description": "A unique value to prevent replay attacks. Each request should have a unique nonce." }, "Timestamp": { "type": "apiKey", "in": "header", "name": "oauth-timestamp", "description": "Current timestamp (in milliseconds) to validate the freshness of the request." }, "AppPrivateKey": { "type": "apiKey", "in": "header", "name": "oauth-privatekey", "description": "App (SDK) private key associated with the oauth-publickey. Only used for generating signatures automatically in Swagger UI and must NEVER be used in production code due to security reasons." } } }, "paths": { "/v1/waas/account/requestEmailCode": { "post": { "tags": [ "Wallet API" ], "summary": "Request an email code for external account creation.", "security": [ { "AppId": [] }, { "AppSecret": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "customEmailParameters": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "email" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account-requestEmailCodeSchema" } } } } } } }, "/v1/waas/account": { "post": { "tags": [ "Wallet API" ], "summary": "Create a new external wallet account.", "security": [ { "AppId": [] }, { "AppSecret": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accessPublicKey": { "type": "string" }, "email": { "type": "string", "format": "email" }, "alias": { "type": "string" } }, "required": [ "accessPublicKey", "email", "alias" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-depositInfoSchema" } } } } } } }, "/v1/waas/account/selfCustodial": { "post": { "tags": [ "Wallet API" ], "summary": "Create a new self-custody wallet", "security": [ { "AppId": [] }, { "AppSecret": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "walletExtendedPublicKey": { "type": "string" }, "alias": { "type": "string" } }, "required": [ "walletExtendedPublicKey" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-depositInfoSchema" } } } } } } }, "/v1/waas/account/accessKey": { "post": { "tags": [ "Wallet API" ], "summary": "Activate an access key for an existing Wallet-API account.", "security": [ { "AppId": [] }, { "AppSecret": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accessPublicKey": { "type": "string" }, "email": { "type": "string", "format": "email" } }, "required": [ "accessPublicKey", "email" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-depositInfoSchema" } } } } } } }, "/v1/waas/account/aliasAvailability/{alias}": { "get": { "tags": [ "Wallet API" ], "summary": "Check if an alias is available for external account creation.", "security": [ { "AppId": [] }, { "AppSecret": [] } ], "parameters": [ { "name": "alias", "schema": { "type": "string", "pattern": "^(?=.*[a-zA-Z0-9])[\\w\\-.]{4,50}$" }, "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account-aliasAvailabilitySchema" } } } } } } }, "/v1/waas/wallet/pay": { "post": { "tags": [ "Wallet API" ], "summary": "Perform a payment.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "exchangeRateVersion": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "instrumentCurrencyCode": { "type": "string", "enum": [ "MNEE", "BSV" ] }, "denominationCurrencyCode": { "oneOf": [ { "type": "string", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "CNH", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] } ] }, "note": { "type": "string" }, "attachment": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "hex", "base64", "json", "hexArray" ] }, "value": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": false, "x-required": true }, { "oneOf": [ { "type": "array", "items": { "type": "string" }, "minItems": 1, "x-required": true }, { "oneOf": [ { "type": "string", "x-required": true }, { "oneOf": [ { "type": "string", "x-required": true } ] } ] } ] } ] } }, "required": [ "format" ], "additionalProperties": false }, "receivers": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "sendAmount": { "type": "number", "format": "float" }, "destination": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[\\w\\-_. ]{3,25}$" } } }, "required": [ "sendAmount", "destination" ], "additionalProperties": false }, "minItems": 0, "maxItems": 300, "default": [] }, { "type": "array", "items": { "type": "object", "properties": { "sendAmount": { "type": "number", "format": "float" }, "destination": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[\\w\\-_. ]{3,25}$" } } }, "required": [ "sendAmount", "destination" ], "additionalProperties": false }, "minItems": 1, "maxItems": 300, "x-required": true } ] } }, "required": [ "instrumentCurrencyCode" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-transactionRecordSchema" } } } } } } }, "/v1/waas/wallet/selfCustody/pay/template": { "post": { "tags": [ "Wallet API" ], "summary": "Create a new transaction template that requires signing the inputs", "security": [ { "AppId": [] }, { "AppSecret": [] }, { "XPub": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "exchangeRateVersion": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "note": { "type": "string" }, "appAction": { "type": "string", "pattern": "^[\\w\\-_. ]{3,25}$" }, "attachment": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "hex", "base64", "json", "hexArray" ] }, "value": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": false, "x-required": true }, { "oneOf": [ { "type": "array", "items": { "type": "string" }, "minItems": 1, "x-required": true }, { "oneOf": [ { "type": "string", "x-required": true }, { "oneOf": [ { "type": "string", "x-required": true } ] } ] } ] } ] } }, "required": [ "format" ], "additionalProperties": false }, "receivers": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "sendAmount": { "type": "number", "format": "float" }, "denominationCurrencyCode": { "type": "string", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "CNH", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL", "SAT", "BSV" ], "title": "currencyCode" }, "destination": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[\\w\\-_. ]{3,25}$" } } }, "required": [ "sendAmount", "denominationCurrencyCode", "destination" ], "additionalProperties": false }, "minItems": 0, "maxItems": 1000, "default": [] }, { "type": "array", "items": { "type": "object", "properties": { "sendAmount": { "type": "number", "format": "float" }, "denominationCurrencyCode": { "type": "string", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "CNH", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL", "SAT", "BSV" ], "title": "currencyCode" }, "destination": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[\\w\\-_. ]{3,25}$" } } }, "required": [ "sendAmount", "denominationCurrencyCode", "destination" ], "additionalProperties": false }, "minItems": 1, "maxItems": 1000, "x-required": true } ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-transactionTemplateSchema" } } } } } } }, "/v1/waas/wallet/selfCustody/pay/broadcast": { "post": { "tags": [ "Wallet API" ], "summary": "Broadcasts a signed transaction template", "security": [ { "AppId": [] }, { "AppSecret": [] }, { "XPub": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "unsignedTransactionTemplateId": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "signatures": { "type": "array", "items": { "type": "object", "properties": { "inputIndex": { "type": "number", "format": "float" }, "publicKey": { "type": "string" }, "signature": { "type": "string" } }, "required": [ "inputIndex", "publicKey", "signature" ], "additionalProperties": false } } }, "required": [ "unsignedTransactionTemplateId", "signatures" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-transactionRecordSchema" } } } } } } }, "/v1/waas/wallet/depositInfo": { "get": { "tags": [ "Wallet API" ], "summary": "Retrieve deposit info for a Wallet-API account.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-depositInfoSchema" } } } } } } }, "/v1/waas/wallet/transaction": { "get": { "tags": [ "Wallet API" ], "summary": "Retrieve details for a specific payment.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "parameters": [ { "name": "transactionId", "schema": { "type": "string" }, "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-transactionRecordSchema" } } } } } } }, "/v1/waas/wallet/transactions": { "get": { "tags": [ "Wallet API" ], "summary": "Retrieve a paginated list of transactions.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "parameters": [ { "name": "from", "schema": { "type": "integer" }, "in": "query", "required": false }, { "name": "to", "schema": { "type": "integer", "default": 20 }, "in": "query", "required": false }, { "name": "appId", "schema": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "in": "query", "required": false }, { "name": "excludeApps", "schema": { "type": "boolean", "default": false }, "in": "query", "required": false }, { "name": "currencyCode", "schema": { "type": "string", "enum": [ "MNEE", "BSV" ] }, "in": "query", "required": false }, { "name": "fromDate", "schema": { "type": "string", "format": "date-time" }, "in": "query", "required": false }, { "name": "toDate", "schema": { "type": "string", "format": "date-time" }, "in": "query", "required": false }, { "name": "tag", "schema": { "type": "string" }, "in": "query", "required": false }, { "name": "participant", "schema": { "type": "string" }, "in": "query", "required": false }, { "name": "type", "schema": { "type": "string", "enum": [ "send", "receive", "consolidation", "other" ] }, "in": "query", "required": false }, { "name": "minValue", "schema": { "type": "number", "format": "float", "minimum": 0 }, "in": "query", "required": false }, { "name": "maxValue", "schema": { "type": "number", "format": "float", "minimum": 0 }, "in": "query", "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-transactionHistorySchema" } } } } } } }, "/v1/waas/wallet/balances": { "get": { "tags": [ "Wallet API" ], "summary": "Retrieve wallet balances.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-balancesSchema" } } } } } } }, "/v1/waas/wallet/selfCustody/depositInfo": { "get": { "tags": [ "Wallet API" ], "summary": "Retrieve deposit info for a self-custodial Wallet-API account.", "security": [ { "AppId": [] }, { "AppSecret": [] }, { "XPub": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-depositInfoSchema" } } } } } } }, "/v1/waas/wallet/selfCustody/transaction": { "get": { "tags": [ "Wallet API" ], "summary": "Retrieve details for a specific payment.", "security": [ { "AppId": [] }, { "AppSecret": [] }, { "XPub": [] } ], "parameters": [ { "name": "transactionId", "schema": { "type": "string" }, "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-transactionRecordSchema" } } } } } } }, "/v1/waas/wallet/selfCustody/transactions": { "get": { "tags": [ "Wallet API" ], "summary": "Retrieve a paginated list of transactions.", "security": [ { "AppId": [] }, { "AppSecret": [] }, { "XPub": [] } ], "parameters": [ { "name": "from", "schema": { "type": "integer" }, "in": "query", "required": false }, { "name": "to", "schema": { "type": "integer", "default": 20 }, "in": "query", "required": false }, { "name": "appId", "schema": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "in": "query", "required": false }, { "name": "excludeApps", "schema": { "type": "boolean", "default": false }, "in": "query", "required": false }, { "name": "currencyCode", "schema": { "type": "string", "enum": [ "MNEE", "BSV" ] }, "in": "query", "required": false }, { "name": "fromDate", "schema": { "type": "string", "format": "date-time" }, "in": "query", "required": false }, { "name": "toDate", "schema": { "type": "string", "format": "date-time" }, "in": "query", "required": false }, { "name": "tag", "schema": { "type": "string" }, "in": "query", "required": false }, { "name": "participant", "schema": { "type": "string" }, "in": "query", "required": false }, { "name": "type", "schema": { "type": "string", "enum": [ "send", "receive", "consolidation", "other" ] }, "in": "query", "required": false }, { "name": "minValue", "schema": { "type": "number", "format": "float", "minimum": 0 }, "in": "query", "required": false }, { "name": "maxValue", "schema": { "type": "number", "format": "float", "minimum": 0 }, "in": "query", "required": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-transactionHistorySchema" } } } } } } }, "/v1/waas/wallet/selfCustody/balances": { "get": { "tags": [ "Wallet API" ], "summary": "Retrieve wallet balances.", "security": [ { "AppId": [] }, { "AppSecret": [] }, { "XPub": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-balancesSchema" } } } } } } }, "/v1/waas/exchangeRate/{currencyCode}": { "get": { "tags": [ "Wallet API" ], "summary": "Retrieve the BSV exchange rate in the specified currency.", "security": [], "parameters": [ { "name": "currencyCode", "schema": { "type": "string", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "CNH", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/misc-exchangeRateSchema" } } } } } } }, "/v1/waas/item-orders/{itemCreationOrderId}/items": { "get": { "tags": [ "Wallet API" ], "summary": "Retrieve items associated with a specific item creation order.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] } ], "parameters": [ { "name": "itemCreationOrderId", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/items-itemsSchema" } } } } } } }, "/v1/waas/item-orders/{itemCreationOrderId}": { "get": { "tags": [ "Wallet API" ], "summary": "Retrieve details for a specific item creation order.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] } ], "parameters": [ { "name": "itemCreationOrderId", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/items-itemCreationOrderSchema" } } } } } } }, "/v1/waas/item-orders/issue": { "post": { "tags": [ "Wallet API" ], "summary": "Issue items for a creation order.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "uid": { "type": "string" }, "itemCreationOrderType": { "type": "string", "enum": [ "collection", "collectionItem" ] }, "items": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "groupingValue": { "type": "string" }, "color": { "type": "string", "pattern": "^#[A-Fa-f0-9]{6}$" }, "mediaDetails": { "type": "object", "properties": { "image": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "imageHighResUrl": { "type": "string", "maxLength": 2048 }, "contentType": { "type": "string", "enum": [ "image/png", "image/jpg", "image/jpeg", "image/webp" ] } }, "required": [ "url", "contentType" ], "additionalProperties": false }, "multimedia": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "contentType": { "type": "string" } }, "required": [ "url", "contentType" ], "additionalProperties": false } }, "required": [ "image" ], "additionalProperties": false }, "user": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "quantity": { "type": "integer", "minimum": 1, "maximum": 1000000, "default": 1 }, "rarity": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "displayType": { "type": "string" }, "value": { "anyOf": [ { "type": "number", "format": "float", "x-required": true }, { "type": "string", "x-required": true } ] } }, "required": [ "name", "displayType" ], "additionalProperties": false }, "default": [] }, "actions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string", "maxLength": 2048 }, "enabled": { "type": "boolean", "default": true } }, "required": [ "name", "description", "url" ], "additionalProperties": false } }, "royalties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "paymail", "address", "script" ] }, "percentage": { "type": "number", "format": "float", "minimum": 0, "maximum": 100 }, "destination": { "type": "string" } }, "required": [ "type", "percentage", "destination" ], "additionalProperties": false } }, "externalId": { "type": "string" } }, "required": [ "name", "mediaDetails" ], "additionalProperties": false }, "minItems": 0 }, { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "groupingValue": { "type": "string" }, "color": { "type": "string", "pattern": "^#[A-Fa-f0-9]{6}$" }, "mediaDetails": { "type": "object", "properties": { "image": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "imageHighResUrl": { "type": "string", "maxLength": 2048 }, "contentType": { "type": "string", "enum": [ "image/png", "image/jpg", "image/jpeg", "image/webp" ] } }, "required": [ "url", "contentType" ], "additionalProperties": false }, "multimedia": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "contentType": { "type": "string" } }, "required": [ "url", "contentType" ], "additionalProperties": false } }, "required": [ "image" ], "additionalProperties": false }, "user": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "totalQuantity": { "type": "integer" } }, "required": [ "name", "mediaDetails" ], "additionalProperties": false }, "minItems": 1, "maxItems": 1 } ] }, "referencedCollection": { "oneOf": [ { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011", "x-required": true } ] } }, "required": [ "itemCreationOrderType" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/items-itemCreationOrderSchema" } } } } } } }, "/v1/waas/item-orders/burn-and-create": { "post": { "tags": [ "Wallet API" ], "summary": "Burn and create new items in a single operation.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "burn": { "type": "object", "properties": { "origins": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 1000 } }, "required": [ "origins" ], "additionalProperties": false }, "issue": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "groupingValue": { "type": "string" }, "color": { "type": "string", "pattern": "^#[A-Fa-f0-9]{6}$" }, "mediaDetails": { "type": "object", "properties": { "image": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "imageHighResUrl": { "type": "string", "maxLength": 2048 }, "contentType": { "type": "string", "enum": [ "image/png", "image/jpg", "image/jpeg", "image/webp" ] } }, "required": [ "url", "contentType" ], "additionalProperties": false }, "multimedia": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "contentType": { "type": "string" } }, "required": [ "url", "contentType" ], "additionalProperties": false } }, "required": [ "image" ], "additionalProperties": false }, "user": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "quantity": { "type": "integer", "minimum": 1, "maximum": 1000000, "default": 1 }, "rarity": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "displayType": { "type": "string" }, "value": { "anyOf": [ { "type": "number", "format": "float", "x-required": true }, { "type": "string", "x-required": true } ] } }, "required": [ "name", "displayType" ], "additionalProperties": false }, "default": [] }, "actions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string", "maxLength": 2048 }, "enabled": { "type": "boolean", "default": true } }, "required": [ "name", "description", "url" ], "additionalProperties": false } }, "royalties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "paymail", "address", "script" ] }, "percentage": { "type": "number", "format": "float", "minimum": 0, "maximum": 100 }, "destination": { "type": "string" } }, "required": [ "type", "percentage", "destination" ], "additionalProperties": false } }, "externalId": { "type": "string" } }, "required": [ "name", "mediaDetails" ], "additionalProperties": false }, "minItems": 1, "maxItems": 100 }, "referencedCollection": { "type": "string" }, "uid": { "type": "string" }, "itemCreationOrderType": { "type": "string", "enum": [ "collectionItem" ] } }, "required": [ "referencedCollection" ], "additionalProperties": false } }, "required": [ "burn" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "TODO", "content": { "application/json": { "schema": { "type": "object", "properties": { "[[TODO]]": { "type": "string" } }, "additionalProperties": false } } } } }, "operationId": "burnAndCreate" } }, "/v1/waas/items/transfer": { "post": { "tags": [ "Wallet API" ], "summary": "Transfer items to another user or address.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "destinationsWithOrigins": { "type": "array", "items": { "type": "object", "properties": { "destination": { "anyOf": [ { "type": "string", "pattern": "^[\\w\\-_.]{3,50}$", "x-required": true }, { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" } ] }, "origins": { "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "required": [ "destination", "origins" ], "additionalProperties": false } } }, "required": [ "destinationsWithOrigins" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "TODO", "content": { "application/json": { "schema": { "type": "object", "properties": { "[[TODO]]": { "type": "string" } }, "additionalProperties": false } } } } } } }, "/v1/waas/items/{origin}": { "get": { "tags": [ "Wallet API" ], "summary": "Retrieve item details by origin.", "security": [], "parameters": [ { "name": "origin", "schema": { "type": "string" }, "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/items-itemSchema" } } } } } } }, "/v1/waas/items": { "post": { "tags": [ "Wallet API" ], "summary": "Retrieve a list of items.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "integer", "minimum": 0 }, "to": { "type": "integer", "default": 20 }, "collectionId": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011", "deprecated": true }, "collectionIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "minItems": 1 }, "searchString": { "type": "string" }, "groupingValue": { "type": "string" }, "fetchAttributes": { "type": "boolean", "default": false }, "sort": { "type": "string", "enum": [ "name" ], "default": "name" }, "order": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "displayType": { "type": "string", "enum": [ "string", "number" ] }, "operation": { "oneOf": [ { "type": "string", "enum": [ "equal", "includes", "matches" ], "x-required": true }, { "type": "string", "enum": [ "equal", "greater", "lower", "greaterOrEqual", "lowerOrEqual" ], "x-required": true } ] }, "value": { "oneOf": [ { "oneOf": [ { "type": "string", "x-required": true }, { "type": "number", "format": "float", "x-required": true } ] } ] }, "values": { "oneOf": [ { "type": "array", "items": { "oneOf": [ { "type": "string", "x-required": true }, { "type": "number", "format": "float", "x-required": true } ] }, "minItems": 1 } ] } }, "required": [ "name", "displayType" ], "additionalProperties": false } }, "appId": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "group": { "type": "boolean", "default": false }, "externalId": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/items-itemsSchema" } } } } } } }, "/v3/connect/profile/currentUserProfile": { "get": { "tags": [ "Connect" ], "summary": "Get a current user profile", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account-fullUserProfileSchema" } } } } }, "operationId": "getCurrentUserProfile" } }, "/v3/connect/profile/publicUserProfiles": { "get": { "tags": [ "Connect" ], "summary": "Get user profiles", "security": [ { "AppId": [] }, { "AppSecret": [] } ], "parameters": [ { "name": "aliases", "schema": { "type": "array", "items": { "anyOf": [ { "type": "string", "pattern": "^[\\w\\-_.]{3,50}$", "x-required": true }, { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" } ] }, "minItems": 1, "maxItems": 500 }, "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account-fullPublicProfilesSchema" } } } } }, "operationId": "getPublicUserProfiles" } }, "/v3/connect/profile/permissions": { "get": { "tags": [ "Connect" ], "summary": "Get users permissions", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connect-permissionsSchema" } } } } }, "operationId": "getPermissions" } }, "/v3/connect/exchangeRate/{currencyCode}": { "get": { "tags": [ "Connect" ], "summary": "Retrieve the BSV exchange rate in the specified currency.", "security": [ { "AppId": [] }, { "AppSecret": [] } ], "parameters": [ { "name": "currencyCode", "schema": { "type": "string", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "CNH", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] }, "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/misc-exchangeRateSchema" } } } } }, "operationId": "getExchangeRate" } }, "/v3/connect/wallet/address": { "get": { "tags": [ "Connect" ], "summary": "Get a legacy deposit address", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-addressSchema" } } } } }, "operationId": "getDepositAddress" } }, "/v3/connect/wallet/balances": { "get": { "tags": [ "Connect" ], "summary": "Retrieve wallet balances.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-balancesSchema" } } } } }, "operationId": "getBalances" } }, "/v3/connect/wallet/spendableBalances": { "get": { "tags": [ "Connect" ], "summary": "Retrieve wallets spendable balances.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-spendableBalancesSchema" } } } } }, "operationId": "getSpendableBalances" } }, "/v3/connect/wallet/pay": { "post": { "tags": [ "Connect" ], "summary": "Make a payment", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "exchangeRateVersion": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "instrumentCurrencyCode": { "type": "string", "enum": [ "MNEE", "BSV" ] }, "denominationCurrencyCode": { "oneOf": [ { "type": "string", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "CNH", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ] } ] }, "note": { "type": "string" }, "attachment": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "hex", "base64", "json", "hexArray" ] }, "value": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": false, "x-required": true }, { "oneOf": [ { "type": "array", "items": { "type": "string" }, "minItems": 1, "x-required": true }, { "oneOf": [ { "type": "string", "x-required": true }, { "oneOf": [ { "type": "string", "x-required": true } ] } ] } ] } ] } }, "required": [ "format" ], "additionalProperties": false }, "receivers": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "sendAmount": { "type": "number", "format": "float" }, "destination": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[\\w\\-_. ]{3,25}$" } } }, "required": [ "sendAmount", "destination" ], "additionalProperties": false }, "minItems": 0, "maxItems": 300, "default": [] }, { "type": "array", "items": { "type": "object", "properties": { "sendAmount": { "type": "number", "format": "float" }, "destination": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[\\w\\-_. ]{3,25}$" } } }, "required": [ "sendAmount", "destination" ], "additionalProperties": false }, "minItems": 1, "maxItems": 300, "x-required": true } ] } }, "required": [ "instrumentCurrencyCode" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-transactionRecordSchema" } } } } }, "operationId": "pay" } }, "/v3/connect/wallet/payment": { "get": { "tags": [ "Connect" ], "summary": "Retrieve details for a specific payment.", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "parameters": [ { "name": "transactionId", "schema": { "type": "string" }, "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wallet-transactionRecordSchema" } } } } }, "operationId": "getPaymentDetails" } }, "/v3/connect/items/inventory": { "post": { "tags": [ "Connect" ], "summary": "Get items inventory", "security": [ { "PublicKey": [] }, { "Signature": [] }, { "Nonce": [] }, { "Timestamp": [] }, { "AppPrivateKey": [] }, { "AppId": [] }, { "AppSecret": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "integer", "minimum": 0 }, "to": { "type": "integer", "default": 20 }, "collectionIds": { "type": "array", "items": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "minItems": 1 }, "searchString": { "type": "string" }, "groupingValue": { "type": "string" }, "fetchAttributes": { "type": "boolean", "default": false }, "sort": { "type": "string", "enum": [ "name" ], "default": "name" }, "order": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "displayType": { "type": "string", "enum": [ "string", "number" ] }, "operation": { "oneOf": [ { "type": "string", "enum": [ "equal", "includes", "matches" ], "x-required": true }, { "type": "string", "enum": [ "equal", "greater", "lower", "greaterOrEqual", "lowerOrEqual" ], "x-required": true } ] }, "value": { "oneOf": [ { "oneOf": [ { "type": "string", "x-required": true }, { "type": "number", "format": "float", "x-required": true } ] } ] }, "values": { "oneOf": [ { "type": "array", "items": { "oneOf": [ { "type": "string", "x-required": true }, { "type": "number", "format": "float", "x-required": true } ] }, "minItems": 1 } ] } }, "required": [ "name", "displayType" ], "additionalProperties": false } }, "group": { "type": "boolean", "default": true }, "externalId": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/items-itemsSchema" } } } } }, "operationId": "getItemsInventory" } }, "/v3/friends/": { "post": { "tags": [ "Users" ], "summary": "Save user as a friend", "security": [ { "DeviceAccessToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "alias": { "anyOf": [ { "type": "string", "pattern": "^[\\w\\-_.]{3,50}$", "x-required": true }, { "type": "string", "format": "email" } ] } }, "required": [ "alias" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account-profileAPIDefinition" } } } } } }, "get": { "tags": [ "Users" ], "summary": "Get all the saved friend", "security": [ { "DeviceAccessToken": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account-profilesSchema" } } } } } } }, "/v3/friends/{id}": { "delete": { "tags": [ "Users" ], "summary": "Delete a friend", "security": [ { "DeviceAccessToken": [] } ], "parameters": [ { "name": "id", "schema": { "type": "string", "pattern": "^[a-fA-F0-9]{24}$", "example": "507f1f77bcf86cd799439011" }, "in": "path", "required": true } ], "responses": { "200": { "description": "OK" } } } }, "/v3/paymentRequests/": { "post": { "tags": [ "Payment Requests" ], "summary": "Create a new payment request.", "security": [ { "AppId": [] }, { "AppSecret": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "product": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 25 }, "description": { "type": "string", "maxLength": 200 }, "longDescription": { "type": "string", "maxLength": 500 }, "imageUrl": { "type": "string", "maxLength": 2048 } }, "required": [ "name" ], "additionalProperties": false }, "instrumentCurrencyCode": { "type": "string", "enum": [ "MNEE", "BSV" ] }, "denominationCurrencyCode": { "oneOf": [ { "type": "string", "minLength": 3, "maxLength": 3, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "CNH", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMK", "ZMW", "ZWL" ], "default": "BSV" } ] }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "sendAmount": { "type": "number", "format": "float" }, "destination": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string", "pattern": "^[\\w\\-_. ]{3,25}$" } } }, "required": [ "sendAmount", "destination" ], "additionalProperties": false }, "minItems": 1, "maxItems": 1000 }, "requestedUserData": { "type": "array", "items": { "type": "string", "enum": [ "paymail", "email", "phoneNumber" ] }, "default": [] }, "paymentMethods": { "type": "array", "items": { "type": "string", "enum": [ "onChain", "externalPaymentProcessor" ] }, "default": [ "onChain" ] }, "redirectUrl": { "type": "string", "pattern": "https:\\/\\/(?=\\w*)|http:\\/\\/(?=localhost)|(?