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

Mercadopago SDK for Node.js

import type { AdvancedPaymentResponse } from './commonTypes';
import type { AdvancedPaymentCreateData } from './create/types';
import type { AdvancedPaymentGetData } from './get/types';
import type { AdvancedPaymentSearchData, AdvancedPaymentSearchResponse } from './search/types';
import type { AdvancedPaymentUpdateData } from './update/types';
import type { AdvancedPaymentCancelData } from './cancel/types';
import type { AdvancedPaymentCaptureData } from './capture/types';
import type { AdvancedPaymentUpdateReleaseDateData } from './updateReleaseDate/types';
import type { MercadoPagoConfig } from '../../mercadoPagoConfig';
/**
 * Client facade for MercadoPago advanced (split) payment operations.
 */
export declare class AdvancedPayment {
    /** SDK configuration providing credentials and HTTP options. */
    private config;
    constructor(mercadoPagoConfig: MercadoPagoConfig);
    /**
     * Create a new advanced (split) payment distributed among multiple sellers.
     */
    create({ body, requestOptions }: AdvancedPaymentCreateData): Promise<AdvancedPaymentResponse>;
    /**
     * Retrieve an advanced payment by its ID.
     */
    get({ id, requestOptions }: AdvancedPaymentGetData): Promise<AdvancedPaymentResponse>;
    /**
     * Search advanced payments with optional filters and pagination.
     */
    search(advancedPaymentSearchOptions?: AdvancedPaymentSearchData): Promise<AdvancedPaymentSearchResponse>;
    /**
     * Update an existing advanced payment with arbitrary fields.
     */
    update({ id, body, requestOptions }: AdvancedPaymentUpdateData): Promise<AdvancedPaymentResponse>;
    /**
     * Cancel a pending advanced payment by setting its status to `cancelled`.
     */
    cancel({ id, requestOptions }: AdvancedPaymentCancelData): Promise<AdvancedPaymentResponse>;
    /**
     * Capture a previously authorised advanced payment.
     */
    capture({ id, requestOptions }: AdvancedPaymentCaptureData): Promise<AdvancedPaymentResponse>;
    /**
     * Change the money release date for all disbursements of an advanced payment.
     */
    updateReleaseDate({ id, releaseDate, requestOptions }: AdvancedPaymentUpdateReleaseDateData): Promise<AdvancedPaymentResponse>;
}