org.hypercerts.funding.receipt

hypercerts.org

Documentation

Records a funding receipt for a payment from one user to another user. It may be recorded by the recipient, by the sender, or by a third party. The sender may remain anonymous.

main record

Records a funding receipt for a payment from one user to another user. It may be recorded by the recipient, by the sender, or by a third party. The sender may remain anonymous.

Record Key tid Timestamp-based ID

Properties

amount string Required

Amount of funding received.

createdAt string datetime Required

Client-declared timestamp when this receipt record was created.

currency string Required

Currency of the payment (e.g. EUR, USD, ETH).

for string at-uri Optional

Optional reference to the activity, project, or organization this funding relates to.

from ref app.certified.defs#did Required

DID of the sender who transferred the funds. Leave empty if sender wants to stay anonymous.

notes string Optional

Optional notes or additional context for this funding receipt.

maxLength: 500 bytes
occurredAt string datetime Optional

Timestamp when the payment occurred.

paymentNetwork string Optional

Optional network within the payment rail (e.g. arbitrum, ethereum, sepa, visa, paypal).

paymentRail string Optional

How the funds were transferred (e.g. bank_transfer, credit_card, onchain, cash, check, payment_processor).

to string Required

The recipient of the funds. Can be identified by DID or a clear-text name.

transactionId string Optional

Identifier of the underlying payment transaction (e.g. bank reference, onchain transaction hash, or processor-specific ID). Use paymentNetwork to specify the network where applicable.

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "from",
      "to",
      "amount",
      "currency",
      "createdAt"
    ],
    "properties": {
      "to": {
        "type": "string",
        "description": "The recipient of the funds. Can be identified by DID or a clear-text name."
      },
      "for": {
        "type": "string",
        "format": "at-uri",
        "description": "Optional reference to the activity, project, or organization this funding relates to."
      },
      "from": {
        "ref": "app.certified.defs#did",
        "type": "ref",
        "description": "DID of the sender who transferred the funds. Leave empty if sender wants to stay anonymous."
      },
      "notes": {
        "type": "string",
        "maxLength": 500,
        "description": "Optional notes or additional context for this funding receipt."
      },
      "amount": {
        "type": "string",
        "description": "Amount of funding received."
      },
      "currency": {
        "type": "string",
        "description": "Currency of the payment (e.g. EUR, USD, ETH)."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Client-declared timestamp when this receipt record was created."
      },
      "occurredAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp when the payment occurred."
      },
      "paymentRail": {
        "type": "string",
        "description": "How the funds were transferred (e.g. bank_transfer, credit_card, onchain, cash, check, payment_processor)."
      },
      "transactionId": {
        "type": "string",
        "description": "Identifier of the underlying payment transaction (e.g. bank reference, onchain transaction hash, or processor-specific ID). Use paymentNetwork to specify the network where applicable."
      },
      "paymentNetwork": {
        "type": "string",
        "description": "Optional network within the payment rail (e.g. arbitrum, ethereum, sepa, visa, paypal)."
      }
    }
  },
  "description": "Records a funding receipt for a payment from one user to another user. It may be recorded by the recipient, by the sender, or by a third party. The sender may remain anonymous."
}

Lexicon Garden

@