Skip to main content
Get refund history

Used in these guides

  • Payment Integration — crypto deposits, withdrawals, conversion, WhiteBIT Codes, and Express Withdraw.

Authorizations

X-TXC-APIKEY
string
header
required

The public WhiteBIT API key.

X-TXC-PAYLOAD
string
header
required

Base64-encoded JSON request body.

X-TXC-SIGNATURE
string
header
required

HMAC-SHA512 signature of the payload, hex-encoded. Computed as hex(HMAC-SHA512(payload, api_secret)).

Body

application/json
request
string
required

Request path. See the authentication guide for signature generation details.

Example:

"{{request}}"

nonce
integer
required

A unique identifier for the request. Use a monotonically increasing value such as a Unix timestamp in milliseconds.

Example:

1594297865000

depositId
string

Deposit transaction UUID. Returns refunds for this deposit only.

Maximum string length: 255
Example:

"8f2b0a2e-1c4e-4a2f-9a1d-6f1f4a0d7e31"

ticker
string

Currency ticker. Exact match, case-insensitive. Matches the currency on every network — for example, USDT returns refunds of USDT deposits on all networks. The network of each refund is in the network response field.

Maximum string length: 255
Example:

"BTC"

limit
integer
default:100

Maximum number of records to return.

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

100

offset
integer
default:0

Number of records to skip.

Required range: 0 <= x <= 10000
Example:

0

Response

Refund history returned

limit
integer
required

Applied limit value

offset
integer
required

Applied offset value

records
object[]
required