Skip to main content

Get Status of Recent Deposits

POST 

/private/DepositStatus

Retrieve information about recent deposits. Results are sorted by recency, use the cursor parameter to iterate through list of deposits (page size equal to value of limit) from newest to oldest. API Key Permissions Required: Funds permissions - Query

Request

Body

required
    nonce int64required

    Nonce used in construction of API-Sign header

    asset string

    Filter for specific asset being deposited

    aclass string

    Default value: currency

    Filter for specific asset class being deposited

    method string

    Filter for specific name of deposit method

    start string

    Start timestamp, deposits created strictly before will not be included in the response

    end string

    End timestamp, deposits created strictly after will be not be included in the response

    cursor object

    true/false to enable/disable paginated response (boolean) or cursor for next page of results (string)

    anyOf

    boolean

    limit integer

    Default value: 25

    Number of results to include per page

Responses

Recent deposits retrieved.

Schema
    result object
    anyOf
    method string

    Name of deposit method

    aclass string

    Asset class

    asset string

    Asset

    refid string

    Reference ID

    txid string

    Method transaction ID

    info string

    Method transaction information

    amount string

    Amount deposited

    fee

    Fees paid

    time int32

    Unix timestamp when request was made

    status

    Status of deposit
    For information about the status, please refer to the IFEX financial transaction states.

    status-prop string

    Possible values: [return, onhold]

    Addition status properties (if available)

    • return A return transaction initiated by Kraken
    • onhold Deposit is on hold pending review
    originators string[]

    Client sending transaction id(s) for deposits that credit with a sweeping transaction

    error string[]
Loading...