Skip to main content

Activity

Immutable event log entry. Some account events yield an activity object.
Attributes
idstringrequired

The activity's unique identifier

currencystringrequired

Account currency code.

All activity rows amount are relative to the account's currency.

sourceenumrequired

The source event that has yielded the activity.

  • admin_credit The account has been credited by Lune.
  • admin_debit The account has been debited by Lune.
  • order_received The account has placed an order and Lune has received it.
  • order_placed An order has been matched to bundles. Quantites and costs are known and have been set.
  • order_paid The order has been paid for.
  • order_retiring Lune has started retiring the order's carbon offsets.
  • order_cancelled The order has been cancelled
  • order_allocation_retired Carbon credits linked to a specific project have been retired
  • order_complete All carbon credits linked to the order have been retired
  • order_failed Order failed to process.
Enum:
  • admin_credit
  • admin_debit
  • order_received
  • order_placed
  • order_paid
  • order_retiring
  • order_cancelled
  • order_allocation_retired
  • order_complete
  • order_failed
balancestring^-?[0-9]+(\.[0-9]+)?$required

Account's cash balance at the time of this activity

Unit: Account currency

balance_deltastring^-?[0-9]+(\.[0-9]+)?$required

Account's cash balance delta.

The previous balance plus balance_delta equals the current balance.

Unit: Account currency

balance_outstandingstring^-?[0-9]+(\.[0-9]+)?$required

The Account's outstanding balance at the time of this activity

Unit: Account currency

balance_outstanding_deltastring^-?[0-9]+(\.[0-9]+)?$required

Account's outstanding balance delta.

The previous outstanding balance plus balance_outstanding_delta equals the current outstanding balance.

Unit: Account currency

quantitystring^[0-9]+(\.[0-9]+)?$

Quantity of CO2 offsets linked to this activity (tonnes CO2)

order_idstring

The order's unique identifier

project_idstring

The project's unique identifier

project_namestring

The project's name

created_atstringdate-timerequired

Activity creation timestamp

  • Endpoints
    • GET
     /activity
  • Activity
    • {
  "id": "gh2VDRT4JZqnzPkYxJgALg0GeQDoXlWO3",
  "currency": "GBP",
  "source": "order_complete",
  "balance": "23.50",
  "balance_delta": "-3.50",
  "balance_outstanding": "-132.50",
  "balance_outstanding_delta": "3.50",
  "quantity": "500.50",
  "order_id": "xe1BEV2VZqnzPkYxJgALg0GeQDoXlWO3",
  "project_id": "BmWxrvXo29eGqzA1qjANL5PwnkgaO8R3",
  "project_name": "Alto Mayo",
  "created_at": "created_at"
}