CustomCurrencyCreated

CustomCurrencyCreated fires when a custom currency is created. An Admin creates one from the dashboard or the Currencies API, and applying a recipe that brings its own currency creates one too. Every new custom currency is a store credit currency, held in Siren’s ledger.

The event is identified as custom_currency_created and lives in Siren\Configs\Core\Events\CustomCurrencyCreated.

What does this event carry?

The event carries the CustomCurrency as it was saved. getCurrency() returns it.

• getId() is the currency’s code, such as STORE_CREDIT.
• getName() is its display name, such as Store Credit.
• getSymbol() and getSymbolPosition() say how amounts are shown. The position is before or after.
• getType() is internal for a new currency, and isInternal() answers true.
• getExchangeRate() is how many units of the currency are worth one unit of the store’s money. At 1, one credit is worth $1. At 100, 100 credits are worth $1.
• getScale() is how many digits of a stored amount sit after the decimal point. It’s 0 for store credit unless the currency sets one.

use Siren\Configs\Core\Events\CustomCurrencyCreated;

public function handle(Event $event): void
{
    $currency = $event->getCurrency();
    $code = $currency->getId();
    $name = $currency->getName();
    $rate = $currency->getExchangeRate();
}

How does Siren react?

Siren’s own listeners set the currency up for store credit. Where the site has a checkout that can spend credit, Siren pays the currency’s payouts as store credit automatically. It also creates the currency’s credit coupon in every store whose integration registered a credit coupon strategy.

When would you use it?

Use it to add the new currency to another system that shows balances, or to set up anything your own integration needs for each currency. On Siren Cloud, this event sends the currency.created webhook.

On a WordPress site connected to Siren Cloud, each currency.created delivery from Siren Cloud arrives on the site as CustomCurrencyCreated.

CustomCurrencyDeleted fires when the currency goes away. See the Store Credit Events overview for the rest of the store credit events.