Checkout Webhooks

Checkout Status Updated

Body (payload) of the POST request:

{
    type: "CHECKOUT_STATUS_UPDATED";
    data: {
        checkoutData: {
            checkoutId: string;
            quantity: number;
            price: number;
            customParams?: object;
        };
        status: CheckoutStatus;
        paymentData?: {
            status: string;
            amount: number;
            created: number;
            currency: string;
            livemode: boolean;
            metadata?: {
                chain_id?: string;
                request_id?: string;
                transaction_hash?: string;
            };
            paymentMehod?: {
                billingDetails?: object;
                card?: object;
                ...
            };
        };
    };
}

Example

{
  "type": "CHECKOUT_STATUS_UPDATED",
  "data": {
    "checkoutData": {
      "checkoutId": "aa96176f-1136-4716-9213-8f5ec43ffa81",
      "quantity": 10,
      "price": 1,
      "customParams": {
        ...
      }
    },
    "status": "DONE",
    "paymentData": {
      "status": "succeeded",
      "amount": 1055,
      "created": 1738705790,
      "currency": "usd",
      "livemode": true,
      "metadata": {
        "chain_id": "c7e243e4-e6b2-487c-99a1-8d36d49046bc",
        "request_id": "68f83be4-4c93-44c8-925c-1052bd7fbced",
        "transaction_hash": "0xe93cd08ec2778c5490daea7ee59240f4bdbaa883e8024eec3749ecb2cb4d11e9"
      },
      "paymentMethod": {
        "billingDetails": {
          "address": {
            ...
          },
          "email": "[email protected]",
        },
        "card": {
          "brand": "mastercard",
          "checks": {
            "address_line1_check": null,
            "address_postal_code_check": null,
            "cvc_check": "pass"
          },
          "country": "IL",
          "display_brand": "mastercard",
          "exp_month": 10,
          "exp_year": 2030,
          "fingerprint": "...",
          "funding": "credit",
          "generated_from": null,
          "last4": "1234",
          "networks": {
            "available": [
              "mastercard"
            ],
            "preferred": null
          },
          "regulated_status": "unregulated",
          "three_d_secure_usage": {
            "supported": true
          },
          "wallet": null
        },
        "created": 1738705842,
        "type": "card"
      },
      "receiptEmail": "[email protected]"
    }
  }
}

CheckoutStatus

CREATED

indicates that a checkout intent was submitted to Tweed and was created

PERFORM_CHECKOUT_SUBMITTED

indicates that the end user submitted the checkout successfuly

TRANSACTION_BROADCAST

indicates that the transaction was broadcasted to the blockchain

DONE

indicates that the checkout process was successful and the user received the token to it's wallet

FAILED

indicates that the checkout process failed

FAILED_AFTER_TX_COMPLETED

indicates that the checkout process failed after the transaction was already completed on chain