CreditIssued

CreditIssued fires after Siren writes a ledger entry that adds store credit to a collaborator’s balance. Three things write one: a payout paid as store credit, a refunded or cancelled order that gives back the credit it spent, and an Admin raising a balance by hand.

The event is identified as credit_issued and lives in Siren\Credits\Core\Events\CreditIssued.

What does this event carry?

The event carries the CreditEntry Siren wrote, so a listener can describe the change without reading the ledger again. getEntry() returns it.

• getCollaboratorId() says whose balance changed.
• getCurrency() is the custom currency’s code, such as STORE_CREDIT.
• getAmount() is a positive whole number at the currency’s scale. Store credit has a scale of 0 by default, so 500 is 500 units of credit. Currencies explains the scale.
• getSourceType() says why: fulfillment for a payout, refund for an order that gave credit back, and adjustment for an Admin’s change.
• getSourceId() is the payout’s ID for fulfillment, the ID of the debit being given back for refund, and null for adjustment.
• getDescription() is the text the ledger shows, such as Payout #42.
• getId() and getCreatedDate() identify and date the entry.

use Siren\Credits\Core\Events\CreditIssued;

public function handle(Event $event): void
{
    $entry = $event->getEntry();
    $collaboratorId = $entry->getCollaboratorId();
    $currency = $entry->getCurrency();
    $amount = $entry->getAmount();
    $reason = $entry->getSourceType();
}

When would you use it?

Use it to tell a collaborator they received credit, or to copy their balance into another system, such as a loyalty program. Check getSourceType() when only one kind of change matters. For example, react to fulfillment alone to hear about credit a collaborator earned, and skip refunds and adjustments. On Siren Cloud, this event sends the credit.issued webhook.

On a WordPress site connected to Siren Cloud, each credit.issued delivery from Siren Cloud arrives on the site as CreditIssued.

CreditRedeemed is the other direction. See the Store Credit Events overview for how the ledger events fit together.