Get Deposit Session

Check the status of a deposit session.

GET /api/v1/widgets/deposit-sessions/:sessionId

Returns the current state of a deposit session, including whether the payment has been detected on-chain and confirmed.

This endpoint accepts either a JWT bearer token or the session’s client secret via X-Client-Secret header.

Parameters

Path

Name	Type	Required	Description
sessionId	string	Yes	The deposit session ID

Request example

curl --request GET 'https://payments.bleepay.com/api/v1/widgets/deposit-sessions/dep_a1b2c3d4e5f6' \
  --header 'X-Client-Secret: dep_secret_xyz...'

Response

Response schema

Field	Type	Description
id	string	Session identifier
paymentStatus	string	Status: CREATED, PENDING, CONFIRMED, EXPIRED, UNDERPAID, OVERPAID
amount	string	Payment amount
currency	string	Currency symbol
network	string	Blockchain network
currencyAddress	string	Currency contract address
depositAddress	string	Destination address
txId	string or null	Blockchain transaction hash (set when PENDING or CONFIRMED)
expiresAt	string	ISO 8601 expiry timestamp
confirmedAt	string or null	ISO 8601 confirmation timestamp

Example response

{
  "id": "dep_a1b2c3d4e5f6",
  "paymentStatus": "CONFIRMED",
  "amount": "100",
  "currency": "USDC",
  "network": "polygon",
  "currencyAddress": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
  "depositAddress": "0xMerchantWalletAddress",
  "txId": "0xabc123def456...",
  "expiresAt": "2026-06-09T12:30:00.000Z",
  "confirmedAt": "2026-06-09T12:05:00.000Z"
}

Error responses

Status	Code	Description
401	unauthorized	Missing or invalid authentication
404	not_found	Session not found