Skip to main content
GET
List withdrawal requests

Authorizations

x-api-key
string
header
required

API key in format: pxl_<public_id>_

Query Parameters

pageSize
number
default:25

Maximum items per page. Default: 25. Min: 1, max: 100.

Required range: 1 <= x <= 100
Example:

25

pageToken
string

Opaque token for the next page. Omit for the first page.

filter
string

Filter string. Flags: status (PENDING|COMPLETE|PENDING_REFUND|REFUNDED), chainId, wantAssetAddress, vaultAddress, userAddress, receiverAddress, refundReceiverAddress, orderIndex, isSubmittedViaSignature, isForceProcessed, isMarkedForRefund, isMarkedForRefundByUser, didOrderFailTransfer. Optional.

Example:

"status=PENDING AND chainId=1 AND wantAssetAddress=0x1234567890abcdef1234567890abcdef12345678 AND vaultAddress=0x1234567890abcdef1234567890abcdef12345678 AND userAddress=0x1234567890abcdef1234567890abcdef12345678 AND isMarkedForRefund=false"

Response

List of withdrawal requests

withdrawalRequests
object[]
required

List of withdrawal requests

nextPageToken
string | null
required

Token for the next page. null when there are no more results. Always present.

Example:

"eyJvZmZzZXQiOjI1fQ=="

tokenMetadata
object
required

Address metadata map keyed by lowercase token/address. Missing metadata is represented as null.