Deposits

Create deposit transfer lots

Changed on

Associates one or more cost-basis lots with a deposit for tax reporting.

post/deposits/{deposit_id}/lots

Request

  • Base URL
    https://api.cert.zerohash.com
  • URL
    https://api.cert.zerohash.com/deposits/{deposit_id}/lots
  • Auth
    API key in header X-SCX-API-KEY and API key in header X-SCX-PASSPHRASE

Path parameters

deposit_idstring required

The unique identifier of the deposit — the deposit_id returned by the GET crypto deposits endpoints, which equals the movement_id returned by the GET deposits endpoint.

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Request body

request_idstring

Client-supplied idempotency key for the create request. When omitted, zerohash generates one. Reusing a request_id for the same deposit is rejected as a duplicate.

effective_datetimestring date-time

RFC3339 timestamp marking when the transfer lots take effect for tax reporting. Defaults to the deposit’s settlement time when omitted.

Example request

{
  "request_id": "21bdbb11-712f-4cb7-a178-4f277c80cde0",
  "effective_datetime": "2024-01-01T00:00:00Z",
  "lots": [
    {
      "quantity": "1.5",
      "cost_basis": "45000.00",
      "acquisition_transaction_datetime": "2024-01-01T00:00:00Z"
    }
  ]
}

Response

Transfer lots created for the deposit.

Example response

{
  "message": {
    "request_id": "21bdbb11-712f-4cb7-a178-4f277c80cde0",
    "deposit_id": "21bdbb11-712f-4cb7-a178-4f277c80cde0",
    "status": "reported",
    "participant_code": "ABCDEF",
    "account_label": "general",
    "effective_datetime": "2024-01-01T00:00:00Z",
    "lots": [
      {
        "quantity": "1.5",
        "cost_basis": "45000.00",
        "acquisition_transaction_datetime": "2024-01-01T00:00:00Z"
      }
    ],
    "error_message": "lot quantity exceeds deposit amount",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

Changes