Deposit requests

List deposit requests

GET/v1/deposit-requests

Lists deposit requests, newest first, as summaries.

API key · or dashboard session.

Request

Shell
curl -fsS "$API/v1/deposit-requests?status=partially_deposited&limit=20" \
  -H "Authorization: Bearer $PAYDAY_API_KEY"

Response

200 OK
{
  "deposit_requests": [
    {
      "id": "dr_0198f80c-8d2f-7dc1-a369-90556a64f700",
      "deposit_url": "https://payday.sh/pay/dr_0198f80c-8d2f-7dc1-a369-90556a64f700",
      "heading": "March retainer",
      "payer_name": "Customer Inc",
      "reference": "INV-1042",
      "metadata": { "po": "PO-77" },
      "payer_policy_mode": "verified_email",
      "customer_id": "cus_0198f80c-1111-7dc1-a369-90556a64f700",
      "issuer_id": "iss_0198f80c-2222-7dc1-a369-90556a64f700",
      "has_attachment": false,
      "verification_completed_at": null,
      "likely_unsolicited_at": null,
      "status": "partially_deposited",
      "amount": "10.500000",
      "received": "4.000000",
      "cancellation_requested_at": null,
      "created_at": "2026-09-06T12:00:00Z",
      "updated_at": "2026-09-06T12:10:00Z",
      "expires_at": "2026-09-06T13:00:00Z"
    }
  ],
  "next_cursor": null
}

Query parameters

statusenum
One public status.
referencestring
Exact match.
customer_idcus_ id
issuer_idiss_ id
verificationenum
not_required · pending · verified · likely_unsolicited. Independent of status.
limitinteger
1–100. Default 20.
starting_afterdr_ id
Cursor from next_cursor.

Response

{ deposit_requests: DepositRequestSummary[], next_cursor: dr_ id | null }. Summary fields: id, deposit_url, heading, payer_name, reference, metadata, payer_policy_mode, customer_id, issuer_id, has_attachment, verification_completed_at, likely_unsolicited_at, status, amount, received, cancellation_requested_at, created_at, updated_at, expires_at.