Get deposit

GET 
/api/v2/deposit/:id

Get a deposit by its ID

Request

Path Parameters

id stringrequired

Deposit ID to return data for.

Responses

200

A successful response.

application/json

Schema

Schema

deposit object

Deposit matching the ID from the request.

amount string

Amount to be deposited. This field is an unsigned integer scaled to the asset's decimal places.

asset string

Vega asset targeted by this deposit.

createdTimestamp int64

Timestamp for when the deposit was created on the Vega network.

creditedTimestamp int64

Timestamp for when the Vega account was updated with the deposit.

id string

Unique ID for the deposit.

partyId string

Party ID of the user initiating the deposit.

status Status of the deposit

Possible values: [STATUS_UNSPECIFIED, STATUS_OPEN, STATUS_CANCELLED, STATUS_FINALIZED, STATUS_DUPLICATE_REJECTED]

Default value: STATUS_UNSPECIFIED

Status of the deposit.

txHash string

Hash of the transaction from the foreign chain.

Example (from schema)

{
  "deposit": {
    "amount": "string",
    "asset": "string",
    "createdTimestamp": "string",
    "creditedTimestamp": "string",
    "id": "string",
    "partyId": "string",
    "status": "STATUS_UNSPECIFIED",
    "txHash": "string"
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...