mindee/src/parsing/standard/paymentDetails.d.ts

Mindee Client Library for Node.js

import { StringDict } from "../common";
import { Field } from "./field";
/**
 * @property {StringDict} constructor.prediction - Prediction object from HTTP response
 * @property {string} constructor.valueKey - Key to use in the prediction dict to get the iban.
 * @property {string} constructor.accountNumberKey - Key to use to get the account number in the prediction dict.
 * @property {string} constructor.ibanKey - Key to use to get the IBAN in the prediction dict.
 * @property {string} constructor.routingNumberKey - Key to use to get the routing number in the prediction dict.
 * @property {string} constructor.swiftKey - Key to use to get the SWIFT in the prediction dict.
 * @property {boolean} constructor.reconstructed - Is the object reconstructed (not extracted by the API).
 * @property {number} constructor.pageId - Page ID for multi-page document.
 */
interface PaymentDetailsConstructor {
    prediction: StringDict;
    valueKey?: string;
    accountNumberKey?: string;
    ibanKey?: string;
    routingNumberKey?: string;
    swiftKey?: string;
    reconstructed?: boolean;
    pageId?: number;
}
/**
 * Information on a single payment.
 */
export declare class PaymentDetailsField extends Field {
    #private;
    /** Synonym for the `iban` property */
    value?: string | undefined;
    /** The account number. */
    accountNumber: string | undefined;
    /** The International Bank Account Number (IBAN). */
    iban: string | undefined;
    /** The routing number. */
    routingNumber: string | undefined;
    /** The bank's SWIFT Business Identifier Code (BIC). */
    swift: string | undefined;
    /**
     * @param {PaymentDetailsConstructor} constructor Constructor parameters.
     */
    constructor({ prediction, valueKey, accountNumberKey, ibanKey, routingNumberKey, swiftKey, reconstructed, pageId, }: PaymentDetailsConstructor);
    /**
     * Default string representation.
     */
    toString(): string;
}
export {};