Deposit requests

Create a client secret

POST/v1/deposit-requests/{id}/client-secret

Mints a single-use client secret for a merchant_session request.

API key · or dashboard session.

Request

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

Response

201 Created
{
  "client_secret": "cs_…",
  "expires_at": "2026-09-06T12:15:00Z"
}

Valid fifteen minutes; spent on first exchange. Earlier unspent secrets remain valid. Transport: URL fragment, deposit_url#cs=<secret>. Response is Cache-Control: no-store.

Path parameters

iddr_ idrequired

Response

client_secretstring
Returned once. Stored hashed.
expires_attimestamp

Status codes

  • 201
  • 409verification_not_required Mode is permissionless.
  • 409verification_method_not_applicable Mode is verified_email.
  • 410deposit_request_not_payable Closed without verification. A settled, verified request still mints.