Get Blockchain Event Subscription Details By Reference ID
Through this endpoint the customer can get detailed information for a callback subscription by providing its reference ID.
Currently Crypto APIs 2.0 offers certain Blockchain event endpoints which allow the user to subscribe for one/a few/all and receive callback notifications when the specific event occurs.
Path Parameters
-
RequiredreferenceId string
Represents a unique ID used to reference the specific callback subscription.
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.
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
-
Optionaladdress string
Represents the address of the transaction.
Example : tb1qtm44m6xmuasy4sc7nl7thvuxcerau2dfvkkgsc -
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
Example : bitcoin -
OptionalcallbackSecretKey string
Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our Documentation.
Example : yourSecretKey -
RequiredcallbackUrl string
Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs.
Example : http://example.com -
OptionalconfirmationsCount integer
Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.
Example : 5 -
RequiredcreatedTimestamp integer
Defines the specific time/date when the subscription was created in Unix Timestamp.
Example : 1966238648 -
OptionaldeactivationReasons array
Represents the deactivation reason details, available when a blockchain event subscription has status isActive - false.
-
Requiredreason string
Defines the deactivation reason as a message.
Example : maximum_retry_attempts_reached -
Requiredtimestamp integer
Represents the time of the subscription deactivation.
Example : 1642102581
-
-
RequiredeventType string
Defines the type of the specific event available for the customer to subscribe to for callback notification.
Example : ADDRESS_COINS_TRANSACTION_CONFIRMED -
RequiredisActive boolean
Defines whether the subscription is active or not. Set as boolean.
Example : False -
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 : testnet -
RequiredreferenceId string
Represents a unique ID used to reference the specific callback subscription.
Example : bc243c86-0902-4386-b30d-e6b30fa1f2aa -
OptionaltransactionId string
Represents the unique identification string that defines the transaction.
Example : 742b4a8d54a663d372fa16abf74093595ae6fc950f2fa2bb7388c7f4d061d7b8
-
-