intopays/dist/core/models/Pix.d.ts

Intopays - Gateway de integração bancária

import { PixInfo } from "./PixInfo";
import { IntegrationEnum } from "../enums/IntegrationEnum";
import { PixTransactionStatus } from "../enums/PixTransactionStatus";
/**
 * Representa uma solicitação e resposta de integração com o sistema de pagamento via Pix.
 */
export declare class Pix {
    constructor(data?: Partial<Pix>);
    /**
     * Tempo de expiração do Pix em segundos.
     */
    calendarExpiration: number;
    /**
     * Nome do pagador (devedor).
     */
    debtorName: string;
    /**
     * Documento do pagador (CPF ou CNPJ).
     */
    debtorDocument: string;
    /**
     * Valor original da cobrança em formato string (ex: "150.00").
     */
    amountOriginal: string;
    /**
     * Tipo de modificação permitida no valor:
     * - `0`: Valor fixo (sem alteração)
     * - `1`: Permite alteração pelo pagador
     */
    amountModificationType: number;
    /**
     * Mensagem adicional visível ao pagador.
     */
    payerRequest: string;
    /**
     * Lista de informações adicionais visíveis no comprovante de pagamento Pix.
     * Cada item representa uma informação nomeada como "chave: valor".
     */
    additionalInfos: Array<PixInfo>;
    /**
     * Instituição financeira utilizada na integração Pix.
     * Pode ser: SICOOB, SICREDI, INTER, SANTANDER, BANCODOBRASIL, BRADESCO ou ITAU.
     */
    integrationType: IntegrationEnum;
    /**
     * ID interno da transação Pix.
     */
    id?: number;
    /**
     * Chave Pix utilizada na cobrança (e-mail, CPF, CNPJ, telefone ou chave aleatória).
     */
    pixKey?: string;
    /**
     * Status atual da cobrança Pix.
     * Pode ser: ACTIVE, COMPLETED, REMOVED_BY_USER_RECEIVER ou REMOVED_BY_PSP.
     */
    status?: PixTransactionStatus;
    /**
     * Revisão atual da cobrança Pix (utilizado em atualizações).
     */
    revision?: number;
    /**
     * ID da localização gerada pelo PSP (Provedor de Serviços de Pagamento).
     */
    locId?: number;
    /**
     * URL da localização da cobrança (geralmente um link QR Code).
     */
    locLocation?: string;
    /**
     * Tipo da localização gerada (ex: `cob`, `cobv`, etc).
     */
    locType?: string;
    /**
     * Endereço completo da cobrança Pix (equivalente ao QR Code dinâmico).
     */
    location?: string;
    /**
     * Identificador da transação gerado pelo cliente (TxID).
     */
    transactionId?: string;
}