Get Wallet Transaction Details By Transaction ID
Through this endpoint users can obtain Wallet transaction information by providing a transactionId
. Customers can receive information only for a transaction that has been made from their own wallet.
Path Parameters
-
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
Example : bitcoinPossible Values : bitcoin ethereum litecoin bitcoin-cash ethereum-classic dogecoin dash zcash binance-smart-chain tron -
Requirednetwork string
Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks.
Example : testnetPossible Values : mainnet testnet mordor nile goerli -
RequiredtransactionId string
Represents the unique identifier of a transaction, i.e. it could be
transactionId
in UTXO-based protocols like Bitcoin, and transactionhash
in Ethereum blockchain.Example : 3e081861494aed897e589cdeab5d9e628d985e571ed1c19896d1aa698cce9d80
Query parameters
-
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString
Response schema
Content-Type: application/json
The request has been successful.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requireddata object
-
Requireditem object
-
RequiredisConfirmed boolean
Represents the state of the transaction whether it is confirmed or not confirmed.
Example : True -
RequiredtransactionId string
Represents the unique identifier of a transaction, i.e. it could be
transactionId
in UTXO-based protocols like Bitcoin, and transactionhash
in Ethereum blockchain.Example : 3e081861494aed897e589cdeab5d9e628d985e571ed1c19896d1aa698cce9d80 -
Requiredindex integer
Represents the index position of the transaction in the specific block.
Example : 21 -
OptionalminedInBlockHash string
Represents the hash of the block where this transaction was mined/confirmed for first time. The hash is defined as a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.
Example : 0000000000503b5200a935cfa9e7740783b5f2292aaad3bf273554abfb3d91ce -
OptionalminedInBlockHeight integer
Represents the hight of the block where this transaction was mined/confirmed for first time. The height is defined as the number of blocks in the blockchain preceding this specific block.
Example : 1250283 -
Requiredrecipients array
Object Array representation of transaction receivers
-
Optionaladdress string
String representation of the receiver address
-
Optionalamount string
String representation of the amount
-
-
Requiredsenders array
String representation of the transaction from address
-
Optionaladdress string
String array representation of the sender address
-
Optionalamount string
String representation of the amount
-
-
Requiredtimestamp integer
Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.
Example : 1636972451 -
RequiredtransactionHash string
Represents the same as
transactionId
for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocolshash
is different fromtransactionId
for SegWit transactions.Example : c58148bb37b9be020338e427784580b58e0b497ce32d7eddf812de6a1a0d3133 -
Requiredfee object
-
Requiredamount string
When isConfirmed is True - Defines the amount of the transaction fee When isConfirmed is False - For ETH-based blockchains this attribute represents the max fee value.
Example : 0.00003812 -
Requiredunit string
Represents the unit of the fee.
Example : BTC
-
-
RequiredblockchainSpecific object One Ofobject
-
Requiredlocktime integer
Represents the time at which a particular transaction can be added to the blockchain.
Example : 0 -
Requiredsize integer
Represents the total size of this transaction.
Example : 591 -
RequiredvSize integer
Represents the virtual size of this transaction.
Example : 347 -
Requiredversion integer
Represents the transaction version number.
Example : 2 -
Requiredvin array
Object Array representation of transaction inputs
-
Requiredaddresses array
Represents the addresses which send/receive the amount.
Example : 2NDxh6gwyx33zCxocteVXo9znPny1GrUuHF -
Optionalcoinbase string
Represents the coinbase hex.
Example : 0399991d20706f6f6c2e656e6a6f79626f646965732e636f6d20393963336532346234374747a53e994c4a000001 -
RequiredscriptSig object
Object representation of the script
-
Requiredasm string
The asm strands for assembly, which is the symbolic representation of the Bitcoin's Script language op-codes.
Example : 00148b3ed2c15710b61a43cb354a7e637dc6bbd448ce -
Requiredhex string
Represents the hex of the public key of the address.
Example : 1600148b3ed2c15710b61a43cb354a7e637dc6bbd448ce -
Requiredtype string
Represents the script type of the reference transaction identifier.
Example : scripthash
-
-
Requiredsequence integer
Represents the script sequence number.
Example : 4294967295 -
Requiredtxid string
Represents the reference transaction identifier.
Example : 48bd74754b71181d4d2092fc24477f89fa7dfea8059b140a179bac2267048832 -
Optionaltxinwitness array
Represents an array hex-encoded witness data (if there is any) as strings.
Example : 3045022100ee88c1b067d5756831343059a3632106b218ef158fe062725c69a2a21b1504af02207c95262daaefdf9c46f55e53cc42fa152bd874a5ea54dd155a4f2624782be1af01 -
Optionalvalue string
Represents the sent/received amount.
Example : 0.00001681 -
Requiredvout integer
It refers to the index of the output address of this transaction. The index starts from 0.
Example : 0
-
-
Requiredvout array
Represents the transaction outputs.
-
RequiredisSpent boolean
Defines whether the output is spent or not.
Example : False -
RequiredscriptPubKey object
Object representation of the script
-
Requiredaddresses array
Represents the addresses which send the amount.
Example : 2NGHH9qxCADY5eTNFUKobi1xiMWoW6FYSCd -
Requiredasm string
Represents the assembly of the script public key of the address.
Example : OP_HASH160 fcae5de86db6ca7121f44a0a01fd2d3b85137e07 OP_EQUA -
Requiredhex string
Represents the hex of the script public key of the address.
Example : a914fcae5de86db6ca7121f44a0a01fd2d3b85137e0787 -
OptionalreqSigs integer
Represents the required signatures.
Example : 1 -
Requiredtype string
Represents the script type.
Example : witness_v0_keyhash
-
-
Requiredvalue string
Represents the sent/received amount.
Example : 0.00004069
-
object-
Requiredcontract string
Represents the specific transaction contract.
Example : 0x20fe562d797a42dcb3399062ae9546cd06f63280 -
RequiredgasLimit string
Represents the amount of gas used by this specific transaction alone.
Example : 21000 -
RequiredgasPrice object
-
Requiredamount string
Represents the price offered to the miner to purchase this amount of gas.
Example : 10354241269 -
Requiredunit string
Defines the unit of the gas price amount, e.g. BTC, ETH, XRP.
Example : WEI
-
-
RequiredgasUsed string
Represents the exact unit of gas that was used for the transaction.
Example : 21000 -
RequiredinputData string
Represents additional information that is required for the transaction.
Example : 0x67a5cd0600000000000000000000000031f42841c2db5173425b5223809cf3a38fede360 -
Requirednonce integer
Represents the sequential running number for an address, starting from 0 for the first transaction. E.g., if the nonce of a transaction is 10, it would be the 11th transaction sent from the sender's address.
Example : 16 -
RequiredtransactionStatus string
String representation of the transaction status
Example : 0x1
object-
Requiredlocktime integer
Represents the time at which a particular transaction can be added to the blockchain.
Example : 2 -
Requiredsize integer
Represents the total size of this transaction.
Example : 223 -
RequiredvSize integer
Represents the virtual size of this transaction.
Example : 141 -
Requiredversion integer
Represents the transaction version number.
Example : 1 -
Requiredvin array
Object Array representation of transaction inputs
-
Requiredaddresses array
Represents the addresses which send/receive the amount.
Example : LZ891CJWn54CpE6yJ4T3mzP8Xxwrg9gDpH -
Requiredcoinbase string
Represents the coinbase hex.
Example : 0399d620046183f4502cfabe6d6d54cff85e53693837dc613bc4cc4b78986c2193a4e2902e3da62aa311957f50844000000000000000042f4c502f08220000b0e1110000 -
RequiredscriptSig object
Object representation of the script
-
Requiredasm string
The asm strands for assembly, which is the symbolic representation of the Bitcoin's Script language op-codes.
Example : 3045022100f031442894c0fd60c195fbdb29c0bf72f143a815689b8840cd31ec31cc6a7721022028f74f0869e4666761c9ba1035cc714528a17de873dfc7b3a541d29f3942a2d8[ALL] 028c533b6c0ce0ad714a8af36b64d207c4f61cd6d5af210362447c92b4105a4fab -
Requiredhex string
Represents the hex of the public key of the address.
Example : 483045022100f031442894c0fd60c195fbdb29c0bf72f143a815689b8840cd31ec31cc6a7721022028f74f0869e4666761c9ba1035cc714528a17de873dfc7b3a541d29f3942a2d80121028c533b6c0ce0ad714a8af36b64d207c4f61cd6d5af210362447c92b4105a4fab -
Requiredtype string
Represents the script type of the reference transaction identifier.
Example : scripthash
-
-
Requiredsequence integer
Represents the script sequence number.
Example : 4294967294 -
Requiredtxid string
Represents the reference transaction identifier.
Example : 1db56e1e8dfab84f6f0e33f8ddb160c9b16286471a3b486d79ea85bcf4d076b2 -
Optionaltxinwitness array
Represents an array hex-encoded witness data (if there is any) as strings.
Example : 304402204e88dfe79e58b640908812c496ea74d2941c23e70ee3d93ebd469dbd136afe0c02203d7631427c0b5cb96e8a8b23b6c8c0c8112ecb5fb020ee2a7a70841564ed679b01 -
Requiredvalue string
Represents the sent/received amount.
Example : 0.0225 -
Requiredvout integer
It refers to the index of the output address of this transaction. The index starts from 0.
Example : 1
-
-
Requiredvout array
Object Array representation of transaction outputs
-
RequiredisSpent boolean
Defines whether the output is spent or not.
Example : False -
RequiredscriptPubKey object
Represents the script public key.
-
Requiredaddresses array
Represents the addresses which send the amount.
Example : 3LAAY4fp88RsNHkVW5DZJgqUdbMD5rVoqZ -
Requiredasm string
Represents the assembly of the script public key of the address.
Example : OP_HASH160 ca94af32587de4e5006685ffffc65a818ccd3fbc OP_EQUAL -
Requiredhex string
Represents the hex of the script public key of the address.
Example : a914ca94af32587de4e5006685ffffc65a818ccd3fbc87 -
OptionalreqSigs integer
Represents the required signatures.
Example : 1 -
Requiredtype string
Represents the script type.
Example : scripthash
-
-
Requiredvalue string
Represents the sent/received amount.
Example : 0.03505975
-
object-
Requiredlocktime integer
Represents the time at which a particular transaction can be added to the blockchain.
Example : 1781965 -
Requiredsize integer
Represents the total size of this transaction.
Example : 248 -
Requiredversion integer
Represents the transaction version number.
Example : 1 -
Requiredvin array
Object Array representation of transaction inputs
-
Requiredaddresses array
Represents the addresses which send/receive the amount.
Example : qq0adqyntn2zl9tsyjfagnyda9j2gfjkk574lxyrxd -
Optionalcoinbase string
Represents the coinbase hex.
Example : 0399991d20706f6f6c2e656e6a6f79626f646965732e636f6d20393963336532346234374747a53e994c4a000001 -
RequiredscriptSig object
Object representation of the script
-
Requiredasm string
The asm strands for assembly, which is the symbolic representation of the Bitcoin's Script language op-codes.
Example : 0014daaf6d5cb86befe42df851a4d1df052e663754c1 -
Requiredhex string
Represents the hex of the public key of the address.
Example : 160014daaf6d5cb86befe42df851a4d1df052e663754c1 -
Requiredtype string
Represents the script type of the reference transaction identifier.
Example : scripthash
-
-
Requiredsequence integer
Represents the script sequence number.
Example : 4294967295 -
Requiredtxid string
Represents the reference transaction identifier.
Example : caee978cae255bbe303ac86152679e46113a8b12925aa3afaa312d89d11ccbf8 -
Optionaltxinwitness array
Represents an array hex-encoded witness data (if there is any) as strings.
Example : 3045022100c11ea5740bcd69f0f68a4914279838014d28923134d18e05c5a5486dfd06cc8c02200dadccec3f07bed0d1040f9e5a155efa5fdd40fc91f92342578d26848da4c6b901 -
Optionalvalue string
Represents the sent/received amount.
Example : 0.00873472 -
Optionalvout integer
It refers to the index of the output address of this transaction. The index starts from 0.
Example : 1
-
-
Requiredvout array
Object Array representation of transaction outputs
-
RequiredisSpent boolean
Defines whether the output is spent or not.
Example : False -
RequiredscriptPubKey object
Represents the script public key.
-
Requiredaddresses array
Represents the addresses which send the amount.
Example : qqux7gek8sg6r9qjkrdmrvz6t4xet3ax3gztt2drzk -
Requiredasm string
Represents the assembly of the script public key of the address.
Example : OP_DUP OP_HASH160 386f23363c11a19412b0dbb1b05a5d4d95c7a68a OP_EQUALVERIFY OP_CHECKSIG -
Requiredhex string
Represents the hex of the script public key of the address.
Example : a914507a5bd8cac1d9efdf4c0a4bfacb3e0abb4f8d1587 -
OptionalreqSigs integer
Represents the required signatures.
Example : 1 -
Requiredtype string
Represents the script type.
Example : pubkeyhash
-
-
Requiredvalue string
Represents the sent/received amount.
Example : 0.000122
-
object-
Requiredcontract string
Represents the specific transaction contract.
Example : 0x20fe562d797a42dcb3399062ae9546cd06f63280 -
RequiredgasLimit string
Represents the amount of gas used by this specific transaction alone.
Example : 552020 -
RequiredgasPrice object
-
Requiredamount string
Represents the price offered to the miner to purchase this amount of gas.
Example : 2994782934 -
Requiredunit string
Defines the unit of the gas price amount, e.g. BTC, ETH, XRP.
Example : WEI
-
-
RequiredgasUsed string
Represents the exact unit of gas that was used for the transaction.
Example : 24673 -
RequiredinputData string
Represents additional information that is required for the transaction.
Example : 0xa9059cbb000000000000000000000000acc59ec2f7119dc7a9e69dcd124cff75caae05bf0000000000000000000000000000000000000000000000000000000000989680 -
Requirednonce integer
Represents the sequential running number for an address, starting from 0 for the first transaction. E.g., if the nonce of a transaction is 10, it would be the 11th transaction sent from the sender's address.
Example : 16
object-
Requiredlocktime integer
Represents the time at which a particular transaction can be added to the blockchain.
Example : 0 -
Requiredsize integer
Represents the total size of this transaction.
Example : 266 -
Requiredversion integer
Represents the transaction version number.
Example : 1 -
Requiredvin array
Object Array representation of transaction inputs
-
Requiredaddresses array
Represents the addresses which send/receive the amount.
Example : DPzdWPsKaGvRn3AH7WjBpnNVHhAPELDY4o -
Optionalcoinbase string
Represents the coinbase hex.
Example : 03dcf4150c0b2f454233322f414431322f04da88506004565cc01f0c3130fc5f4e050000000000000a626368706f6f6c172f20626974636f696e636173682e6e6574776f726b202f -
RequiredscriptSig object
Object representation of the script
-
Requiredasm string
The asm strands for assembly, which is the symbolic representation of the Bitcoin's Script language op-codes.
Example : 030483ff6271580681f4f7828c01df56d5aebfe982cbaa2922594be9eb6cf40206 OP_CHECKSIG -
Requiredhex string
Represents the hex of the public key of the address.
Example : 21030483ff6271580681f4f7828c01df56d5aebfe982cbaa2922594be9eb6cf40206ac -
Requiredtype string
Represents the script type of the reference transaction identifier.
Example : scripthash
-
-
Requiredsequence integer
Represents the script sequence number.
Example : 4294967295 -
Optionaltxid string
Represents the reference transaction identifier.
-
Optionaltxinwitness array
Represents an array hex-encoded witness data (if there is any) as strings.
Example : qpq395ljesqakppupe3chd3n3jp60wd23ue00g66xx -
Requiredvalue string
Represents the sent/received amount.
Example : 0.0225 -
Optionalvout integer
It refers to the index of the output address of this transaction. The index starts from 0.
Example : 1
-
-
Requiredvout array
Object Array representation of transaction outputs
-
RequiredisSpent boolean
Defines whether the output is spent or not.
Example : False -
RequiredscriptPubKey object
Represents the script public key.
-
Requiredaddresses array
Represents the addresses which send the amount.
Example : yd5KMREs3GLMe6mTJYr3YrH1juwNwrFCfB -
Requiredasm string
Represents the assembly of the script public key of the address.
Example : OP_DUP OP_HASH160 430158211605af1f0fa26d90405199621bdae5cd OP_EQUALVERIFY OP_CHECKSIG -
Requiredhex string
Represents the hex of the script public key of the address.
Example : 76a914430158211605af1f0fa26d90405199621bdae5cd88ac -
OptionalreqSigs integer
Represents the required signatures.
Example : 1 -
Requiredtype string
Represents the script type.
Example : scripthash
-
-
Requiredvalue string
Represents the sent/received amount.
Example : 11.25
-
object-
Requiredlocktime integer
Represents the time at which a particular transaction can be added to the blockchain.
Example : 0 -
Requiredsize integer
Represents the total size of this transaction.
Example : 125 -
Requiredversion integer
Represents the transaction version number.
Example : 1 -
Requiredvin array
Object Array representation of transaction inputs
-
Requiredaddresses array
Represents the addresses which send/receive the amount.
Example : 7W7gfYstwDR6a2ZCxEidAuvshyomqJ8yXT -
Optionalcoinbase string
Represents the coinbase hex.
Example : 03dcf4150c0b2f454233322f414431322f04da88506004565cc01f0c3130fc5f4e050000000000000a626368706f6f6c172f20626974636f696e636173682e6e6574776f726b202f -
RequiredscriptSig object
Specifies the required signatures.
-
Requiredasm string
The asm strands for assembly, which is the symbolic representation of the Bitcoin's Script language op-codes.
Example : OP_DUP OP_HASH160 1fd680935cd42f95702493d44c8de964a42656b5 OP_EQUALVERIFY OP_CHECKSIG -
Requiredhex string
Represents the hex of the public key of the address.
Example : 4197968cb34bfba488b4a2399f7959b823fefad79ca0b5ed3f3a4bec4c0286cab55b896b28bbbcd4e61cf584cecfd47063b18b481d8d680eafbf869ada1a02c52441210237a84e6d70e775f274e4cbd9f30f9f8b1a426e8b08a9f802a851ce501c930011 -
Requiredtype string
Represents the script type of the reference transaction identifier.
Example : scripthash
-
-
Requiredsequence integer
Represents the script sequence number.
Example : 4294967295 -
Optionaltxid string
Represents the reference transaction identifier.
Example : f60cf447159b08e9857cbc96688ba80beff23c6f032f6545044ab40a771b15f5 -
Optionaltxinwitness array
Represents an array hex-encoded witness data (if there is any) as strings.
Example : 3045022100c11ea5740bcd69f0f68a4914279838014d28923134d18e05c5a5486dfd06cc8c02200dadccec3f07bed0d1040f9e5a155efa5fdd40fc91f92342578d26848da4c6b901 -
Optionalvalue string
Represents the sent/received amount.
Example : 0.2354 -
Optionalvout integer
It refers to the index of the output address of this transaction. The index starts from 0.
Example : 1
-
-
Requiredvout array
Object Array representation of transaction outputs
-
RequiredisSpent boolean
Defines whether the output is spent or not.
Example : False -
RequiredscriptPubKey object
Represents the script public key.
-
Requiredaddresses array
Represents the addresses which send the amount.
-
Requiredasm string
Represents the assembly of the script public key of the address.
Example : OP_DUP OP_HASH160 4112d3f2cc01db043c0e638bb6338c83a7b9aa8f OP_EQUALVERIFY OP_CHECKSIG -
Requiredhex string
Represents the hex of the script public key of the address.
Example : 76a9144112d3f2cc01db043c0e638bb6338c83a7b9aa8f88ac -
OptionalreqSigs integer
Represents the required signatures.
Example : 1 -
Requiredtype string
Represents the script type.
Example : scripthash
-
-
Requiredvalue string
Represents the sent/received amount.
Example : 0.5896
-
object-
RequiredbindingSig string
It is used to enforce balance of Spend and Output transfers, in order to prevent their replay across transactions.
Example : 603624b3e78e0de0415dea320797a107076a9f7aabd39f44bc4957803330e9891cb33744ac2ec749c2d2d341f29467c49c0ae35bf34765e2fb7c4cda68584804 -
RequiredexpiryHeight integer
Represents a block height after which the transaction will expire.
Example : 0 -
RequiredjoinSplitPubKey string
Represents an encoding of a JoinSplitSig public validating key.
Example : 5d2673b4c727241410e42f214a39218e4f13354d77db8ec31243a7be7ed8e2b7 -
RequiredjoinSplitSig string
Is used to sign transactions that contain at least one JoinSplit description.
Example : 8b06b926d619ead780b0769e5997ded93f9851fd0efd4b667afc5bcc2792b26cd4a565b4efa7733535fdc09fa566ca59042785d7fd8043d37fdf9e144465080a -
Requiredlocktime integer
Represents the time at which a particular transaction can be added to the blockchain.
Example : 1781965 -
Requiredoverwintered boolean
"Overwinter" is the network upgrade for the Zcash blockchain.
Example : True -
Requiredsize integer
Represents the total size of this transaction.
Example : 234 -
OptionalvJoinSplit array
Represents a sequence of JoinSplit descriptions using BCTV14 proofs.
-
Requiredanchor string
Defines a Merkle tree root of a note commitment tree which uniquely identifies a note commitment tree state given the assumed security properties of the Merkle tree’s hash function.
Example : d32ddbaf0d9dc8c10783c01fd9ba5bd0bc2e5efe3d1665d7d6771eb4393736b4 -
RequiredcipherTexts array
Represents the cipher texts.
Example : 988a182a3e561e0cca18e38e3273b3c538c3e6f79077867eca4305e48cbc5e6d3ff680de602e44fb8869f1a8747d9e3775f2418d33c41233e3612d6ecf277346b85bcd0c1fbdf4c4c0da107bf84e02c82588bf02f4a6c23ed36f70a436f69a6fe6cc38634d69e34e3d3942ff06a7921153689b4b50e3799f0ce3d8a35d165beaecc0c91018e9a8c618ff7036fd14b95641229e42974054c70d1e080c909c382297c5698b9af9b9291d6851c718d3e771e6376bd6dd52f4624ad024b4d85426e32fcf531019eeea547fda3ecca87aceaa80982e8fe22db152c01635d24fe4f59d1979610cad898c169d88559bcd8847f82b2ac5ab2f8623eed55b0273982297a52e9cbb4523d6411a0d40f59faf0ff9f23783790027d5f5153d421d897c11b9da48e7218b7ce64c653283ecaffab78006b771aec20e05761d768f9347f96c566d47014eff083268622e81ce6c17e1e66227ee795cd3a7efb77c3b5b4a896d75111a2a846be94c0fcdaab69ca2101a499c817590c4d1ea8b39145f0168210af4ac86cc6018e95c0699a6f1275c2934cbe1cf84bbeee12ed77b54fe4c2f6b1c0187e7ab31750e03cf72467e9bf7c8a89bb8f4160b5d56def4cb24f595303bcdf065bf2ec7161c8165a6be7252b7cd8c3aa9bf9baf78690f19c1d4fc1d39e558bd4f4fdb3e56fb1b2e287cf67b0e0cf8df5c28c7bb94393cb837c180d380814a63e7db94e4e9652933e67f28f93dd92ee45be8f824cd9469dd0a872e130d4c1621a56d2a33ffb51c04b4151f0a471472a977d771b0eb13bf9fde44804ef755b97e1cae1e8d807f5eb692d7ffc20d8e451ce9ccd75b1a270836db80 -
Requiredcommitments array
Represents the commitments.
Example : 2f7f341d6af9a75b317d0753d2fc0514baf38bb602cd66dc7d221aa371e6062c -
Requiredmacs array
Represents the macs.
Example : 52f677a49eb36bcce6b30f94bee481d73c4fdd61963bda54b68f3a90ca007b59 -
Requirednullifiers array
Represents a sequence of nullifiers of the input notes.
Example : 30e41a9a6605933a75ec42439ab65eb347025002f6486e5549abb82438447dbe -
RequiredoneTimePubKey string
Defines the one time public key.
Example : 0a2e7ba03903480af852cb47d8ce76eb6546aef69bdb35b28b8ae815012d4d13 -
Requiredproof string
Defines the proof.
Example : 8dd9c988c9f337bd55c07fa9e2fa405cf4dda2cb915214fc0b5924870eed0f0187a0db001b5d8ea43a537e423d91d0fc868a456fa3e0bf9e99d1b04f43c6983a05a99458a69903add73ccaa4177844df9056d40c5a71ae14a70835cb30ca7d810fa1d48c9180ddec2ca1cecfaa8706ab514d6e8fe2dd228d7dc012d9407517523b774107a6a78dc972b175b94d1681b980e2b9ba7d39f880973787080a12bf14dc3f038333245a60bbcd9cb1fe2baba30ed083535752cc26ea0c57134e0c774e -
RequiredrandomSeed string
Represents a 256-bit seed that must be chosen independently at random for each JoinSplit description.
Example : 05eb35ce1cec5f5824f708ee9d95467d2318d24c8d4220040df92d48b1f182e8 -
RequiredvPubNew string
Defines the value that the joinSplit transfer will insert into the transparent transaction value pool
Example : 50.02989193 -
RequiredvPubOld string
Defines the value that the joinSplit transfer will remove from the transparent transaction value pool.
Example : 0
-
-
OptionalvShieldedOutput array
Object Array representation of transaction output descriptions
-
Requiredcmu string
Represents the 𝑢-coordinate of the note commitment for the output note.
Example : 4eb188a762d4fd4358ae70b2dac1b6a596ad653be92471792bf4b157850a1011 -
Requiredcv string
Defines a value commitment to the value of the input note.
Example : 547a9cef4937304f97acacfcd9827b5aa1b2e5b1ae32e360fae828b955564a0e -
RequiredencCipherText string
Represents a ciphertext component for the encrypted output note.
Example : a6c0084214eef0058f4b51c1e25b4c05ac282fec0edc5938c4283aa2a6d7c426d7a3c927d11596f81780b18c0eee90848702eb7fa512f7a6386e52d9bc17d5bc0e20bc24608ece560a314570aaf4c095bc988a9a0f8ef72ed91d0eee7d927eb37428c62af28c6a5c9379ac48aef3cdfb9b83eed77edde50acab7615f8fecdb1f24500fab6b8a72440e6fadbf0e6ad0ff8989df4d27bb2bc56c3a99c6da2e82c68a319857902842cf15aec180b6ea0ff3ebedf1cfd02b434ac715bc4afb17f67286d5708864a7aabb461461f080bbcf0315c38d782be6d0aae7ac3beb6574babf12c9182574d6c6e900888b5c4da40952c403b7d4ebe96e051893e388bcb7026d839e1d49ddbb132706fbadae1ef272d7e8dbf297dfbe7867651cfd843e52239d8270c1b6d46f2589643a5a325018f2d0b82b53955a5a3c5c3cecf8f0829594777887028456bd708c7c4ad88e588609c1b33d9060d8cf0015bfc18676ebc7022956ab6d4c6aae24550422e702733da234e2ce6f5adbafc4e2d97ae9846febddeacfaefda7f186b7e8182f4692c34bff4bd31eeeab15c5b5f7a41c93acae05a4f3c378fbe6cf33ab3628f4c5b8e04b9368ec69ea1c7c816c803d9ef7bbafe232f43959c7b49dd7c3328dc028040f440fd3cb2e08449db77c191288f120c065870d800ebdca234e6c2ba1fa6d44d04f4fed2e41b1c65d273b0ce58287274e8dc71a2a174244f026971bb9c698e7f7964eec615515910c627a201b52c3c2c504623ac45f5606d0400120bd5b6e1f431775fe92fb2c9eb5546c9dc12693ee9b679e49fce2cf71 -
RequiredephemeralKey string
Represents an encoding of an ephemeral Jubjub public key.
Example : 04c59e908296aeac1160ba8def90916988bf8389564343e6fb3b9e52c27fba0a -
RequiredoutCipherText string
Represents a ciphertext component that allows the holder of the outgoing cipher key to recover the diversified transmission key pkd and ephemeral private key esk, hence the entire note plaintext.
Example : b3f02b333a61b69e63dfeaf1ad430534985cd6958abe92664abe85449ca68b5c145f536e9a636a881aab5e314b4f550b2b8f5600dc1ed636f643b11e00bb6c469bf5205f16197372dcf5e4b0871e42f4 -
Requiredproof string
Represents the proof.
Example : 8dd9c988c9f337bd55c07fa9e2fa405cf4dda2cb915214fc0b5924870eed0f0187a0db001b5d8ea43a537e423d91d0fc868a456fa3e0bf9e99d1b04f43c6983a05a99458a69903add73ccaa4177844df9056d40c5a71ae14a70835cb30ca7d810fa1d48c9180ddec2ca1cecfaa8706ab514d6e8fe2dd228d7dc012d9407517523b774107a6a78dc972b175b94d1681b980e2b9ba7d39f880973787080a12bf14dc3f038333245a60bbcd9cb1fe2baba30ed083535752cc26ea0c57134e0c774e
-
-
OptionalvShieldedSpend array
Object Array representation of transaction spend descriptions
-
Requiredanchor string
Defines a Merkle tree root of a note commitment tree which uniquely identifies a note commitment tree state given the assumed security properties of the Merkle tree’s hash function.
Example : d32ddbaf0d9dc8c10783c01fd9ba5bd0bc2e5efe3d1665d7d6771eb4393736b4 -
Requiredcv string
Defines a value commitment to the value of the input note.
Example : 547a9cef4937304f97acacfcd9827b5aa1b2e5b1ae32e360fae828b955564a0e -
Requirednullifier string
Represents a sequence of nullifiers of the input notes.
Example : 30e41a9a6605933a75ec42439ab65eb347025002f6486e5549abb82438447dbe -
Requiredproof string
Represents the proof.
Example : 030ff7fdb006db7f9acb0d2d6fae180e4395f0b6a979f6ddf48a349bc03ad2e7bb0324a5c3c7e6be131c34126ad22c74138f45f6f77bba706dfc87335a9adffcfef20a03e47751f403a37f9c5e1874aa50818c3eef09304c57c77b111057c09ed2112a7ed310ad285e0b778a4f44b654032b642b8b2df3be16bea011da7a2221bc0f0a0309f51f87caef2ea0f665f1a77d0dd50766d835d181e534818d8c3413b4d555990222574d9c92f81f17ff0af7a0583e76b3d3d4df2927561f37e57e15bc07b3f5d70306a9624c496d0bcb40085894bf32ef05db6469ec145c0ce5529e2697b6a0252c0216930cf7b3a7381762a6a91868e9d2bf823bfc7fb885de1fbd6a6cacae02db590318ffeb357ffd6832893ab0ccd3b15cef1df0fef45c091cf33fccee43a2834d44 -
Requiredrk string
Represents the randomized validating key for spendAuthSig.
Example : 39bdf742e16c4d1533a56df956bebe4d0214d4a361820db58a293847b6344d30 -
RequiredspendAuthSig string
Used to prove knowledge of the spending key authorizing spending of an input note.
Example : 0f3b38a91fffbbf58f99d2d070002c0868be6804204b7bf4be0df47f62ee5e0d43222776a71fd7e1421ec54502194192d73681701b743ad427573ca18a95a405
-
-
RequiredvalueBalance string
String representation of the transaction value balance
Example : 0 -
Requiredversion integer
Represents the transaction version number.
Example : 1 -
RequiredversionGroupId string
Represents the transaction version group ID.
Example : 0x892f2085 -
Requiredvin array
Object Array representation of transaction inputs
-
Requiredaddresses array
Represents the addresses which send/receive the amount.
Example : t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi -
RequiredscriptSig object
Specifies the required signatures.
-
Requiredasm string
The asm strands for assembly, which is the symbolic representation of the Bitcoin's Script language op-codes.
Example : OP_HASH160 ef775f1f997f122a062fff1a2d7443abd1f9c642 OP_EQUAL -
Requiredhex string
Represents the hex of the public key of the address.
Example : a914ef775f1f997f122a062fff1a2d7443abd1f9c64287 -
Requiredtype string
Represents the script type of the reference transaction identifier.
Example : pubkeyhash
-
-
Requiredsequence integer
Represents the script sequence number.
Example : 4294967295 -
Requiredtxid string
Represents the reference transaction identifier.
Example : 4b66461bf88b61e1e4326356534c135129defb504c7acb2fd6c92697d79eb250 -
Optionaltxinwitness array
Represents an array hex-encoded witness data (if there is any) as strings.
Example : 3045022100c11ea5740bcd69f0f68a4914279838014d28923134d18e05c5a5486dfd06cc8c02200dadccec3f07bed0d1040f9e5a155efa5fdd40fc91f92342578d26848da4c6b901 -
Requiredvalue string
Defines the specific amount.
Example : 0.000144 -
Requiredvout integer
It refers to the index of the output address of this transaction. The index starts from 0.
Example : 1
-
-
Requiredvout array
Object Array representation of transaction outputs
-
RequiredisSpent boolean
Defines whether the transaction output has been spent or not.
Example : True -
RequiredscriptPubKey object
Object representation of the script
-
Requiredaddresses array
Represents the addresses which send the amount.
Example : t2UNzUUx8mWBCRYPRezvA363EYXyEpHokyi -
Requiredasm string
Represents the assembly of the script public key of the address.
Example : OP_HASH160 ef775f1f997f122a062fff1a2d7443abd1f9c642 OP_EQUAL -
Requiredhex string
Represents the hex of the script public key of the address.
Example : a914ef775f1f997f122a062fff1a2d7443abd1f9c64287 -
OptionalreqSigs integer
Represents the required signatures.
Example : 1 -
Requiredtype string
Represents the script type.
Example : pubkeyhash
-
-
Requiredvalue string
Represents the specific amount.
Example : 0.000144
-
object-
Requiredcontract string
Represents the specific transaction contract
Example : 0x0000000000000000000000000000000000001000 -
RequiredgasLimit string
Represents the amount of gas used by this specific transaction alone.
Example : 21000 -
RequiredgasPrice object
-
Requiredamount string
Represents the price offered to the miner to purchase this amount of gas.
Example : 20000000000 -
Requiredunit string
Defines the unit of the gas price amount, e.g. BTC, ETH, XRP.
Example : BNB
-
-
RequiredgasUsed string
Defines the unit of the gas price amount, e.g. BTC, ETH, XRP.
Example : 21000 -
RequiredinputData string
Represents additional information that is required for the transaction.
Example : 0x -
Requirednonce integer
Represents the sequential running number for an address, starting from 0 for the first transaction. E.g., if the nonce of a transaction is 10, it would be the 11th transaction sent from the sender's address.
Example : 25341
object-
Requiredamount string
String representation of the amount value
-
RequiredbandwidthUsed string
Numeric representation of the transaction used bandwidth
-
Requiredcontract string
Numeric representation of the transaction contract
-
RequiredenergyUsed string
String representation of the transaction used energy
-
RequiredhasInternalTransactions boolean
-
RequiredhasTokenTransfers boolean
-
Requiredinput string
Numeric representation of the transaction input
-
Requiredstatus string
String representation of the transaction status
-
-
-
Content-Type: application/json
400
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object One Ofobject
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : uri_not_found -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The specified URI has not been found. Check the URI and try again. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : limit_greater_than_allowed -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_pagination -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
401
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object One Ofobject
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : missing_api_key -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_api_key -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The provided API key is invalid. Please, generate a new one from your Dashboard. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
insufficient_credits
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : insufficient_credits -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
403
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object One Ofobject
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : banned_ip_address -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : This IP address has been banned. To check the reason for that, please contact our team via email. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : endpoint_not_allowed_for_plan -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : endpoint_not_allowed_for_api_key -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : This endpoint is not available for your API key. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
object-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : feature_mainnets_not_allowed_for_plan -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
The specified resource has not been found.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
resource_not_found
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : resource_not_found -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : Resource not found -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
The data provided seems to be invalid.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
invalid_data
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_data -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The data provided seems to be invalid. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
The selected Media Type is unavailable. The Content-Type header should be 'application/json'.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
unsupported_media_type
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : unsupported_media_type -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The selected Media Type is unavailable. The Content-Type header should be 'application/json'. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
Your request body for POST requests must have a structure of { data: { item: [...properties] } }
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
invalid_request_body_structure
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : invalid_request_body_structure -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : Your request body for POST requests must have a structure of { data: { item: [...properties] } } -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
request_limit_reached
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : request_limit_reached -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-
Content-Type: application/json
An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext string
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error.
context
is specified by the user.Example : yourExampleString -
Requirederror object
unexpected_server_error
-
Requiredcode string
Specifies an error code, e.g. error 404.
Example : unexpected_server_error -
Requiredmessage string
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Example : An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. -
Optionaldetails array
-
Requiredattribute string
Specifies an attribute of the error by name.
Example : attribute which content caused the error -
Requiredmessage string
Specifies the details of an attribute as part from the error.
Example : message describing the error
-
-