@hyperse/paypal-node-sdk/dist/orders/ordersCaptureRequest.d.ts

NodeJS SDK for PayPal Checkout APIs

import { HttpRequestBase } from '../core/HttpRequestBase.js';
import { type BaseOrderHeaders, type PaymentSource } from '../types/type-order.js';
/**
 * Captures a payment for an order payload
 */
export type OrdersCaptureRequestBody = {
    payment_source: PaymentSource;
};
export interface OrdersCaptureRequestHeaders extends BaseOrderHeaders {
    'PayPal-Client-Metadata-Id'?: string;
    'PayPal-Request-Id'?: string;
    Prefer?: string;
}
/**
 * Captures a payment for an order.
 *
 * @see {@link https://developer.paypal.com/api/orders/v2/#orders_capture}
 */
export declare class OrdersCaptureRequest extends HttpRequestBase<OrdersCaptureRequestHeaders, OrdersCaptureRequestBody> {
    constructor(orderId: string);
    payPalClientMetadataId(payPalClientMetadataId: string): this;
    payPalRequestId(payPalRequestId: string): this;
    /**
     * 1. return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.
     * 2. return=representation. The server returns a complete resource representation, including the current state of the resource.
     * @default `return=minimal`
     */
    prefer(prefer: string): this;
    requestBody(orderActionRequest: OrdersCaptureRequestBody): this;
}