craft-commerce-headless-sdk/dist/api/payment.d.ts

Craft Commerce Headless SDK provides tools to integrate Craft Commerce in headless environments, focusing on building API-driven checkout experiences.

import { Client } from './client';
export interface PayData {
    cancelUrl?: string;
    orderEmail?: string;
    gatewayId?: number;
    number?: string;
    paymentAmount?: number;
    paymentCurrency?: string;
    paymentSourceId?: number;
    registerUserOnOrderComplete?: boolean;
    savePaymentSource?: boolean;
    saveBillingAddressOnOrderComplete?: boolean;
    saveShippingAddressOnOrderComplete?: boolean;
    saveAddressesOnOrderComplete?: boolean;
    [key: string]: any;
}
export interface CompletePaymentData {
    commerceTransactionHash: string;
}
/**
 * Payment-related API client.
 * @param craftClient - The Craft CMS client.
 * @returns The API functions for payment-related actions.
 */
export declare const payment: (craftClient: Client) => {
    completePayment: (paymentData: CompletePaymentData) => Promise<any>;
    pay: (paymentData: PayData) => Promise<any>;
};