Type Alias CollectPaymentMethodResult

CollectPaymentMethodResult:
    | {
        displayData: PaymentMethodDisplayData;
        kycInfo?: KycInfo;
        error?: undefined;
    }
    | {
        displayData?: undefined;
        kycInfo?: undefined;
        error: StripeError<OnrampError>;
    }

Result of collecting or selecting a payment method to use for checkout.

Type declaration

  • { displayData: PaymentMethodDisplayData; kycInfo?: KycInfo; error?: undefined }
    • displayData: PaymentMethodDisplayData

      Display data for the selected payment method.

    • OptionalkycInfo?: KycInfo

      Partial KYC data returned from Platform Pay billing details, when requested.

    • Optionalerror?: undefined
  • {
        displayData?: undefined;
        kycInfo?: undefined;
        error: StripeError<OnrampError>;
    }
    • OptionaldisplayData?: undefined
    • OptionalkycInfo?: undefined
    • error: StripeError<OnrampError>

      Present if collection/selection failed with an error.

Settings

Member Visibility