Merchant API

Checkout Payment Logs

Returns detailed information about a checkout payment, including status flags, payment amounts and a full history of IPN notifications sent to your server. This endpoint behaves similarly to KingPay’s /checkout/logs/.

GET https://api-service.kingpay.online/checkout/logs/

Use this endpoint to debug integration issues or audit how IPN callbacks were delivered for a specific payment_id.

Notices

  • Logs are available only for checkouts created through the /checkout/request/ endpoint.
  • This endpoint is authenticated via your apikey and can only access payments belonging to that project.
  • It is intended for server-side usage, not for direct exposure to end-users.

Query parameters (required)

apikey string • required

Project API key generated in your merchant dashboard. Must match the project that owns the checkout.

token string • required

Checkout payment identifier (payment_id) returned by the /checkout/request/ endpoint. Internally mapped to the invoice UID.

Query parameters (optional)

This endpoint currently does not expose any optional filters. In the future, filters for date ranges or pagination may be added.

Request example (cURL)
curl -G \
  'https://api-service.kingpay.online/checkout/logs/' \
  --data-urlencode 'apikey=YOUR_PROJECT_API_KEY' \
  --data-urlencode 'token=e1f3d8b9a24c4f2e9b4d6a3c1f2a9c3b'
Response (200 • application/json)
{
  "status": "success",
  "is_paid": true,
  "is_pending": false,
  "is_expired": false,
  "is_partial": false,
  "payment_data": [
    {
      "value": "99.9",
      "value_paid": "99.9",
      "value_outstanding": "0",
      "exchange_rate": "1",
      "coin": "trc20_usdt",
      "txid": [
        "f5e3d9a2c1b4e6f8..."
      ]
    }
  ],
  "notifications": [
    {
      "request_url": "https://example.com/ipn/cryptapi?invoice_id=123",
      "payload": {
        "payment_id": "e1f3d8b9a24c4f2e9b4d6a3c1f2a9c3b",
        "payment_url": "https://pay.yourdomain.com/pay/e1f3d8b9a24c4f2e9b4d6a3c1f2a9c3b",
        "redirect_url": "https://example.com/thank-you",
        "value": "99.9",
        "currency": "usd",
        "is_paid": "1",
        "paid_amount": "99.90",
        "paid_amount_fiat": "99.90",
        "received_amount": "99.90",
        "received_amount_fiat": "99.90",
        "paid_coin": "trc20_usdt",
        "exchange_rate": 1,
        "txid": "f5e3d9a2c1b4e6f8...",
        "address": "TRX_RECEIVE_ADDRESS",
        "type": "payment",
        "status": "done",
        "payment_status": "completed",
        "invoice_status": "paid",
        "confirmations": 20,
        "required_confirmations": 5,
        "customer_email": "null",
        "customer_name": "null",
        "external_id": null,
        "uuid": "d4d6cf64-3fda-485d-8c47-6948870058ef"
      },
      "payment_url": "https://pay.yourdomain.com/pay/e1f3d8b9a24c4f2e9b4d6a3c1f2a9c3b",
      "redirect_url": "https://example.com/thank-you",
      "value": "99.9",
      "success_token": "8c0d3a9b9a1c4f3e8b1d2c3a4f6e7b1f4c0d9a8e1b2c3d4e5f6a7b8c9d0e1f2",
      "currency": "usd",
      "is_paid": 1,
      "paid_amount": "99.90",
      "paid_coin": "trc20_usdt",
      "exchange_rate": 1,
      "txid": "f5e3d9a2c1b4e6f8...",
      "address": "TRX_RECEIVE_ADDRESS",
      "status": "done",
      "response": "{\"status\":\"ok\"}",
      "response_status": 200,
      "pending": false,
      "timestamp": "2025-11-23T10:15:30.000Z"
    }
  ]
}

This example shows a completed delivery. History also includes pending and confirmed events and delivery retries. New checkout payloads use a decimal string in ordinary fiat units for value, without multiplying by 100. Historical payloads are returned as originally stored and may retain the legacy numeric amount ×100; do not rewrite them before signature verification. Confirmation fields are inside payload. Notification pending describes delivery success, not blockchain confirmation status.

Response fields

  • status — request result ("success" on success).
  • is_paid — true if the invoice is fully paid.
  • is_pending — true if payment is still pending.
  • is_expired — true if the invoice has expired.
  • is_partial — true if some funds were received, but not enough to fully cover the invoice amount.
  • payment_data — aggregated payment information per coin / address: value, value_paid, value_outstanding, exchange_rate, coin, txid.
  • notifications — array of IPN delivery attempts containing the original payload, destination URL, HTTP response and timestamp.