BillingTransferResult billing.transfer-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/transfer-result.v1.json

billing.transfer-result@1: answers of billing.transfer.create on OpenVibe.Billing (201). POST /api/v1/transfers → { transaction, balance: { credit } } (the sender's credit after it); POST /api/v1/transfers/:id/refund → { transaction } (type refund, reverses_txn the donation).

Fields

FieldTypeRequiredDescriptionConstraints
transactionbilling.transactionyes
balanceobject
balance.creditintegeryes

Examples

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

Valid: transfer
{
  "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": {
    "credit": 700
  }
}
Rejected: no-transaction
{
  "balance": {
    "credit": 700
  }
}

Validate

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