Payload

The webhook payload for requests

All webhook events will have the following payload structure:

type WebhookPayload {
    eventType: WebhookEventType;
    requestId: string;
    request: {
        senderWallet: `0x${string}` | "";
        receiverWallet: `0x${string}` | "";
        chain: string; // name of the chain to be used
        amount: string; // it's a number of the amount in USD
        hash_url: `0x${string}` | "";
        invoice_number: string; // Your generatedId for this request
        merchant_name: string; // This would be your own name
        token: `0x${string}` | ""; // Token address used to pay. In case of native tokens, this will be zeroAddress
        token_amount: string; // Amount in tokens, already formatted
        additionalData?: {
            recipientEmail?: string; // if the recipient sets an email address, we will send this field to you.
        };
    };
}

We can only safely assure that the recipientEmail field exists only on the REQUEST_CLIENT_EMAIL_SET event.