Pre-Reckoning Report

wbhk

PreReckoningReport

A concise summary of what transactions will be included in the reckoning and how much fiat and security amounts are required to complete all the transactions in reckoning. The report is triggered one hour before the schedule reckoning.

Payload

Payload, sent to the URL provided in the subscriptions to this webhook type.

Pre-reckoning report.

createdAt

date-time

required

Event creation time.

userId

uuid

required

Unique identifier of the main account.

cryptoSummaries

array of objects

required

Summaries for cryptocurrencies which are involved in the reckoning.

cryptoSummaries*

fiatSummaries

array of objects

required

Summaries for fiat currencies involved in the reckoning.

fiatSummaries*

transactions

array of objects

required

List of transactions involved in the reckoning.

transactions*

Headers

x-api-signature

string

required

Signature generated from the webhook event payload and subscription secret. See API Key Authentication. Except that there is no "x-api-key" in this case.

x-subscription-id

uuid

required

Unique identifier for the webhook subscription.

x-event-id

uuid

required

Unique identifier of a specific webhook event. Has the same value for retried requests. Should be treated as an idempotency key.

x-event-type

string

enum

required

Type of this webhook event.

Allowed:

Responses

1XX

Informational. The request will be retried.

2XX

Acknowledgement that the request was received and processed successfully.

3XX

Redirection. The request will be retried.

4XX

Client error (invalid signature, duplicated idempotency key, malformed request, etc.). The request will not be retried.

5XX

Server error while processing the request. The request will be retried.