wallee/dist/models/PaymentAppProcessor.d.ts

TypeScript/JavaScript client for wallee

import type { PaymentAppProcessorState } from './PaymentAppProcessorState';
import type { PaymentProcessorConfiguration } from './PaymentProcessorConfiguration';
import type { ChargeAttemptEnvironment } from './ChargeAttemptEnvironment';
/**
 *
 * @export
 * @interface PaymentAppProcessor
 */
export interface PaymentAppProcessor {
    /**
     * A URL pointing to the documentation that explains how to configure and use the processor.
     * @type {string}
     * @memberof PaymentAppProcessor
     */
    readonly documentationUrl?: string;
    /**
     *
     * @type {ChargeAttemptEnvironment}
     * @memberof PaymentAppProcessor
     */
    configuredEnvironment?: ChargeAttemptEnvironment;
    /**
     * A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
     * @type {string}
     * @memberof PaymentAppProcessor
     */
    readonly externalId?: string;
    /**
     * An SVG icon representing the processor, displayed to the user in the interface.
     * @type {string}
     * @memberof PaymentAppProcessor
     */
    readonly svgIcon?: string;
    /**
     * The date and time when the processor was last updated.
     * @type {Date}
     * @memberof PaymentAppProcessor
     */
    readonly updatedOn?: Date;
    /**
     * Whether the processor is fully prepared and available for handling transactions in a production environment.
     * @type {boolean}
     * @memberof PaymentAppProcessor
     */
    readonly usableInProduction?: boolean;
    /**
     * The date and time when the processor was created.
     * @type {Date}
     * @memberof PaymentAppProcessor
     */
    readonly createdOn?: Date;
    /**
     * The version is used for optimistic locking and incremented whenever the object is updated.
     * @type {number}
     * @memberof PaymentAppProcessor
     */
    readonly version?: number;
    /**
     *
     * @type {PaymentProcessorConfiguration}
     * @memberof PaymentAppProcessor
     */
    processorConfiguration?: PaymentProcessorConfiguration;
    /**
     * The ID of the space this object belongs to.
     * @type {number}
     * @memberof PaymentAppProcessor
     */
    readonly linkedSpaceId?: number;
    /**
     * the date and time when the processor became fully usable and available for handling transactions in a production environment.
     * @type {Date}
     * @memberof PaymentAppProcessor
     */
    readonly usableInProductionSince?: Date;
    /**
     * The name used to identify the processor.
     * @type {string}
     * @memberof PaymentAppProcessor
     */
    readonly name?: string;
    /**
     * A unique identifier for the object.
     * @type {number}
     * @memberof PaymentAppProcessor
     */
    readonly id?: number;
    /**
     * The installation ID identifies the Web App installation.
     * @type {number}
     * @memberof PaymentAppProcessor
     */
    readonly installationId?: number;
    /**
     * A URL pointing to the site where merchants can set up production mode for the processor.
     * @type {string}
     * @memberof PaymentAppProcessor
     */
    readonly productionModeUrl?: string;
    /**
     *
     * @type {PaymentAppProcessorState}
     * @memberof PaymentAppProcessor
     */
    state?: PaymentAppProcessorState;
}
/**
 * Check if a given object implements the PaymentAppProcessor interface.
 */
export declare function instanceOfPaymentAppProcessor(value: object): value is PaymentAppProcessor;
export declare function PaymentAppProcessorFromJSON(json: any): PaymentAppProcessor;
export declare function PaymentAppProcessorFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentAppProcessor;
export declare function PaymentAppProcessorToJSON(json: any): PaymentAppProcessor;
export declare function PaymentAppProcessorToJSONTyped(value?: Omit<PaymentAppProcessor, 'documentationUrl' | 'externalId' | 'svgIcon' | 'updatedOn' | 'usableInProduction' | 'createdOn' | 'version' | 'linkedSpaceId' | 'usableInProductionSince' | 'name' | 'id' | 'installationId' | 'productionModeUrl'> | null, ignoreDiscriminator?: boolean): any;