/** * Finix API */ import { Currency } from './currency'; import { SettlementLinks } from './settlementLinks'; /** * */ export declare class Settlement { /** * The ID of the `Settlement` resource. */ 'id'?: string; /** * Timestamp of when the object was created. */ 'createdAt'?: Date; /** * Timestamp of when the object was last updated. */ 'updatedAt'?: Date; /** * The ID of the `Application` resource the `Settlement` was created under. */ 'application'?: string; 'currency'?: Currency; /** * ID of the `Payment Instrument` where funds will be sent. */ 'destination'?: string | null; /** * Details how funds will be dispersed in the `Funding Transfer` (usually **null**). */ 'fundsFlow'?: string | null; /** * The ID of the `Identity` used to create the `Settlement` resource. */ 'identity'?: string; /** * The ID of the `Merchant` used to create the `Settlement` resource. */ 'merchantId'?: string; /** * The amount in cents that will be deposited into the merchant\'s bank account. */ 'netAmount'?: number; /** * The type of `Payment Instrument` used in the `Funding Transfer` (or the original payment). */ 'paymentType'?: string | null; /** * Name of the `Settlement` processor. */ 'processor'?: string; /** * The status of the `Settlement`. Available values include: Merchants only receive payouts when `Settlements` are **APPROVED** and receive the resulting funding `Transfer` . For more information, see [Payouts](/guides/payouts/). */ 'status'?: Settlement.StatusEnum | string; /** * Key value pair for annotating custom meta data (e.g. order numbers). */ 'tags'?: { [key: string]: string; } | null; /** * Total amount of the `Settlement` (in cents). */ 'totalAmount'?: number; /** * Sum of the fees in the `Settlement`. */ 'totalFee'?: number; /** * Sum of the fees (including Subcription Billing) in the `Settlement`. */ 'totalFees'?: number; /** * Type of `Settlement`. */ 'type'?: Settlement.TypeEnum | string; 'links'?: SettlementLinks; static discriminator: string | undefined; static attributeTypeMap: Array<{ name: string; baseName: string; type: string; }>; static getAttributeTypeMap(): { name: string; baseName: string; type: string; }[]; } export declare namespace Settlement { enum StatusEnum { Approved, AwaitingApproval, Pending } enum TypeEnum { MerchantRevenue, PlatformFee, PartnerFee, Noop, Merchant, Application, Platform } }