List withdrawals

GET 
/api/v2/withdrawals

Get a list of withdrawals for a given party

Request

Query Parameters

partyId string

Restrict withdrawals to those made by this party ID.

pagination.first int32

Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

pagination.after string

If paging forwards, the cursor string for the last row of the previous page.

pagination.last int32

Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

pagination.before string

If paging forwards, the cursor string for the first row of the previous page.

pagination.newestFirst boolean

Whether to order the results with the newest records first. If not set, the default value is true.

dateRange.startTimestamp int64

Timestamp in Unix nanoseconds indicating the start of the date range.

dateRange.endTimestamp int64

Timestamp in Unix nanoseconds indicating the end of the date range.

Responses

200

A successful response.

application/json

Schema

Schema

withdrawals object

Page of withdrawals data and corresponding page information.

edges object[]

Page of withdrawals data and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

Data associated with a single withdrawal made from the Vega network.

amount string

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

asset string

Asset to withdraw funds from.

createdTimestamp int64

Timestamp for when the network started to process this withdrawal.

ext object

Foreign chain specifics.

erc20 object

ERC20 withdrawal details.

receiverAddress string

Address into which the bridge will release the funds.

id string

Unique ID for the withdrawal.

partyId string

Unique party ID of the user initiating the withdrawal.

ref string

Reference which is used by the foreign chain to refer to this withdrawal.

status Status of the withdrawal (string)

Possible values: [STATUS_UNSPECIFIED, STATUS_OPEN, STATUS_REJECTED, STATUS_FINALIZED]

Default value: STATUS_UNSPECIFIED

Status of the withdrawal.

txHash string

Hash of the foreign chain for this transaction.

withdrawnTimestamp int64

Timestamp for when the withdrawal was finalised by the network.

]

pageInfo object

Page information that is used for fetching further pages.

endCursor string

End cursor.

hasNextPage boolean

Indicator if there is a next page.

hasPreviousPage boolean

Indicator if there is a previous page.

startCursor string

Start cursor.

Example (from schema)

{
  "withdrawals": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "amount": "string",
          "asset": "string",
          "createdTimestamp": "string",
          "ext": {
            "erc20": {
              "receiverAddress": "string"
            }
          },
          "id": "string",
          "partyId": "string",
          "ref": "string",
          "status": "STATUS_UNSPECIFIED",
          "txHash": "string",
          "withdrawnTimestamp": "string"
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "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...