Check Payment Address Logs

View as Markdown

This method provides information and callbacks for addresses created through the create endpoint.

It returns a list of callbacks made at the specified callbacks parameter, and allows to track payment activity and troubleshoot any issues.

Method: GET

Path: https://api.blockbee.io/{ticker}/logs/

Parameters

Path Parameters

tickerstring•Required

The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request.

It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.

For example, btc is the ticker for Bitcoin, and trc20/usdt is the ticker for USDT over TRC-20. Having this in mind, a request for USDT over TRC-20 will look like this: https://api.blockbee.io/trc20/usdt/create/.

Notes:

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.

callbackstring•Required

The URL of the callback. Must be the same URL provided when the payment was created.

Notes:

  • It's advised to store the callback URL when creating a new payment address if you wish to use this endpoint later.
  • We advise URL Encoding the callback when making the request. If using one of our libraries there's no need for it.

Returns

Returns a list of callbacks for the specified address. Returns an error if the address is not found or if there are no callbacks.

address_instring

Generated address for the callback URL provided.

address_outstring

Your address(es), where the payment will be forwarded to, should be the same address(es) you provided.

Notes:

  • Response will be {1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP: 0.70, 1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3: 0.30} (multiple addresses)

callback_urlstring

The callback URL you provided.

statusstring

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

notify_pendingboolean

Shows if you enabled the pending callback when creating the address.

notify_confirmationsinteger

Number of confirmations required before sending the confirmed callback.

prioritystring

The confirmation priority you requested.

callbacksArray of objects

List of payments made to this address, together with the logs of the callbacks to your system.

txid_instring

Hash of the transaction received from the client.

txid_outstring

Hash of the transaction of the payment to you.

value_coinnumber

Value sent by your customer to the created address.

value_forwarded_coinnumber

Value forwarded to your wallet address, after fees.

confirmationsinteger

Number of blockchain confirmations of the current transaction.

last_updatestring

Time and date when this callback was last updated (UTC-0).

resultstring

Result status of this callback. It can be one of the following options:

  • pending (transaction is being confirmed by the blockchain)
  • sent (payment forwarded to your address but webhook didn't receive valid *ok* response)
  • done (payment forwarded and webhook sent to your URL with valid *ok* response received)
fee_percentnumber

Percentage of the fee charged by BlockBee.

fee_coinnumber

Value of BlockBee Fee deducted from value_coin.

logsArray of objects

Last 10 requests to your server, ordered by timestamp descending.

request_urlstring

URL that BlockBee API tried to call with the GET parameters included.

Notes:

  • If was set to POST while creating the address the only GET parameters provided in the URL, will be the ones provided by you in the callback parameter, while the BlockBee parameters will be in POST.
responsesstring

Response given by your systems to our callback.

response_statusstring

HTTP Status code provided by your system to our callback.

next_trystring

Datetime in UTC-0 when callback will be retried (if not done).

pendinginteger

Will be 1 if it is the pending callback.

confirmedinteger

Will be 1 if it is the confirmed callback