Struct stripe::ApiErrors

pub struct ApiErrors {
    pub charge: Option<String>,
    pub code: Option<String>,
    pub decline_code: Option<String>,
    pub doc_url: Option<String>,
    pub message: Option<String>,
    pub param: Option<String>,
    pub payment_intent: Option<PaymentIntent>,
    pub payment_method: Option<PaymentMethod>,
    pub payment_method_type: Option<String>,
    pub setup_intent: Option<SetupIntent>,
    pub source: Option<ApiErrorsSourceUnion>,
    pub type_: ApiErrorsType,
}

The resource representing a Stripe “APIErrors”.

Fields

charge: Option<String>

For card errors, the ID of the failed charge.

code: Option<String>

For some errors that could be handled programmatically, a short string indicating the error code reported.

decline_code: Option<String>

For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one.

doc_url: Option<String>

A URL to more information about the error code reported.

message: Option<String>

A human-readable message providing more details about the error.

For card errors, these messages can be shown to your users.

param: Option<String>

If the error is parameter-specific, the parameter related to the error.

For example, you can use this to display a message near the correct form field.

payment_intent: Option<PaymentIntent>

payment_method: Option<PaymentMethod>

payment_method_type: Option<String>

If the error is specific to the type of payment method, the payment method type that had a problem.

This field is only populated for invoice-related errors.

setup_intent: Option<SetupIntent>

source: Option<ApiErrorsSourceUnion>

The source object for errors returned on a request involving a source.

type_: ApiErrorsType

The type of error returned.

One of api_error, card_error, idempotency_error, or invalid_request_error.

Trait Implementations

impl Clone for ApiErrors

fn clone(&self) -> ApiErrors

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiErrors

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ApiErrors

fn default() -> ApiErrors

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ApiErrors

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiErrors

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.