Page cover

Querying for Withdraw Requests

requires auth

Querying for Withdraw Requests

Endpoint to query all your withdraw requests from your 1KPrime account to your external whitelisted wallets and Bank accounts. It also returns the status of the request, if pending or completed.

GET /api/v1/accounting/account/{accountId}/request/withdraw

Path Parameters:

Path
Type
Description

accountId*

string

your account ID

Query Parameters:

Body
Type
Description

max

integer

Maximum amount of records returned. Default: 100

status

string

Status of the request. Enum: "pending", "completed", "canceled", or "rejected"

transactionId

string

The transaction Id for your request generated by the system when you submitted a withdraw request.

network

string

The blockchain network for the recipient wallet address. See Network Types.

withdrawType

string

Type of asset to be withdrawn. Enum: fiat or blockchain

fiatWithdrawType

string

The type of fiat withdrawal. See Fiat Methods.

startAtOrdering

integer

A value that increases with time in order of the records and when they're updated. Records returned are updated after the record identified by this ordering ID. Useful for walking through all records via a polling mechanism.

submittedAtMin

string

The minimum date and time the withdrawal request was submitted as an ISO-8601 formatted string.

submittedAtMax

string

The maximum date and time the withdrawal request was submitted as an ISO-8601 formatted string.

initiatingUserId

string

Id of user who initiated the withdrawal request

cancellingUserId

string

Id of the user who cancelled the withdrawal request

asc

boolean Default: true

True to sort by ordering ascending order, otherwise false

Example

Last updated