Payer routes

Get the payer view

GET/v1/payer/deposit-requests/{id}

Retrieves the payer projection of a deposit request.

Unauthenticated · Payday-Payer-Session unlocks gated content.

Request

Shell
curl -fsS "$API/v1/payer/deposit-requests/dr_0198f80c-8d2f-7dc1-a369-90556a64f700" \
  -H "Payday-Payer-Session: $PAYER_SESSION"

Response

200 OK — unlocked, bound
{
  "id": "dr_0198f80c-8d2f-7dc1-a369-90556a64f700",
  "issuer_name": "Acme LLC",
  "heading": "March retainer",
  "payer_policy": { "mode": "verified_email", "expected_email_hint": "a****@c***.example" },
  "requirements": { "email": "approved", "wallet": "approved", "merchant_session": "not_required", "complete": true },
  "status": "awaiting_deposit",
  "payable": true,
  "expires_at": "2026-09-06T13:00:00Z",
  "server_timestamp": "1757160400",
  "settlement_tx_hash": null,
  "settlement_explorer_url": null,
  "payer_message": null,
  "content_unlocked": true,
  "chain": { "id": "143", "name": "Monad" },
  "token": { "symbol": "USDC", "address": "0x754704Bc059F8C67012fEd69BC8A327a5aafb603", "decimals": 6 },
  "amount": "10.500000",
  "amount_base_units": "10500000",
  "received": "0.000000",
  "received_base_units": "0",
  "remaining": "10.500000",
  "remaining_base_units": "10500000",
  "payer_wallet": "0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed",
  "address": "0x2222222222222222222222222222222222222222",
  "address_explorer_url": "https://monadvision.com/address/0x2222222222222222222222222222222222222222",
  "deposit_uri": "ethereum:0x754704Bc059F8C67012fEd69BC8A327a5aafb603@143/transfer?address=0x2222222222222222222222222222222222222222&uint256=10500000",
  "details": {
    "amount": "10.500000",
    "amount_base_units": "10500000",
    "payer": { "name": "Customer Inc" },
    "notes": "Net 30. Thank you.",
    "reference": "INV-1042",
    "attachment": null
  }
}

Gated modes: chain, token, amounts, details, and settlement_tx_hash are null until the session satisfies the policy. Permissionless: present immediately. payer_wallet, address, address_explorer_url, and deposit_uri are null until a wallet is bound; deposit_uri returns to null when payable is false.

With a session, requirements reflects that session. Without one, it reflects the request as a whole and unlocks nothing. No merchant data is present: no payout or recovery address, metadata, customer, or policy assertion.

Headers

Payday-Payer-Sessionstring
Payer session token.

Path parameters

iddr_ idrequired

Response

issuer_name, headingstring
Always present.
payer_policyobject
{ mode, expected_email_hint }. Hint is null under merchant_session.
requirementsobject
{ email, wallet, merchant_session, complete }.
status, payable, expires_at
payable false: stop presenting the address.
server_timestampstring
Unix seconds. Authoritative clock for the deadline.
content_unlockedboolean
chain, token, amount, received, remaining| null
Gated. Base-unit counterparts included.
payer_wallet, address, address_explorer_url, deposit_uristring | null
Present once bound. deposit_uri is EIP-681 for remaining.
detailsobject | null
{ amount, amount_base_units, payer, notes, reference, attachment }. Gated.
payer_messagestring | null
Present under needs_attention.

Status codes

  • 401invalid_deposit_link Unknown id.