Deposit requests

Get a deposit request

GET/v1/deposit-requests/{id}

Retrieves a deposit request by id or by deposit address.

API key · or dashboard session.

Request

Shell
curl -fsS "$API/v1/deposit-requests/dr_0198f80c-8d2f-7dc1-a369-90556a64f700?wait_for=change&timeout=30" \
  -H "Authorization: Bearer $PAYDAY_API_KEY"

Response

200 OK
{
  "id": "dr_0198f80c-8d2f-7dc1-a369-90556a64f700",
  "deposit_url": "https://payday.sh/pay/dr_0198f80c-8d2f-7dc1-a369-90556a64f700",
  "status": "settled",
  "chain": { "id": "143", "name": "Monad" },
  "token": { "symbol": "USDC", "address": "0x754704Bc059F8C67012fEd69BC8A327a5aafb603", "decimals": 6 },
  "currency": "USDC",
  "address": "0x2222222222222222222222222222222222222222",
  "address_explorer_url": null,
  "payout_address": "0x1111111111111111111111111111111111111111",
  "payer_wallet": "0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed",
  "recovery_address": "0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed",
  "wallet_bound_at": "2026-09-06T12:05:40Z",
  "amount": "10.500000",
  "amount_base_units": "10500000",
  "received": "10.500000",
  "received_base_units": "10500000",
  "remaining": "0.000000",
  "remaining_base_units": "0",
  "fee_amount": "0.000000",
  "fee_amount_base_units": "0",
  "net_amount": "10.500000",
  "net_amount_base_units": "10500000",
  "issuer": { "name": "Acme LLC", "email": "billing@acme.example" },
  "payer": { "name": "Customer Inc", "email": "ap@customer.example" },
  "heading": "March retainer",
  "reference": "INV-1042",
  "notes": "Net 30. Thank you.",
  "metadata": { "po": "PO-77" },
  "customer_id": "cus_0198f80c-1111-7dc1-a369-90556a64f700",
  "issuer_id": "iss_0198f80c-2222-7dc1-a369-90556a64f700",
  "payer_policy": { "mode": "verified_email", "expected_email": "ap@customer.example" },
  "attachment": null,
  "verification_completed_at": null,
  "likely_unsolicited_at": null,
  "created_at": "2026-09-06T12:00:00Z",
  "updated_at": "2026-09-06T12:00:00Z",
  "expires_at": "2026-09-06T13:00:00Z",
  "deposited_at": null,
  "deposited_at_block": null,
  "settled_at": "2026-09-06T12:20:00Z",
  "settled_block": null,
  "expired_at": null,
  "cancellation_requested_at": null,
  "settlement_tx_hash": "0x…",
  "settlement_explorer_url": null,
  "attention": null,
  "transfers": [],
  "as_of": { "block": "98765000", "at": "2026-09-06T11:59:58Z" },
  "indexer_freshness": {
    "last_indexed_block": "98765000",
    "last_finalized_block": "98765000",
    "cursor_updated_at": "2026-09-06T11:59:59Z"
  },
  "self_settlement": null,
  "attribution": { "version": 2, "hash": "0x…" }
}

Path parameters

iddr_ id | addressrequired
Complete canonical id, or the one-time address.

Query parameters

wait_for"change"
Long-poll. Returns when updated_at changes or timeout elapses.
timeoutinteger
1–30 seconds. Default 30. Requires wait_for.

Response

DepositRequest.

Status codes

  • 200
  • 400invalid_request Partial id.
  • 404deposit_request_not_found Unknown, or not owned by the account.