mercadopago/dist/clients/customerCard/index.d.ts

Mercadopago SDK for Node.js

/**
 * CustomerCard API client for the MercadoPago Node.js SDK.
 *
 * Provides a high-level facade for managing the saved payment cards
 * associated with a customer through the
 * `/v1/customers/:customer_id/cards` resource.
 *
 * @see {@link https://www.mercadopago.com/developers/en/reference/online-payments/checkout-api/cards/save-card/post MercadoPago Customer Cards API reference}
 * @module clients/customerCard
 */
import type { CustomerCardCreateData } from './create/types';
import type { MercadoPagoConfig } from '../../mercadoPagoConfig';
import type { CustomerCardUpdateData } from './update/types';
import type { CustomerCardListData } from './list/types';
import type { CustomerCardResponse, CustomerCardGetRemoveData } from './commonTypes';
/**
 * Client for the MercadoPago Customer Cards API.
 *
 * Exposes CRUD and list operations on the saved payment cards that
 * belong to a specific customer.
 *
 * @see {@link https://www.mercadopago.com/developers/en/reference/online-payments/checkout-api/cards/save-card/post API reference}
 */
export declare class CustomerCard {
    private config;
    constructor(mercadoPagoConfig: MercadoPagoConfig);
    /**
     * Save a new payment card for a customer using a card token.
     *
     * @see {@link https://github.com/mercadopago/sdk-nodejs/blob/master/src/examples/customer/create.ts Usage Example  }.
     */
    create({ customerId, body, requestOptions }: CustomerCardCreateData): Promise<CustomerCardResponse>;
    /**
     * Retrieve a specific saved card for a customer.
     *
     * @see {@link https://github.com/mercadopago/sdk-nodejs/blob/master/src/examples/customer/get.ts Usage Example  }.
    */
    get({ customerId, cardId, requestOptions }: CustomerCardGetRemoveData): Promise<CustomerCardResponse>;
    /**
     * Remove a saved card from a customer's wallet.
     *
     * @see {@link https://github.com/mercadopago/sdk-nodejs/blob/master/src/examples/customer/remove.ts Usage Example  }.
     */
    remove({ customerId, cardId, requestOptions }: CustomerCardGetRemoveData): Promise<CustomerCardResponse>;
    /**
     * Update the details of an existing saved card (e.g. expiration date or cardholder info).
     *
     * @see {@link https://github.com/mercadopago/sdk-nodejs/blob/master/src/examples/customer/update.ts Usage Example  }.
     */
    update({ customerId, cardId, body, requestOptions }: CustomerCardUpdateData): Promise<CustomerCardResponse>;
    /**
     * List all saved payment cards for a customer.
     *
     * @see {@link https://github.com/mercadopago/sdk-nodejs/blob/master/src/examples/customer/list.ts Usage Example  }.
     */
    list({ customerId, requestOptions }: CustomerCardListData): Promise<CustomerCardResponse[]>;
}