TipsInteractionFailedPayload tips.interaction.failed@1

Generated at from openvibe-contracts v0.33.0 and openvibe-sdk v0.5.0.

Version
1.0.0
Owner
tips
Visibility
first-party
Status
active
Compatibility
backward
Decision
ADR-012
Schema
https://openvibe.network/contracts/events/payloads/tips.interaction.failed.v1.json

tips.interaction.failed v1 (OpenVibe.Tips server/domain/interactions.js recomputeDelivery). A delivery effect gave up after its retries and none is still queued; the payment state is untouched. Envelope: subject { type: interaction, id: tint_… }, visibility internal, priority important, actor service:tips. Never emitted for tests or imports.

Fields

FieldTypeRequiredDescriptionConstraints
interaction_idstringyes
  • pattern ^tint_[0-9A-HJKMNP-TV-Z]{26}$
creatoridentity.subject-refyes
supporterone ofyesThe supporter, null when external, anonymous or unmapped.
supporter_namestring | nullyesDisplay name at the time.
kindenumyes
  • one of "tip", "paid_message", "tts", "media_request"
amountintegeryesInteger amount in currency minor units (Vibes bits).
  • minimum 1
currencystringyesvibes-bits today.
settlementenumyes
  • one of "billing", "external", "simulated", "imported"
payment_stateenumyes
  • one of "pending", "settled", "reversed", "failed"
delivery_stateenumyes
  • one of "awaiting_payment", "queued", "delivered", "failed", "cancelled"
billing_txn_idstring | nullyesThe Billing transaction (txn_…) that settled it.
testbooleanyesSimulations never emit events, so false in practice.
failed_effectsarray of objectyes
  • minItems 1
  • items: no other fields
failed_effects[].effectenumyes
  • one of "chat_line", "paid_message", "tts", "media_request", "overlay_alert"
failed_effects[].adapterstringyes
failed_effects[].last_errorstring | nullyes

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: chat-line-failed
{
  "interaction_id": "tint_01JAB3C4D5E6F7G8H9J0K1MNPQ",
  "creator": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "supporter": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
  },
  "supporter_name": "Generous Fan",
  "kind": "tip",
  "amount": 500,
  "currency": "vibes-bits",
  "settlement": "billing",
  "payment_state": "settled",
  "delivery_state": "failed",
  "billing_txn_id": "txn_01JAB3C4D5E6F7G8H9J0K1MNPR",
  "test": false,
  "failed_effects": [
    {
      "effect": "chat_line",
      "adapter": "live",
      "last_error": "live 503"
    }
  ]
}
Rejected: no-failed-effects
{
  "interaction_id": "tint_01JAB3C4D5E6F7G8H9J0K1MNPQ",
  "creator": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "supporter": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
  },
  "supporter_name": "Generous Fan",
  "kind": "tip",
  "amount": 500,
  "currency": "vibes-bits",
  "settlement": "billing",
  "payment_state": "settled",
  "delivery_state": "failed",
  "billing_txn_id": "txn_01JAB3C4D5E6F7G8H9J0K1MNPR",
  "test": false
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('tips.interaction.failed@1', value);   // { valid, errors: [{ path, message }] }