pluggy-sdk/dist/types/creditCardBills.d.ts

Official Node.js/TypeScript SDK for the Pluggy API.

import { CurrencyCode } from './common';
export declare const CREDIT_CARD_BILL_FINANCE_CHARGE_TYPES: readonly ["LATE_PAYMENT_REMUNERATIVE_INTEREST", "LATE_PAYMENT_FEE", "LATE_PAYMENT_INTEREST", "IOF", "OTHER"];
export type CreditCardBillFinanceChargeType = typeof CREDIT_CARD_BILL_FINANCE_CHARGE_TYPES[number];
export declare const CREDIT_CARD_BILL_PAYMENT_VALUE_TYPES: readonly ["INSTALLMENT_PAYMENT", "FULL_PAYMENT", "OTHER_PAYMENT"];
export type CreditCardBillPaymentValueType = typeof CREDIT_CARD_BILL_PAYMENT_VALUE_TYPES[number];
export declare const CREDIT_CARD_BILL_PAYMENT_MODES: readonly ["DEBIT_ACCOUNT", "BANK_SLIP", "PAYROLL_DEDUCTION", "PIX"];
export type CreditCardBillPaymentMode = typeof CREDIT_CARD_BILL_PAYMENT_MODES[number];
export type CreditCardBills = {
    id: string;
    dueDate: Date;
    /** Date when the bill was closed */
    billClosingDate: Date | null;
    totalAmount: number;
    totalAmountCurrencyCode: CurrencyCode;
    minimumPaymentAmount: number | null;
    allowsInstallments: boolean | null;
    financeCharges: CreditCardBillFinanceChargeResponseItem[];
    /** List of payments associated to the bill */
    payments: CreditCardBillPayment[];
    createdAt: Date;
    updatedAt: Date;
};
export type CreditCardBillPayment = {
    id: string;
    /** Classifies the payment value type */
    valueType: CreditCardBillPaymentValueType;
    /** Date when the payment was made */
    paymentDate: Date;
    /** Payment mode used */
    paymentMode: CreditCardBillPaymentMode | null;
    /** Payment amount */
    amount: number;
    /** Code referencing the currency of the payment */
    currencyCode: CurrencyCode;
};
export type CreditCardBillFinanceChargeResponseItem = {
    id: string;
    type: CreditCardBillFinanceChargeType;
    amount: number;
    currencyCode: CurrencyCode;
    additionalInfo: string | null;
};