Inventory, payments and management
object (CurrencyGroup) |
OK
Client error
Server error
{- "currencyGroup": {
- "id": 0,
- "name": "string",
- "tokens": [
- {
- "chainId": 0,
- "currencyGroupId": 0,
- "id": 0,
- "tokenAddress": "string"
}
]
}
}
{- "groupId": 0
}
{- "friendAddress": "string",
- "optionalNickname": "string"
}
{- "friend": {
- "createdAt": "string",
- "friendAddress": "string",
- "id": 0,
- "nickname": "string",
- "user": {
- "address": "string",
- "avatar": "string",
- "backup": true,
- "backupConfirmed": true,
- "bio": "string",
- "createdAt": "string",
- "locale": "string",
- "location": "string",
- "maxInvites": 0,
- "normalizedUsername": "string",
- "sysAdmin": true,
- "updatedAt": "string",
- "username": "string"
}, - "userAddress": "string"
}, - "status": true
}
object (InventoryPaymentConfig) |
OK
Client error
Server error
{- "config": {
- "allowCrossChainPayments": true,
- "callbackURL": "string",
- "chainId": 0,
- "chainedCallAddress": "string",
- "chainedCallData": "string",
- "createdAt": "string",
- "deletedAt": "string",
- "externalProductId": "string",
- "id": 0,
- "paymentAmount": 0,
- "paymentRecipient": "string",
- "paymentTokenAddress": "string",
- "paymentTokenId": 0,
- "paymentTokenType": "ERC20",
- "projectId": 0
}
}
{- "configId": 0
}
{- "args": [
- "string"
], - "chainID": "string",
- "contract": "string",
- "inputExpr": "string",
- "outputExpr": "string"
}
{- "returns": [
- "string"
]
}
{- "callData": "string"
}
{- "call": {
- "args": [
- {
- "name": "string",
- "type": "string",
- "value": { }
}
], - "function": "string",
- "signature": "string"
}
}
{- "nickname": "string",
- "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}
}
{- "friends": [
- {
- "createdAt": "string",
- "friendAddress": "string",
- "id": 0,
- "nickname": "string",
- "user": {
- "address": "string",
- "avatar": "string",
- "backup": true,
- "backupConfirmed": true,
- "bio": "string",
- "createdAt": "string",
- "locale": "string",
- "location": "string",
- "maxInvites": 0,
- "normalizedUsername": "string",
- "sysAdmin": true,
- "updatedAt": "string",
- "username": "string"
}, - "userAddress": "string"
}
], - "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}
}
Auth TODO: rename 'ewtString' arg to 'ethauthProof'
OK
Client error
Server error
{- "ewtString": "string",
- "testnetMode": true
}
{- "address": "string",
- "jwtToken": "string",
- "status": true,
- "user": {
- "address": "string",
- "avatar": "string",
- "backup": true,
- "backupConfirmed": true,
- "bio": "string",
- "createdAt": "string",
- "locale": "string",
- "location": "string",
- "maxInvites": 0,
- "normalizedUsername": "string",
- "sysAdmin": true,
- "updatedAt": "string",
- "username": "string"
}
}
{- "chainID": "string",
- "ewtString": "string"
}
{- "address": "string",
- "jwtToken": "string",
- "status": true,
- "user": {
- "address": "string",
- "avatar": "string",
- "backup": true,
- "backupConfirmed": true,
- "bio": "string",
- "createdAt": "string",
- "locale": "string",
- "location": "string",
- "maxInvites": 0,
- "normalizedUsername": "string",
- "sysAdmin": true,
- "updatedAt": "string",
- "username": "string"
}
}
Price Feed
Array of objects (Token) []Token |
OK
Client error
Server error
{- "tokens": [
- {
- "collectionId": 0,
- "metadata": {
- "animationUrl": "string",
- "assets": [
- {
- "collectionId": 0,
- "filename": "string",
- "filesize": 0,
- "height": 0,
- "id": 0,
- "metadataField": "string",
- "mimeType": "string",
- "tokenId": "string",
- "updatedAt": "string",
- "url": "string",
- "width": 0
}
], - "attributes": [
- {
- "property1": { },
- "property2": { }
}
], - "audio": "string",
- "backgroundColor": "string",
- "decimals": 0,
- "description": "string",
- "externalUrl": "string",
- "image": "string",
- "imageData": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "tokenId": "string",
- "updatedAt": "string",
- "video": "string"
}, - "private": true,
- "searchColumn": "string",
- "tokenId": "string",
- "updatedAt": "string"
}
]
}
{- "tokenPrices": [
- {
- "buyPrice": {
- "currency": "string",
- "value": 0
}, - "floorPrice": {
- "currency": "string",
- "value": 0
}, - "price": {
- "currency": "string",
- "value": 0
}, - "price24hChange": {
- "currency": "string",
- "value": 0
}, - "sellPrice": {
- "currency": "string",
- "value": 0
}, - "token": {
- "collectionId": 0,
- "metadata": {
- "animationUrl": "string",
- "assets": [
- {
- "collectionId": 0,
- "filename": "string",
- "filesize": 0,
- "height": 0,
- "id": 0,
- "metadataField": "string",
- "mimeType": "string",
- "tokenId": "string",
- "updatedAt": "string",
- "url": "string",
- "width": 0
}
], - "attributes": [
- {
- "property1": { },
- "property2": { }
}
], - "audio": "string",
- "backgroundColor": "string",
- "decimals": 0,
- "description": "string",
- "externalUrl": "string",
- "image": "string",
- "imageData": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "tokenId": "string",
- "updatedAt": "string",
- "video": "string"
}, - "private": true,
- "searchColumn": "string",
- "tokenId": "string",
- "updatedAt": "string"
}, - "updatedAt": "string"
}
]
}
Array of objects (Token) []Token |
OK
Client error
Server error
{- "tokens": [
- {
- "collectionId": 0,
- "metadata": {
- "animationUrl": "string",
- "assets": [
- {
- "collectionId": 0,
- "filename": "string",
- "filesize": 0,
- "height": 0,
- "id": 0,
- "metadataField": "string",
- "mimeType": "string",
- "tokenId": "string",
- "updatedAt": "string",
- "url": "string",
- "width": 0
}
], - "attributes": [
- {
- "property1": { },
- "property2": { }
}
], - "audio": "string",
- "backgroundColor": "string",
- "decimals": 0,
- "description": "string",
- "externalUrl": "string",
- "image": "string",
- "imageData": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "tokenId": "string",
- "updatedAt": "string",
- "video": "string"
}, - "private": true,
- "searchColumn": "string",
- "tokenId": "string",
- "updatedAt": "string"
}
]
}
{- "tokenPrices": [
- {
- "buyPrice": {
- "currency": "string",
- "value": 0
}, - "floorPrice": {
- "currency": "string",
- "value": 0
}, - "price": {
- "currency": "string",
- "value": 0
}, - "price24hChange": {
- "currency": "string",
- "value": 0
}, - "sellPrice": {
- "currency": "string",
- "value": 0
}, - "token": {
- "collectionId": 0,
- "metadata": {
- "animationUrl": "string",
- "assets": [
- {
- "collectionId": 0,
- "filename": "string",
- "filesize": 0,
- "height": 0,
- "id": 0,
- "metadataField": "string",
- "mimeType": "string",
- "tokenId": "string",
- "updatedAt": "string",
- "url": "string",
- "width": 0
}
], - "attributes": [
- {
- "property1": { },
- "property2": { }
}
], - "audio": "string",
- "backgroundColor": "string",
- "decimals": 0,
- "description": "string",
- "externalUrl": "string",
- "image": "string",
- "imageData": "string",
- "name": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "tokenId": "string",
- "updatedAt": "string",
- "video": "string"
}, - "private": true,
- "searchColumn": "string",
- "tokenId": "string",
- "updatedAt": "string"
}, - "updatedAt": "string"
}
]
}
{- "toCurrency": "string"
}
{- "exchangeRate": {
- "currencyType": "string",
- "name": "string",
- "symbol": "string",
- "value": 0,
- "vsCurrency": "string"
}
}
{- "friendAddress": "string"
}
{- "friend": {
- "createdAt": "string",
- "friendAddress": "string",
- "id": 0,
- "nickname": "string",
- "user": {
- "address": "string",
- "avatar": "string",
- "backup": true,
- "backupConfirmed": true,
- "bio": "string",
- "createdAt": "string",
- "locale": "string",
- "location": "string",
- "maxInvites": 0,
- "normalizedUsername": "string",
- "sysAdmin": true,
- "updatedAt": "string",
- "username": "string"
}, - "userAddress": "string"
}, - "status": true
}
{- "configId": 0
}
{- "config": {
- "allowCrossChainPayments": true,
- "callbackURL": "string",
- "chainId": 0,
- "chainedCallAddress": "string",
- "chainedCallData": "string",
- "createdAt": "string",
- "deletedAt": "string",
- "externalProductId": "string",
- "id": 0,
- "paymentAmount": 0,
- "paymentRecipient": "string",
- "paymentTokenAddress": "string",
- "paymentTokenId": 0,
- "paymentTokenType": "ERC20",
- "projectId": 0
}
}
Legacy
OK
Client error
Server error
{ }
{- "inviteInfo": {
- "expiryInHours": 0,
- "invites": [
- {
- "code": "string",
- "createdAt": "string",
- "email": "string",
- "expiresAt": "string",
- "ownerAccount": "string",
- "source": "string",
- "url": "string",
- "usesLeft": 0
}
], - "max": 0
}
}
OK
Client error
Server error
{ }
{- "token": "string"
}
{- "orderId": "string"
}
{- "resp": {
- "contractAddress": "string",
- "createdAt": "string",
- "expiresAt": "string",
- "fiatCurrency": "string",
- "fiatExchangeRateUSD": 0,
- "id": "string",
- "imageUrl": "string",
- "name": "string",
- "networkFee": 0,
- "paymentCurrency": "string",
- "paymentMethodType": "string",
- "price": 0,
- "recipientAddress": "string",
- "referenceId": "string",
- "status": "string",
- "subTotal": 0,
- "total": 0,
- "transactionFee": 0,
- "transactionHash": "string",
- "transactionId": "string",
- "transactionType": "string"
}
}
object (NftCheckoutParams) |
OK
Client error
Server error
{- "params": {
- "approvedSpenderAddress": "string",
- "blockchainNftId": "string",
- "calldata": "string",
- "contractAddress": "string",
- "decimals": 0,
- "imageUrl": "string",
- "name": "string",
- "network": "string",
- "platform": "string",
- "quantity": 0,
- "recipientAddress": "string",
- "tokenAddress": "string",
- "tokenAmount": "string",
- "tokenDecimals": 0,
- "tokenSymbol": "string"
}
}
{- "resp": {
- "expiresAt": "string",
- "orderId": "string",
- "token": "string"
}
}
OK
Client error
Server error
{ }
{- "data": {
- "factory": "string",
- "guestModule": "string",
- "mainModule": "string",
- "mainModuleUpgradable": "string",
- "utils": "string"
}
}
Currency abstraction
OK
Client error
Server error
{- "chainId": 0,
- "currencyAddress": "string",
- "currencyAmount": "string",
- "includeApprove": true,
- "userAddress": "string"
}
{- "swapQuotes": [
- {
- "approveData": "string",
- "currencyAddress": "string",
- "currencyBalance": "string",
- "maxPrice": "string",
- "price": "string",
- "to": "string",
- "transactionData": "string"
}
]
}
NOTE: we're still using this from SW-API to Sequence-API to claim invite code
OK
Client error
Server error
{- "accessCode": "string"
}
{- "status": true
}
{- "chainId": "string",
- "ethAuthProofString": "string",
- "walletAddress": "string"
}
{- "isValid": true
}
{- "chainId": "string",
- "message": "string",
- "signature": "string",
- "walletAddress": "string"
}
{- "isValid": true
}
TODO: we can add walletContext optional in the future when we need it NOTE: chainId can be either a number or canonical name
OK
Client error
Server error
{- "chainId": "string",
- "digest": "string",
- "signature": "string",
- "walletAddress": "string"
}
{- "isValid": true
}
{- "chainId": "string",
- "signature": "string",
- "typedData": { },
- "walletAddress": "string"
}
{- "isValid": true
}
Linked wallets (v0 -- simple support)
OK
Client error
Server error
{- "chainId": "string",
- "ethAuthProofString": "string",
- "linkedWalletMessage": "string",
- "linkedWalletSignature": "string",
- "walletAddress": "string"
}
{- "linkedWalletAddress": "string",
- "status": true
}
OK
Client error
Server error
{ }
{- "currencyGroups": [
- {
- "id": 0,
- "name": "string",
- "tokens": [
- {
- "chainId": 0,
- "currencyGroupId": 0,
- "id": 0,
- "tokenAddress": "string"
}
]
}
]
}
{- "projectId": 0
}
{- "configs": [
- {
- "allowCrossChainPayments": true,
- "callbackURL": "string",
- "chainId": 0,
- "chainedCallAddress": "string",
- "chainedCallData": "string",
- "createdAt": "string",
- "deletedAt": "string",
- "externalProductId": "string",
- "id": 0,
- "paymentAmount": 0,
- "paymentRecipient": "string",
- "paymentTokenAddress": "string",
- "paymentTokenId": 0,
- "paymentTokenType": "ERC20",
- "projectId": 0
}
]
}
Paper TODO: deprecate in the future
OK
Client error
Server error
{- "chainName": "string",
- "contractAddress": "string",
- "contractType": "string",
- "paramsJson": "string"
}
{- "secret": "string"
}
{- "abi": "string",
- "chainName": "string",
- "contractAddress": "string",
- "paramsJson": "string"
}
{- "secret": "string"
}
{- "chainId": "string",
- "ethAuthProofString": "string",
- "linkedWalletMessage": "string",
- "linkedWalletSignature": "string",
- "walletAddress": "string"
}
{- "status": true
}
{- "chainId": 0,
- "configId": 0,
- "recipient": "string",
- "tokenAddress": "string"
}
{- "payment": {
- "chainId": 0,
- "expiration": "string",
- "externalProductId": "string",
- "inventoryPaymentConfigId": 0,
- "paymentId": 0,
- "paymentTokenAddress": "string",
- "paymentTokenId": 0,
- "paymentTokenType": "ERC20",
- "paymentTotal": 0,
- "signature": "string",
- "txData": "string",
- "txTo": "string"
}
}
OK
Client error
Server error
{ }
{- "status": {
- "branch": "string",
- "checks": { },
- "commitHash": "string",
- "healthOK": true,
- "numTxnsRelayed": {
- "current": 0,
- "period": 0,
- "prev": 0
}, - "senders": [
- {
- "active": true,
- "address": "string",
- "etherBalance": 0,
- "index": 0
}
], - "startTime": "string",
- "uptime": 0,
- "useEIP1559": true,
- "ver": "string"
}
}
{- "filterUsername": "string",
- "page": {
- "after": { },
- "before": { },
- "column": "string",
- "more": true,
- "page": 0,
- "pageSize": 0,
- "sort": [
- {
- "column": "string",
- "order": "DESC"
}
], - "totalRecords": 0
}
}
{- "friends": [
- {
- "createdAt": "string",
- "friendAddress": "string",
- "id": 0,
- "nickname": "string",
- "user": {
- "address": "string",
- "avatar": "string",
- "backup": true,
- "backupConfirmed": true,
- "bio": "string",
- "createdAt": "string",
- "locale": "string",
- "location": "string",
- "maxInvites": 0,
- "normalizedUsername": "string",
- "sysAdmin": true,
- "updatedAt": "string",
- "username": "string"
}, - "userAddress": "string"
}
]
}
object (CurrencyGroup) |
OK
Client error
Server error
{- "currencyGroup": {
- "id": 0,
- "name": "string",
- "tokens": [
- {
- "chainId": 0,
- "currencyGroupId": 0,
- "id": 0,
- "tokenAddress": "string"
}
]
}
}
{ }
{- "friendAddress": "string",
- "nickname": "string"
}
{- "friend": {
- "createdAt": "string",
- "friendAddress": "string",
- "id": 0,
- "nickname": "string",
- "user": {
- "address": "string",
- "avatar": "string",
- "backup": true,
- "backupConfirmed": true,
- "bio": "string",
- "createdAt": "string",
- "locale": "string",
- "location": "string",
- "maxInvites": 0,
- "normalizedUsername": "string",
- "sysAdmin": true,
- "updatedAt": "string",
- "username": "string"
}, - "userAddress": "string"
}, - "status": true
}
object (InventoryPaymentConfig) |
OK
Client error
Server error
{- "config": {
- "allowCrossChainPayments": true,
- "callbackURL": "string",
- "chainId": 0,
- "chainedCallAddress": "string",
- "chainedCallData": "string",
- "createdAt": "string",
- "deletedAt": "string",
- "externalProductId": "string",
- "id": 0,
- "paymentAmount": 0,
- "paymentRecipient": "string",
- "paymentTokenAddress": "string",
- "paymentTokenId": 0,
- "paymentTokenType": "ERC20",
- "projectId": 0
}
}
{ }