Get Deposit Logs

View as Markdown

Fetches logs of all deposits made to your Deposit link, including transaction details, value in fiat currency, and the status of each deposit. This endpoint is essential for tracking incoming payments and ensuring they are correctly processed and reconciled in your system.

Method: GET

Path: https://api.blockbee.io/deposit/logs/

Parameters

Query Parameters

`apikeystring`•Required

API Key provided by BlockBee's Dashboard. Unsure how to get yours? Check this tutorial. Note: The API key can also be sent as a header named apikey.

`tokenstring`•Required

The payment_id provided upon requesting the deposit link.

Example:fG78jtx96ugjtu0eIbeLmFB9z0feJf9N

Returns

Returns a list of deposit transactions made to your account.

`statusstring`

Status of the request. Should be success if the request didn't fail.

`depositsobject[]`

Array of objects

txidstring

The transaction ID of the deposit.

valuestring

The amount deposited in cryptocurrency.

value_fiatstring

The equivalent fiat value of the deposited amount.

coinstring

The type of cryptocurrency used for the deposit.

pendingboolean

Indicates if the deposit is still pending.

logostring

URL to the logo of the cryptocurrency used.

timestampstring

The timestamp when the deposit was made.

`total_depositedstring`

The total amount deposited.

`currencystring`

The fiat currency used for the value_fiat field.

`notificationsobject[]`

Notifications sent regarding deposit processing.

request_urlstring

The URL to which the notification request was sent.

payloadobject

Details of the notification sent.

payment_urlstring

The URL for the hosted checkout page where the user can complete the payment.

redirect_urlstring

URL where your customers will be redirected to after successfully completing the payment.

valuestring

Value of the order.

success_tokenstring

A unique token that is passed to your redirect_url to verify the payment's authenticity on your end.

currencystring

The FIAT currency of the value.

is_paidinteger

1 if the payment is paid.

paid_amountstring

The amount paid by the user.

paid_coinstring

The cryptocurrency the user paid with.

exchange_ratestring

The exchange rate applied to the payment.

txidstring

The transaction ID of the payment.

addressstring

The address that received the payment.

statusstring

Status of the payment.

responsestring

The server's response to the notification request.

response_statusstring

The HTTP status code of the response received.

pendingboolean

Indicates whether the notification is still pending.

timestampstring

The timestamp when the notification was sent.

Response

JSON

{
  "status": "success",
  "logs": [
    {
      "address_in": "14PqCsA7KMgseZMPwg6mJy754MtQkrgszu",
      "address_out": "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP",
      "value_coin": "0.00100000",
      "value_forwarded_coin": "0.00099000",
      "value_usd": "107.99",
      "callback_url": "https://example.com/your_callback?invoice_id=123",
      "confirmations": 3,
      "txid_in": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
      "txid_out": "z6y5x4w3v2u1t0s9r8q7p6o5n4m3l2k1j0i9h8g7f6e5d4c3b2a1",
      "timestamp": "2024-01-15 10:30:45",
      "pending": 0,
      "fee": "0.00001000",
      "fee_usd": "1.08",
      "priority": "default",
      "value_coin_convert": "{\"USD\":\"107.99\",\"EUR\":\"98.45\"}",
      "value_forwarded_coin_convert": "{\"USD\":\"106.91\",\"EUR\":\"97.47\"}"
    }
  ]
}