TypeScript SDK

BuyWithFiatStatus

The returned object from getBuyWithFiatStatus function

If the in invalid intentId is provided, the object will have a status of "NOT_FOUND" and no other fields.


type BuyWithFiatStatus =
  | { status: "NOT_FOUND" }
  | {
      destination?: PayOnChainTransactionDetails;
      failureMessage?: string;
      fromAddress: string;
      intentId: string;
      purchaseData?: PurchaseData;
      quote: {
        createdAt: string;
        estimatedDurationSeconds?: number;
        estimatedOnRampAmount: string;
        estimatedOnRampAmountWei: string;
        estimatedToTokenAmount: string;
        estimatedToTokenAmountWei: string;
        fromCurrency: {
          amount: string;
          amountUnits: string;
          currencySymbol: string;
          decimals: number;
        };
        fromCurrencyWithFees: {
          amount: string;
          amountUnits: string;
          currencySymbol: string;
          decimals: number;
        };
        onRampToken: PayTokenInfo;
        toToken: PayTokenInfo;
      };
      source?: PayOnChainTransactionDetails;
      status:
        | "NONE"
        | "PENDING_PAYMENT"
        | "PAYMENT_FAILED"
        | "ON_RAMP_TRANSFER_COMPLETED";
      toAddress: string;
    };