API documentation

export interface HtmlEmbeddedImage {
  image: string;
  // The raw URL the QR encodes. On the invite endpoint
  // (qrGetInviteEmbeddedHtmlImage) this is the /register?QRShared=... link
  // that resolves the partner's AffiliatedUserId server-side. On the
  // internal-transfer endpoint (qrGetInternalTransferEmbeddedHtmlImage)
  // this is the /v2/main/wallets/internal-transfer?internal-transfer-recipient-name=
  // link that prefills the transfer form. The customer UI uses this to
  // build a native-share text payload (via Web Share API or the mobile
  // wrapper) without making a second round-trip. Optional for backwards
  // compatibility — older server builds may not yet populate it.
  url?: string;
  // Legacy field name from the first iteration of the invite endpoint.
  // Carried as an optional alias so a frontend bundle deployed slightly
  // ahead of the backend rebuild still resolves a usable URL via
  // `data.url ?? data.inviteUrl`. Safe to remove once every server
  // returns `url` (which happens automatically once they redeploy with
  // the unified QRCodeController response shape).
  inviteUrl?: string;
  /** Unauthenticated PNG URL (`/public/files/{id}`) for native share wrappers. */
  imagePublicUrl?: string;
}