Skip to main content

private/fiat/fiat-withdraw-history

POST 

/private/fiat/fiat-withdraw-history

Retrieves paginated fiat withdrawal transaction history for the authenticated user.

Request

Body

required
    id int64required

    Request id (echoed in response)

    method stringrequired

    Must be "private/fiat/fiat-withdraw-history"

    api_key stringrequired

    Your API key (only required for private REST)

    sig stringrequired

    HMAC-SHA256 signature in hex (only required for private REST)

    nonce int64required

    Current timestamp in milliseconds, e.g. "1771761038000".

    params objectrequired
    page int32required

    Page number (0-based).

    page_size int32required

    Number of items per page.

    start_time int64

    Start time for filtering transactions, as a Unix timestamp in milliseconds. Required if end_time is provided.

    end_time int64

    End time for filtering transactions, as a Unix timestamp in milliseconds.

    payment_networks string

    Comma-separated list of payment networks to filter by

Success.
Schema
    id int64

    Echoed request id

    method string

    Method invoked

    code int32

    0 = success; non-zero indicates error (reason code).

    result object
    Present when code === 0. transaction_history_list, page, page_size, total per docs.
    page int32required

    Current page number

    page_size int32required

    Number of items per page

    total int32required

    Total number of transactions

    transaction_history_list object[]required
    List of withdrawal transactions
  • Array [
  • id int64required

    Transaction ID.

    account_id int64

    Account ID.

    currency stringrequired

    Currency code

    amount decimalrequired

    Transaction amount

    amount_in_usd decimalnullable

    Amount in USD.

    fee_currency string

    Fee currency

    fee_amount decimal

    Transaction fee amount

    fee_amount_in_usd decimalnullable

    Fee amount in USD

    fee decimal

    Transaction fee (alternate).

    payment_network stringrequired

    Payment network identifier

    status stringrequired

    Transaction status (pending, completed, failed, cancelled)

    created_at int64required

    Transaction creation timestamp (ms).

    updated_at int64

    Transaction update timestamp (ms).

    completed_at int64nullable

    Transaction completion timestamp (ms).

    client_wid stringnullable

    Optional client withdrawal ID. Returns null if no client_wid was supplied at creation time.

    vendor_transaction_id stringnullable

    Transaction identifier assigned by the upstream fiat vendor / payment service provider (PSP) that processed the withdrawal.

    sender objectnullable
    Sender or beneficiary in a fiat deposit/withdraw transaction.
    account_identifier_value string

    Account identifier value

    beneficiary objectnullable
    Sender or beneficiary in a fiat deposit/withdraw transaction.
    account_identifier_value string

    Account identifier value

  • ]
  • message string

    Present when code !== 0.

    original string

    Present when code !== 0.