Mayson Monorepo Documentation
    Preparing search index...

    Interface Outcome

    interface Outcome {
        advice_code: AdviceCode;
        network_advice_code: string;
        network_decline_code: string;
        network_status: string;
        reason: string;
        risk_level?: string;
        risk_score?: number;
        rule?: string | Rule;
        seller_message: string;
        type: string;
    }
    Index

    Properties

    advice_code network_advice_code network_decline_code network_status reason risk_level? risk_score? rule? seller_message type

    Properties

    advice_code: AdviceCode

    An enumerated value providing a more detailed explanation on how to proceed with an error.

    network_advice_code: string

    For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.

    network_decline_code: string

    For charges declined by the network, an alphanumeric code which indicates the reason the charge failed.

    network_status: string

    Possible values are approved_by_network, declined_by_network, not_sent_to_network, and reversed_after_approval. The value reversed_after_approval indicates the payment was blocked by Stripe after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.

    reason: string

    An enumerated value providing a more detailed explanation of the outcome's type. Charges blocked by Radar's default block rule have the value highest_risk_level. Charges placed in review by Radar's default review rule have the value elevated_risk_level. Charges blocked because the payment is unlikely to be authorized have the value low_probability_of_authorization. Charges authorized, blocked, or placed in review by custom rules have the value rule. See understanding declines for more details.

    risk_level?: string

    Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are normal, elevated, highest. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value not_assessed. In the event of an error in the evaluation, this field will have the value unknown. This field is only available with Radar.

    risk_score?: number

    Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.

    rule?: string | Rule

    The ID of the Radar rule that matched the payment, if applicable.

    seller_message: string

    A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.

    type: string

    Possible values are authorized, manual_review, issuer_declined, blocked, and invalid. See understanding declines and Radar reviews for details.

    Settings

    Member Visibility

    On This Page

    Properties