mangopay2-nodejs-sdk/typings/services/Cards.d.ts

Mangopay Node.js SDK

import { card } from "../models/card";
import { transaction } from "../models/transaction";
import { cardPreAuthorization } from "../models/cardPreauthorization";
import { base } from "../base";
import { cardValidation } from "../models/cardValidation";
import MethodOverload = base.MethodOverload;
import TwoArgsMethodOverload = base.TwoArgsMethodOverload;

export class Cards {
    /**
     * Get card
     * @param cardId
     * @param ptions
     */
    get: MethodOverload<string, card.CardData>;

    /**
     * Gets a list of cards having the same fingerprint.
     * The fingerprint is a hash uniquely generated per 16-digit card number.
     *
     * @param fingerprint The fingerprint hash
     */
    getByFingerprint: MethodOverload<string, card.CardData[]>;

    /**
     * Update card (currently only supports deactivation)
     * @param card
     * @param options
     */
    update: MethodOverload<card.UpdateCard, card.CardData>;

    /**
     * Get list of Transactions of a Card
     * @param cardId
     * @param options
     */
    getTransactions: MethodOverload<string, transaction.TransactionData[]>;

    /**
     * Gets list of PreAuthorizations of a Card.
     * @param cardId
     * @param options
     */
    getPreAuthorizations: MethodOverload<string,
        cardPreAuthorization.CardPreAuthorizationData[]>;

    /**
     * Validate a card
     * @param cardId
     * @param cardValidation
     * @param callback
     * @param options
     * @returns {*|Promise}
     */
    validate: TwoArgsMethodOverload<
        string,
        cardValidation.CreateCardValidation,
        cardValidation.CardValidationData
    >;

    /**
     * Validate a card
     * @param cardId
     * @param cardValidationId
     * @param callback
     * @param options
     * @returns {*|Promise}
     */
    getCardValidation: TwoArgsMethodOverload<
        string,
        string,
        cardValidation.CardValidationData
    >;

    /**
     * Get a list of Transactions for a fingerprint
     * @param fingerprint
     */
    getTransactionsForFingerprint: MethodOverload<string, transaction.TransactionData[]>;
}