Webhooks

All current and future implementations of notification messages have the following attributes:

Payload

{
    "eventType":"payout-event",
    "eventName": "payout-completed",
    "data": {...}
}

Field	Data Type	Required	Description
eventType	String	True	Type of event.
eventName	String	True	Name of event.
data	String	True	Event data

Payout Competed

Completed payouts are settled payouts. Therefore, the funds should be available in the destination accounts. Following structure represents the notifications for completed payouts.

{
    "eventType":"payout-event",
    "eventName": "payout-completed",
    "data": {...}
}

Payout Failed

Following structure represents the notifications for failed payouts.

{
    "eventType":"payout-event",
    "eventName": "payout-failed",
    "data": {...}
}

## Payout Returned
Payouts might rarely return from bank after receiving a settlement. In such cases, a notification that looks like the following will be sent.

```markdown
{
    "eventType":"payout-event",
    "eventName": "payout-returned",
    "data": {...}
}

## Mint Completed
Following structure represents the notifications for completed stablecoin minting.

```markdown
{
    "eventType":"mint-event",
    "eventName": "mint-completed",
    "data": {...}
}

## Mint Failed
Following structure represents the notifications for failed stablecoin minting.

```markdown
{
    "eventType":"mint-event",
    "eventName": "mint-failed",
    "data": {...}
}

## Redeem Completed
Following structure represents the notifications when stablecoin is redeemed.

```markdown
{
    "eventType":"redeem-event",
    "eventName": "redeem-completed",
    "data": {...}
}

## Mint Failed
Following structure represents the notifications when redeeming stablecoin fails.

```markdown
{
    "eventType":"redeem-event",
    "eventName": "redeem-failed",
    "data": {...}
}