BillingCashoutResult billing.cashout-result@1

Generated at from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

Version
1.0.0
Owner
billing
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/billing/cashout-result.v1.json

billing.cashout-result@1: answers about cashouts on OpenVibe.Billing. POST /api/v1/cashouts (201), GET /api/v1/cashouts/:id, POST /api/v1/cashouts/:id/approve and /deny → { cashout }; GET /api/v1/cashouts?status=&subject=&limit= → { cashouts }; POST /api/v1/recycle (201) → { transaction, balance }. A cashout the Events stream carries names the payout method's type only; this API answers the caller who may see the address.

Fields

This schema has no named fields.

Examples

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

Valid: one
{
  "cashout": {
    "id": "co_01JAB2C3D4E5F6G7H8J9K0MNPT",
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
    },
    "amount_bits": 5000,
    "value_cents": 5000,
    "status": "requested",
    "payout_method": {
      "type": "paypal",
      "address": "[email protected]"
    },
    "escrow_until": "2026-10-02T18:00:00.000Z",
    "request_txn": "txn_01JAB2C3D4E5F6G7H8J9K0MNPV",
    "settle_txn": null,
    "payout_provider": null,
    "payout_reference": null,
    "reason": null,
    "created_at": "2026-09-25T18:00:00.000Z",
    "updated_at": "2026-09-25T18:00:00.000Z"
  }
}
Valid: recycled
{
  "transaction": {
    "id": "txn_01JAB2C3D4E5F6G7H8J9K0MNPS",
    "type": "donation",
    "status": "posted",
    "test": false,
    "reverses_txn": null,
    "from_subject": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
    "to_subject": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR",
    "provider": null,
    "receipt_ref": null,
    "actor": {
      "type": "service",
      "id": "live"
    },
    "metadata": {
      "kind": "tip",
      "amount_bits": 500,
      "message": "gg"
    },
    "created_at": "2026-09-25T18:00:00.000Z",
    "entries": [
      {
        "account": {
          "kind": "user_credit",
          "owner": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
          "currency": "vibes-bits"
        },
        "amount": -500
      },
      {
        "account": {
          "kind": "creator_payable",
          "owner": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR",
          "currency": "vibes-bits"
        },
        "amount": 500
      }
    ]
  },
  "balance": {
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
    },
    "currency": "vibes-bits",
    "credit": 1200,
    "payable": 5500,
    "pending_payouts": 0,
    "payable_value_cents": 5500,
    "bits_per_usd": 100
  }
}
Rejected: partial
{
  "cashouts": [
    {
      "id": "co_1"
    }
  ]
}

Validate

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