Deposit requests

Create a preview session

POST/v1/deposit-requests/{id}/preview-session

Mints a payer session that opens the request's payer view unlocked, for the issuing account.

API key · or dashboard session.

Request

Shell
curl -fsS -X POST "$API/v1/deposit-requests/dr_0198f80c-…/preview-session" \
  -H "Authorization: Bearer $PAYDAY_API_KEY"

Response

200 OK
{
  "payer_session": "…",
  "expires_at": "2026-09-07T12:00:00Z"
}

Not verification: records no attempt and never sets verification_completed_at. Any policy mode. Transport: URL fragment, deposit_url#ps=<session>.

Path parameters

iddr_ idrequired

Response

payer_sessionstring
expires_attimestamp

Status codes

  • 410deposit_request_not_payable Closed without verification.