import { BigNumberInput } from "../totals"; import { PaymentCollectionStatus, PaymentSessionStatus } from "./common"; import { PaymentAccountHolderDTO, PaymentCustomerDTO, PaymentProviderContext } from "./provider"; /** * The payment collection to be created. */ export interface CreatePaymentCollectionDTO { /** * The ISO 3 character currency code of the payment collection. */ currency_code: string; /** * The amount of the payment collection. */ amount: BigNumberInput; /** * Holds custom data in key-value pairs. */ metadata?: Record; } /** * The attributes to update in the payment collection. */ export interface UpdatePaymentCollectionDTO extends Partial { /** * The ID of the payment collection. */ id: string; } /** * The attributes in the payment collection to be created or updated. */ export interface UpsertPaymentCollectionDTO { /** * The ID of the payment collection. */ id?: string; /** * The ISO 3 character currency code of the payment collection. */ currency_code?: string; /** * The amount of the payment collection. */ amount?: BigNumberInput; /** * Holds custom data in key-value pairs. */ metadata?: Record; } /** * The attributes to update in the payment collection. */ export interface PaymentCollectionUpdatableFields { /** * The ISO 3 character currency code of the payment collection. */ currency_code?: string; /** * The status of the payment collection */ status?: PaymentCollectionStatus; /** * The amount of the payment collection. */ amount?: BigNumberInput; /** * Holds custom data in key-value pairs. */ metadata?: Record; } /** * The payment to be created. */ export interface CreatePaymentDTO { /** * The amount of the payment. */ amount: BigNumberInput; /** * The ISO 3 character currency code of the payment. */ currency_code: string; /** * The associated provider's ID. */ provider_id: string; /** * The data necessary for the associated payment provider to process the payment. */ data: Record; /** * The ID of the payment session this payment was created from. */ payment_session_id: string; /** * The associated payment collection's ID. */ payment_collection_id: string; } /** * The attributes to update in the payment. */ export interface UpdatePaymentDTO { /** * The ID of the payment. */ id: string; } /** * The capture to be created. */ export interface CreateCaptureDTO { /** * The amount of the capture. */ amount?: BigNumberInput; /** * The associated payment's ID. */ payment_id: string; /** * Who captured the payment. For example, * a user's ID. */ captured_by?: string; } /** * The refund to be created. */ export interface CreateRefundDTO { /** * The amount of the refund. */ amount?: BigNumberInput; /** * The associated payment's ID. */ payment_id: string; /** * The associated refund reason's ID. */ refund_reason_id?: string | null; /** * A text field that adds some information about the refund */ note?: string; /** * Who refunded the payment. For example, * a user's ID. */ created_by?: string; } /** * The payment session to be created. */ export interface CreatePaymentSessionDTO { /** * The provider's ID. */ provider_id: string; /** * The ISO 3 character currency code of the payment session. */ currency_code: string; /** * The amount to be authorized. */ amount: BigNumberInput; /** * Necessary data for the associated payment provider to process the payment. */ data: Record; /** * Necessary context data for the associated payment provider. */ context?: PaymentProviderContext; /** * Holds custom data in key-value pairs. */ metadata?: Record; } /** * The attributes to update in a payment session. */ export interface UpdatePaymentSessionDTO { /** * The payment session's ID. */ id: string; /** * Necessary data for the associated payment provider to process the payment. */ data: Record; /** * The ISO 3 character currency code. */ currency_code: string; /** * The amount to be authorized. */ amount: BigNumberInput; /** * The status of the payment session. */ status?: PaymentSessionStatus; /** * Necessary context data for the associated payment provider. */ context?: PaymentProviderContext; /** * Holds custom data in key-value pairs. */ metadata?: Record; } /** * The payment provider to be created. */ export interface CreatePaymentProviderDTO { /** * The provider's ID. */ id: string; /** * Whether the provider is enabled. */ is_enabled?: boolean; } /** * The payment session to be created. */ export interface CreateAccountHolderDTO { /** * The provider's ID. */ provider_id: string; /** * Necessary context data for the associated payment provider. */ context: PaymentProviderContext & { /** * The customer information from Medusa. */ customer: PaymentCustomerDTO; }; } export interface UpdateAccountHolderDTO { /** * The ID of the account holder. */ id: string; /** * The provider's ID. */ provider_id: string; /** * Necessary context data for the associated payment provider. */ context: PaymentProviderContext & { /** * The account holder information from Medusa. */ account_holder: PaymentAccountHolderDTO; }; /** * Holds custom data in key-value pairs. */ metadata?: Record; } /** * The details of the webhook event payload. */ export interface ProviderWebhookPayload { /** * The ID of the provider to pass the webhook event payload to. */ provider: string; /** * The webhook event payload passed to the specified provider. */ payload: { /** * The parsed webhook body. */ data: Record; /** * The raw webhook request body. */ rawData: string | Buffer; /** * The headers of the webhook request. */ headers: Record; }; } export interface CreateRefundReasonDTO { /** * The label of the refund reason */ label: string; /** * The description of the refund reason */ description?: string | null; /** * The metadata of the refund reason */ metadata?: Record | null; } export interface UpdateRefundReasonDTO { /** * The id of the refund reason */ id: string; /** * The label of the refund reason */ label?: string; /** * The description of the refund reason */ description?: string | null; /** * The metadata of the refund reason */ metadata?: Record | null; } /** * The payment method to be created. */ export interface CreatePaymentMethodDTO { /** * The provider's ID. */ provider_id: string; /** * Necessary data for the associated payment provider to process the payment. */ data: Record; /** * Necessary context data for the associated payment provider. */ context: PaymentProviderContext; } //# sourceMappingURL=mutations.d.ts.map