Merchant API

Check Payment Address Logs

Returns detailed information and webhook logs for payment addresses created through the /{'{ticker}'}/create/ endpoint. Use this to inspect what was received on-chain and how KingPay attempted to call your callback URL.

GET https://api-service.kingpay.online/{'{ticker}'}/logs/

The ticker is part of the path (for example /btc/logs/ or /trc20/usdt/logs/). Other parameters are passed as query string. The result contains the generated addresses, configuration of the callbacks and the list of payments and webhook attempts.

Notices

  • You must provide the same callback URL you used when creating the payment address, including all its query parameters.
  • We recommend URL-encoding the callback value to avoid losing or breaking its own query string.
  • The callbacks list includes both the blockchain payment data and the history of webhook attempts (request URL, response body, HTTP status, next retry, etc.).
  • If no callbacks exist for that address, the endpoint may return an error or an empty list, depending on your integration needs.

Path & query parameters (required)

ticker string • path • required

Crypto/network identifier of the address whose logs you want to fetch. Examples: btc, ltc, trc20/usdt.

Example URL: https://api-service.kingpay.online/btc/logs/

apikey string • required

Project API key from your merchant dashboard. Used to authenticate and select which project the address belongs to.

Can be passed as query string or via the apikey HTTP header.

callback string • required

Callback URL associated with the payment address. It must match exactly the URL you used in the original /{'{ticker}'}/create/ call (including any query parameters).

Example: https://example.com/ipn/order?order_id=1234

Query parameters (optional)

— none

This endpoint does not support additional optional query parameters at the moment. All filtering is based on the ticker and the exact callback URL.

Request example (cURL)
curl -G \
  'https://api-service.kingpay.online/btc/logs/' \
  --data-urlencode 'apikey=YOUR_PROJECT_API_KEY' \
  --data-urlencode 'callback=https://example.com/invoice/1234?payment_id=5678'
Response (200 • application/json)
{
  "address_in": "14PqCsA7KMgseZMPwg6mJy754MtQkrgszu",
  "address_out": {
    "1H6ZZpRmMnrw8ytepV3BYwMjYYnEkWDqVP": 0.70,
    "1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3": 0.30
  },
  "callback_url": "https://example.com/invoice/1234?payment_id=5678",
  "status": "success",
  "notify_pending": true,
  "notify_confirmations": 1,
  "priority": "default",
  "callbacks": [
    {
      "txid_in": "33f11611f863d7475eb10daada2f225f0877561cf58cdfff175e99635dfd9120",
      "txid_out": "5ea53d5e728bfdb56b54c0b945990b69ae1e66cec56ab24679c9a622c4695276",
      "value_coin": 0.1,
      "value_forwarded_coin": 0.099,
      "confirmations": 13,
      "last_update": "15/02/2018 21:23:42",
      "result": "done",
      "fee_percent": 1,
      "fee_coin": 0.001,
      "forwards": [{"txid_out": "5ea53d5e728bfdb56b54c0b945990b69ae1e66cec56ab24679c9a622c4695276", "address_out": null, "value_forwarded_coin": 0.099}],
      "deliveries": [],
      "logs": [
        {
          "request_url": "https://example.com/callback.php?order_id=423&nonce=KRnrAtVbbPrA21TR4yQDESnTV5xxV4jR&...",
          "responses": "*ok*",
          "response_status": "200",
          "next_try": null,
          "payment_status": "completed",
          "confirmed": 1
        }
      ]
    }
  ]
}

Response fields

  • address_in — payment address generated for the given callback URL.
  • address_out — payout address or map of payout addresses and their proportion. Should match what you configured on creation.
  • callback_url — callback URL associated with this address.
  • status — overall request status (for example "success" when the lookup succeeded).
  • notify_pending — saved legacy option; UTXO confirmation progress is sent regardless of this flag.
  • notify_confirmations — number of confirmations required before sending the “confirmed” callback.
  • priority — confirmation profile used when the address was created (for example default, high).
  • callbacks — list of payment-related callback entries for this address.
  • txid_in — blockchain transaction hash received from the payer.
  • txid_out — single outgoing hash (null for multiple or unknown hashes). See forwards[] for all hashes. Destination address.
  • value_coin — amount sent by the customer to address_in, in crypto units.
  • value_forwarded_coin — amount forwarded to your payout address after deducting fees.
  • confirmations — current number of blockchain confirmations for the payment.
  • last_update — last time this callback record was updated (UTC).
  • result — state of the callback flow: pending, sent or done.
  • network_fee — network-cost deduction in the payment currency, or null for historical unknown values. This is separate from the service fee. fee_percent — fee rate charged for this payment (percentage).
  • fee_coin — total service fee for this incoming payment. Unknown fees, including unversioned UTXO fees, are null.
  • forwards[] — associated outgoing transfers, each with txid_out, address_out and value_forwarded_coin. Unknown addresses or amounts are null; no saved association produces an empty array. Fees appear only at payment level. deliveries[] contains webhook delivery states and retry deadlines. logs contains up to 10 latest attempts.
  • request_url — full URL that KingPay attempted to call (including query parameters).
  • responses — raw body returned by your server (for example *ok*).
  • response_status — HTTP status code returned by your server.
  • next_try — next scheduled attempt time in UTC, if the callback is still pending.
  • payment_status — pending, confirmed, or completed for this callback.
  • confirmed — 1 when this log entry corresponds to the “confirmed” callback.