Skip to main content
GET
/
api
/
v3
/
deposit
/
crypto-bridge
/
status
/
{kotani_reference_id}
Get crypto bridge deposit status
curl --request GET \
  --url https://sandbox-api.kotanipay.com/api/v3/deposit/crypto-bridge/status/{kotani_reference_id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Crypto bridge deposit status retrieved.",
  "data": {
    "kotani_reference_id": "KOTANI-REF-789",
    "provider_reference_id": "PROVIDER-TXN-20241122-001",
    "status": "PAYMENT_SENT",
    "transaction_type": "cross_border",
    "chain": "LIGHTNING",
    "token": "MSAT",
    "stages": {
      "deposit": {
        "status": "DEPOSIT_CONFIRMED",
        "timestamp": "2024-11-22T12:00:45Z",
        "amount": 1000,
        "currency": "KES",
        "chain": "LIGHTNING",
        "token": "MSAT",
        "payment_hash": "a1b2c3d4e5f6...",
        "amount_msat": 150000000
      },
      "crypto_payment": {
        "status": "DEPOSIT_CONFIRMED",
        "timestamp": "2024-11-22T12:00:45Z",
        "amount": 1000,
        "currency": "KES",
        "chain": "LIGHTNING",
        "token": "MSAT",
        "payment_hash": "a1b2c3d4e5f6...",
        "amount_msat": 150000000
      },
      "settlement": {
        "status": "DEPOSIT_CONFIRMED",
        "timestamp": "2024-11-22T12:00:45Z",
        "amount": 1000,
        "currency": "KES",
        "chain": "LIGHTNING",
        "token": "MSAT",
        "payment_hash": "a1b2c3d4e5f6...",
        "amount_msat": 150000000
      }
    },
    "metadata": {
      "sender_name": "John Doe",
      "sender_country": "KE",
      "recipient_name": "Jane Smith",
      "recipient_country": "ZA",
      "notes": "Family support payment"
    },
    "refund_config": {
      "primary_method": "CRYPTO_INVOICE",
      "chain": "LIGHTNING",
      "token": "MSAT",
      "refund_invoice": "lnbc1500n1p0xyz...",
      "refund_payment_hash": "a1b2c3d4e5f6...",
      "refund_amount_msat": 150000000,
      "refund_crypto_amount": 150.5,
      "fallback_address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
      "fallback_method": "CRYPTO_ADDRESS",
      "expires_at": "2024-11-22T13:00:00Z"
    },
    "collection_instructions": {
      "bank_name": "Equity Bank Kenya",
      "account_name": "Kotani Pay Ltd",
      "account_number": "0123456789",
      "reference": "KCB-TXN-20241122-ABC",
      "amount": 1000,
      "currency": "KES",
      "instructions": "Transfer KES 1,000 to the account above. Use the reference exactly as shown as your payment narrative."
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

kotani_reference_id
string
required

Kotani reference ID for the transaction

Example:

"KOTANI-REF-789"

Response

success
boolean
Example:

true

message
string
Example:

"Crypto bridge deposit status retrieved."

data
object