satim-module - v1.0.0
    Preparing search index...

    Interface ConfirmOrderResponse

    Response from /confirmOrder.do, /getOrderStatus.do, /refund.do, and /reverse.do.

    OrderStatus follows the SATIM/BPC state machine:

    Value Meaning
    "0" Registered, not paid (pending).
    "1" Pre-authorized (funds held, awaiting capture).
    "2" Deposited (success).
    "3" Reversed (authorization voided).
    "4" Refunded.

    Failed-payment responses (decline, cancel, expire) typically omit OrderStatus and carry diagnostic information in actionCode, params.respCode, and ErrorMessage.

    Amount and depositAmount are minor-unit integers (centimes). Cardholder PII (Ip, Pan, cardholderName, expiration) is redacted by ConfirmResponse.getRawResponse() and accessible only via the typed accessor methods.

    interface ConfirmOrderResponse {
        OrderStatus?: string;
        actionCode?: string;
        actionCodeDescription?: string;
        ErrorCode?: string;
        ErrorMessage?: string;
        amount?: string | number;
        Amount?: string | number;
        orderNumber?: string;
        OrderNumber?: string;
        params?: { respCode?: string; respCode_desc?: string };
        Ip?: string;
        cardholderName?: string;
        expiration?: string;
        Pan?: string;
        approvalCode?: string;
        depositAmount?: string | number;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index

    Properties

    OrderStatus? actionCode? actionCodeDescription? ErrorCode? ErrorMessage? amount? Amount? orderNumber? OrderNumber? params? Ip? cardholderName? expiration? Pan? approvalCode? depositAmount?

    Properties

    OrderStatus?: string
    actionCode?: string
    actionCodeDescription?: string
    ErrorCode?: string
    ErrorMessage?: string
    amount?: string | number
    Amount?: string | number
    orderNumber?: string
    OrderNumber?: string
    params?: { respCode?: string; respCode_desc?: string }
    Ip?: string
    cardholderName?: string
    expiration?: string
    Pan?: string
    approvalCode?: string
    depositAmount?: string | number

    Settings

    Member Visibility

    On This Page

    Properties