@setup-automatizado/sicredi-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,1384 @@
+interface DevedorCpf {
+    /** @required CPF of the debtor (11 digits) */
+    cpf: string;
+    /** @required Full name of the debtor */
+    nome: string;
+    /** @optional Street address (required for cobv with boleto) */
+    logradouro?: string;
+    /** @optional City name (required for cobv with boleto) */
+    cidade?: string;
+    /** @optional State abbreviation (2 chars, e.g. "SP") */
+    uf?: string;
+    /** @optional Postal code (8 digits) */
+    cep?: string;
+}
+interface DevedorCnpj {
+    /** @required CNPJ of the debtor (14 digits) */
+    cnpj: string;
+    /** @required Company name of the debtor */
+    nome: string;
+    /** @optional Street address (required for cobv with boleto) */
+    logradouro?: string;
+    /** @optional City name (required for cobv with boleto) */
+    cidade?: string;
+    /** @optional State abbreviation (2 chars, e.g. "SP") */
+    uf?: string;
+    /** @optional Postal code (8 digits) */
+    cep?: string;
+}
+/** Debtor: either a person (CPF) or company (CNPJ) */
+type Devedor = DevedorCpf | DevedorCnpj;
+interface PagadorCpf {
+    /** @required CPF of the payer (11 digits) */
+    cpf: string;
+    /** @required Full name of the payer */
+    nome: string;
+}
+interface PagadorCnpj {
+    /** @required CNPJ of the payer (14 digits) */
+    cnpj: string;
+    /** @required Company name of the payer */
+    nome: string;
+}
+/** Payer: either a person (CPF) or company (CNPJ) */
+type Pagador = PagadorCpf | PagadorCnpj;
+/** Receiver/payee information */
+interface Recebedor {
+    /** @optional CPF of the receiver (mutually exclusive with cnpj) */
+    cpf?: string;
+    /** @optional CNPJ of the receiver (mutually exclusive with cpf) */
+    cnpj?: string;
+    /** @required Full name or company name of the receiver */
+    nome: string;
+    /** @optional Trading name / brand name */
+    nomeFantasia?: string;
+    /** @optional Street address */
+    logradouro?: string;
+    /** @optional City name */
+    cidade?: string;
+    /** @optional State abbreviation (2 chars) */
+    uf?: string;
+    /** @optional Postal code (8 digits) */
+    cep?: string;
+    /** @optional Bank account number */
+    conta?: string;
+    /** @optional Bank branch number */
+    agencia?: string;
+}
+interface Valor {
+    /** @required Decimal value as string, e.g. "100.00" (max 2 decimal places) */
+    original: string;
+}
+interface ValorComDesconto extends Valor {
+    /** @optional Modality for discount/interest/penalty calculation */
+    modalidade?: number;
+    /** @optional Discount configuration */
+    desconto?: {
+        /** @required Discount modality (1-6) */
+        modalidade: number;
+        /** @optional Fixed value or percentage (depending on modality) */
+        valorPerc?: string;
+        /** @optional Date-specific discount entries (for modalities 1-2) */
+        descontoDataFixa?: Array<{
+            data: string;
+            valorPerc: string;
+        }>;
+    };
+    /** @optional Interest configuration */
+    juros?: {
+        /** @required Interest modality (1-8) */
+        modalidade: number;
+        /** @required Interest value or percentage */
+        valorPerc: string;
+    };
+    /** @optional Penalty configuration */
+    multa?: {
+        /** @required Penalty modality: 1 = Fixed, 2 = Percentage */
+        modalidade: number;
+        /** @required Penalty value or percentage */
+        valorPerc: string;
+    };
+    /** @optional Rebate/reduction configuration */
+    abatimento?: {
+        /** @required Rebate modality: 1 = Fixed, 2 = Percentage */
+        modalidade: number;
+        /** @required Rebate value or percentage */
+        valorPerc: string;
+    };
+}
+/** Calendar for immediate charges (cob) */
+interface Calendario {
+    /** @optional ISO 8601 timestamp of creation (set by server) */
+    criacao?: string;
+    /** @optional ISO 8601 timestamp when the charge was presented to the payer */
+    apresentacao?: string;
+    /** @optional Expiration in seconds from creation (default: 86400 = 24h) */
+    expiracao?: number;
+}
+/** Calendar for charges with due date (cobv) */
+interface CalendarioVencimento {
+    /** @optional ISO 8601 timestamp of creation (set by server) */
+    criacao?: string;
+    /** @required Due date in YYYY-MM-DD format */
+    dataDeVencimento: string;
+    /** @optional Validity in days after due date (default: 30) */
+    validadeAposVencimento?: number;
+}
+/** Additional information key-value pair displayed to the payer */
+interface InfoAdicional {
+    /** @required Field name (max 50 chars) */
+    nome: string;
+    /** @required Field value (max 200 chars) */
+    valor: string;
+}
+/** Pagination metadata returned by list endpoints */
+interface Paginacao {
+    /** @required Current page number (0-indexed) */
+    paginaAtual: number;
+    /** @required Number of items per page */
+    itensPorPagina: number;
+    /** @required Total number of pages */
+    quantidadeDePaginas: number;
+    /** @required Total number of items across all pages */
+    quantidadeTotalDeItens: number;
+}
+/** Pagination parameters for list requests */
+interface PaginacaoParams {
+    /** @optional Page number to retrieve (0-indexed, default: 0) */
+    paginaAtual?: number;
+    /** @optional Items per page (default: 100) */
+    itensPorPagina?: number;
+}
+/** Payload location (loc) - used to generate PIX QR codes */
+interface Loc {
+    /** @required Unique identifier of the payload location */
+    id: number;
+    /** @required URL of the payload location */
+    location: string;
+    /** @required Type of charge: 'cob' (immediate) or 'cobv' (with due date) */
+    tipoCob: 'cob' | 'cobv';
+    /** @optional ISO 8601 timestamp of creation */
+    criacao?: string;
+    /** @optional Transaction ID linked to this location */
+    txid?: string;
+}
+/** Extended location with activation/deactivation timestamps */
+interface LocCompleta extends Loc {
+    /** @optional ISO 8601 timestamp when the location was activated */
+    ativacao?: string;
+    /** @optional ISO 8601 timestamp when the location was deactivated */
+    inativacao?: string;
+}
+/**
+ * Breakdown of payment value into components.
+ * Present in received PIX payments. For cobv payments, may include juros, multa, desconto, abatimento.
+ *
+ * Formula: valor = (original + saque + troco) + multa + juros - abatimento - desconto
+ * (only present fields are included in the calculation)
+ */
+interface ComponentesValor {
+    /** @optional Original payment amount (may be omitted for pure Pix Saque, or 0.00) */
+    original?: {
+        valor: string;
+    };
+    /** @optional Withdrawal (saque) component - PIX Saque */
+    saque?: {
+        /** @required Withdrawal amount as decimal string */
+        valor: string;
+        /**
+         * @required Agent modality:
+         * - AGTEC: Agente Estabelecimento Comercial
+         * - AGTOT: Agente Outra Especie de PJ
+         * - AGPSS: Agente Facilitador de Servico de Saque
+         */
+        modalidadeAgente: 'AGTEC' | 'AGTOT' | 'AGPSS';
+        /** @optional ISPB of the withdrawal service provider */
+        prestadorDeServicoDeSaque?: string;
+    };
+    /** @optional Change (troco) component - PIX Troco (mutually exclusive with saque) */
+    troco?: {
+        /** @required Change amount as decimal string */
+        valor: string;
+        /**
+         * @required Agent modality:
+         * - AGTEC: Agente Estabelecimento Comercial
+         * - AGTOT: Agente Outra Especie de PJ
+         * - AGPSS: Agente Facilitador de Servico de Saque
+         */
+        modalidadeAgente: 'AGTEC' | 'AGTOT' | 'AGPSS';
+        /** @optional ISPB of the withdrawal service provider */
+        prestadorDeServicoDeSaque?: string;
+    };
+    /** @optional Interest amount (only for cobv payments after due date) */
+    juros?: {
+        valor: string;
+    };
+    /** @optional Penalty amount (only for cobv payments after due date) */
+    multa?: {
+        valor: string;
+    };
+    /** @optional Rebate/reduction amount (only for cobv payments) */
+    abatimento?: {
+        valor: string;
+    };
+    /** @optional Discount amount (only for cobv payments before due date) */
+    desconto?: {
+        valor: string;
+    };
+}
+/** Configuration for Saque (withdrawal) or Troco (change) in a charge */
+interface SaqueTroco {
+    /** @required Amount as decimal string (e.g. "20.00") */
+    valor: string;
+    /** @optional Whether the payer can modify the amount: 0 = No, 1 = Yes */
+    modalidadeAlteracao?: 0 | 1;
+    /** @optional ISPB of the withdrawal service provider */
+    prestadorDeServicoDeSaque?: string;
+    /**
+     * @required Agent modality:
+     * - AGTEC: Agente Estabelecimento Comercial
+     * - AGTOT: Agente Outra Especie de PJ
+     * - AGPSS: Agente Facilitador de Servico de Saque
+     */
+    modalidadeAgente: 'AGTEC' | 'AGTOT' | 'AGPSS';
+}
+/**
+ * Status for refund/return operations.
+ * Includes both legacy (v2) and current (v2.9+) status names for compatibility.
+ * - EM_PROCESSAMENTO / PENDENTE: Refund is being processed
+ * - DEVOLVIDO / LIQUIDADO: Refund has been settled
+ * - NAO_REALIZADO: Refund could not be completed
+ */
+type DevolucaoStatus = 'EM_PROCESSAMENTO' | 'DEVOLVIDO' | 'NAO_REALIZADO' | 'PENDENTE' | 'LIQUIDADO';
+/**
+ * Nature of the refund/return (response - all possible values from PSP).
+ * - ORIGINAL (MD06): Refund of a regular Pix or the purchase value in Pix Troco
+ * - RETIRADA (SL02): Refund of a Pix Saque or the change value in Pix Troco
+ * - MED_OPERACIONAL (BE08): MED refund due to operational failure
+ * - MED_FRAUDE (FR01): MED refund due to suspected fraud
+ * - MED_PIX_AUTOMATICO (REFU): MED reimbursement for Pix Automatico
+ *
+ * When absent, defaults to ORIGINAL.
+ */
+type DevolucaoNatureza = 'ORIGINAL' | 'RETIRADA' | 'MED_OPERACIONAL' | 'MED_FRAUDE' | 'MED_PIX_AUTOMATICO';
+/**
+ * Nature of a refund/return request (request - only user-initiated values).
+ * - ORIGINAL (MD06): Refund of a regular Pix or the purchase value in Pix Troco
+ * - RETIRADA (SL02): Refund of a Pix Saque or the change value in Pix Troco
+ *
+ * When absent, defaults to ORIGINAL.
+ */
+type DevolucaoSolicitadaNatureza = 'ORIGINAL' | 'RETIRADA';
+/** Type guard: checks if a Devedor is identified by CPF */
+declare function isDevedorCpf(devedor: Devedor): devedor is DevedorCpf;
+/** Type guard: checks if a Devedor is identified by CNPJ */
+declare function isDevedorCnpj(devedor: Devedor): devedor is DevedorCnpj;
+/** Type guard: checks if a Pagador is identified by CPF */
+declare function isPagadorCpf(pagador: Pagador): pagador is PagadorCpf;
+/** Type guard: checks if a Pagador is identified by CNPJ */
+declare function isPagadorCnpj(pagador: Pagador): pagador is PagadorCnpj;
+
+/**
+ * Status of an immediate PIX charge (cob).
+ * - ATIVA: Charge is active and can be paid
+ * - CONCLUIDA: Charge has been paid
+ * - REMOVIDA_PELO_USUARIO_RECEBEDOR: Cancelled by the receiver
+ * - REMOVIDA_PELO_PSP: Removed by the Payment Service Provider
+ */
+type CobStatus = 'ATIVA' | 'CONCLUIDA' | 'REMOVIDA_PELO_USUARIO_RECEBEDOR' | 'REMOVIDA_PELO_PSP';
+/** Refund/return attached to a PIX payment */
+interface Devolucao {
+    /** @required Refund ID assigned by PSP */
+    id: string;
+    /** @required Return Transaction Reference ID (32 alphanumeric chars, e.g. "D12345678202009091000abcde123456") */
+    rtrId: string;
+    /** @required Refund amount as decimal string (e.g. "10.00") */
+    valor: string;
+    /** @optional Nature of the refund (defaults to ORIGINAL when absent) */
+    natureza?: DevolucaoNatureza;
+    /** @optional Description/reason for the refund (max 140 chars) */
+    descricao?: string;
+    /** @required Timestamps for the refund */
+    horario: {
+        /** @required ISO 8601 timestamp when refund was requested */
+        solicitacao: string;
+        /** @optional ISO 8601 timestamp when refund was settled */
+        liquidacao?: string;
+    };
+    /** @required Current status of the refund */
+    status: DevolucaoStatus;
+    /** @optional Reason/description of the status (e.g. explains NAO_REALIZADO reason) */
+    motivo?: string;
+}
+/** PIX payment received against a charge */
+interface PixPayment {
+    /** @required End-to-end ID (unique payment identifier from Bacen) */
+    endToEndId: string;
+    /** @optional Transaction ID (present if payment is linked to a charge) */
+    txid?: string;
+    /** @required Payment amount as decimal string */
+    valor: string;
+    /** @optional PIX key that received the payment */
+    chave?: string;
+    /** @optional Payer identification (CPF or CNPJ with name) */
+    pagador?: Pagador;
+    /** @required Payment timestamps */
+    horario: {
+        /** @required ISO 8601 timestamp when payment was requested */
+        solicitacao: string;
+        /** @optional ISO 8601 timestamp when payment was settled */
+        liquidacao?: string;
+    };
+    /** @optional Free-text information from the payer */
+    infoPagador?: string;
+    /** @optional Breakdown of payment value (original, saque, troco) */
+    componentesValor?: ComponentesValor;
+    /** @optional List of refunds/returns associated with this payment */
+    devolucoes?: Devolucao[];
+}
+/** Request body for creating an immediate PIX charge */
+interface CreateCobRequest {
+    /** @required Calendar with expiration settings */
+    calendario: {
+        /** @required Expiration in seconds from creation */
+        expiracao: number;
+    };
+    /** @optional Debtor information (person or company) */
+    devedor?: Devedor;
+    /** @required Charge amount */
+    valor: Valor;
+    /** @required PIX key of the receiver */
+    chave: string;
+    /** @optional Free-text message requesting payment info from payer (max 140 chars) */
+    solicitacaoPagador?: string;
+    /** @optional Additional information fields displayed to the payer */
+    infoAdicionais?: InfoAdicional[];
+    /** @optional Link to an existing payload location by ID */
+    loc?: {
+        id: number;
+    };
+    /** @optional Withdrawal (Saque) configuration - PIX Saque */
+    saque?: SaqueTroco;
+    /** @optional Change (Troco) configuration - PIX Troco */
+    troco?: SaqueTroco;
+}
+/** Response from creating/querying an immediate PIX charge */
+interface CobResponse {
+    /** @required Calendar with creation and expiration info */
+    calendario: Calendario;
+    /** @required Transaction ID (26-35 alphanumeric chars) */
+    txid: string;
+    /** @required Revision number (increments on each update) */
+    revisao: number;
+    /** @optional Payload location details */
+    loc?: Loc;
+    /** @optional Payload location URL string */
+    location?: string;
+    /** @required Current status of the charge */
+    status: CobStatus;
+    /** @optional Debtor information */
+    devedor?: Devedor;
+    /** @required Charge amount */
+    valor: Valor;
+    /** @required PIX key of the receiver */
+    chave: string;
+    /** @optional Free-text message requesting payment info from payer */
+    solicitacaoPagador?: string;
+    /** @optional Additional information fields */
+    infoAdicionais?: InfoAdicional[];
+    /** @optional PIX Copia e Cola string (BR Code payload for copy-paste) */
+    pixCopiaECola?: string;
+    /** @optional BR Code string (raw QR code content) */
+    brcode?: string;
+    /** @optional List of PIX payments received for this charge */
+    pix?: PixPayment[];
+    /** @optional Withdrawal (Saque) configuration */
+    saque?: SaqueTroco;
+    /** @optional Change (Troco) configuration */
+    troco?: SaqueTroco;
+}
+/** Request body for updating (PATCH) an immediate PIX charge */
+interface UpdateCobRequest {
+    /** @optional Updated calendar/expiration settings */
+    calendario?: {
+        /** @required Expiration in seconds */
+        expiracao: number;
+    };
+    /** @optional Updated debtor information */
+    devedor?: Devedor;
+    /** @optional Updated charge amount */
+    valor?: Valor;
+    /** @optional Updated PIX key */
+    chave?: string;
+    /** @optional Updated payment request message */
+    solicitacaoPagador?: string;
+    /** @optional Updated additional information fields */
+    infoAdicionais?: InfoAdicional[];
+    /** @optional Link to an existing payload location by ID */
+    loc?: {
+        id: number;
+    };
+    /** @optional Set to 'REMOVIDA_PELO_USUARIO_RECEBEDOR' to cancel the charge */
+    status?: 'REMOVIDA_PELO_USUARIO_RECEBEDOR';
+}
+/** Parameters for listing immediate PIX charges */
+interface ListCobParams {
+    /** @required Start date filter (ISO 8601, e.g. "2024-01-01T00:00:00Z") */
+    inicio: string;
+    /** @required End date filter (ISO 8601) */
+    fim: string;
+    /** @optional Filter by debtor CPF (11 digits) */
+    cpf?: string;
+    /** @optional Filter by debtor CNPJ (14 digits) */
+    cnpj?: string;
+    /** @optional Filter by whether a payload location is present */
+    locationPresente?: boolean;
+    /** @optional Filter by charge status */
+    status?: CobStatus;
+    /** @optional Pagination parameters */
+    paginacao?: PaginacaoParams;
+}
+/** Response from listing immediate PIX charges */
+interface ListCobResponse {
+    /** @required Query parameters and pagination metadata */
+    parametros: {
+        /** @required Start date used in the query */
+        inicio: string;
+        /** @required End date used in the query */
+        fim: string;
+        /** @required Pagination metadata */
+        paginacao: Paginacao;
+    };
+    /** @required List of charges matching the filters */
+    cobs: CobResponse[];
+}
+
+/** mTLS certificate configuration for Sicredi API authentication */
+interface CertificateOptions {
+    /** @required PEM string or file path to client certificate (.cer/.crt/.pem) */
+    cert: string;
+    /** @required PEM string or file path to private key (.key/.pem) */
+    key: string;
+    /** @optional PEM string or file path to CA certificate chain (Sicredi root CA) */
+    ca?: string;
+    /** @optional Passphrase for the private key (if encrypted) */
+    passphrase?: string;
+}
+/** Main SDK configuration */
+interface SicrediConfig {
+    /** @required OAuth2 client ID (provided by Sicredi) */
+    clientId: string;
+    /** @required OAuth2 client secret (provided by Sicredi) */
+    clientSecret: string;
+    /** @optional Default PIX key for operations (can be overridden per-call) */
+    pixKey?: string;
+    /** @required mTLS certificate options (cert + key are mandatory) */
+    certificate: CertificateOptions;
+    /** @optional Environment: 'production' or 'sandbox' (default: 'production') */
+    environment?: 'production' | 'sandbox';
+    /** @optional Custom base URL (overrides environment selection) */
+    baseUrl?: string;
+    /** @optional Request timeout in milliseconds (default: 30000) */
+    timeout?: number;
+    /** @optional Maximum retry attempts for failed requests (default: 3) */
+    maxRetries?: number;
+    /** @optional Enable debug logging to console (default: false) */
+    debug?: boolean;
+}
+
+interface HttpRequestOptions {
+    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    url: string;
+    headers?: Record<string, string>;
+    body?: string;
+    timeout?: number;
+}
+interface HttpResponse {
+    status: number;
+    headers: Record<string, string>;
+    body: string;
+}
+interface HttpClient {
+    request(options: HttpRequestOptions): Promise<HttpResponse>;
+}
+
+declare class AuthManager {
+    private readonly clientId;
+    private readonly clientSecret;
+    private readonly baseUrl;
+    private readonly httpClient;
+    private cachedToken;
+    private refreshPromise;
+    constructor(clientId: string, clientSecret: string, baseUrl: string, httpClient: HttpClient);
+    getAccessToken(): Promise<string>;
+    invalidateToken(): void;
+    private isTokenExpiringSoon;
+    private refreshToken;
+}
+
+interface RetryOptions {
+    maxRetries: number;
+    baseDelayMs?: number;
+    maxDelayMs?: number;
+}
+
+interface ResourceConfig {
+    baseUrl: string;
+    httpClient: HttpClient;
+    authManager: AuthManager;
+    retryOptions: RetryOptions;
+    debug: boolean;
+}
+declare abstract class BaseResource {
+    protected readonly baseUrl: string;
+    protected readonly httpClient: HttpClient;
+    protected readonly authManager: AuthManager;
+    protected readonly retryOptions: RetryOptions;
+    protected readonly debug: boolean;
+    constructor(config: ResourceConfig);
+    protected request<T>(method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', path: string, body?: unknown, query?: Record<string, string | number | boolean | undefined>): Promise<T>;
+    private buildUrl;
+}
+
+declare class CobResource extends BaseResource {
+    /**
+     * Create a PIX immediate charge with a specific txid.
+     * PUT /api/v2/cob/{txid}
+     */
+    create(txid: string, data: CreateCobRequest): Promise<CobResponse>;
+    /**
+     * Create a PIX immediate charge with auto-generated txid.
+     * POST /api/v2/cob
+     */
+    createAuto(data: CreateCobRequest): Promise<CobResponse>;
+    /**
+     * Get a PIX immediate charge by txid.
+     * GET /api/v3/cob/{txid} (note: v3!)
+     */
+    get(txid: string, revisao?: number): Promise<CobResponse>;
+    /**
+     * Update (patch) a PIX immediate charge.
+     * PATCH /api/v2/cob/{txid}
+     */
+    update(txid: string, data: UpdateCobRequest): Promise<CobResponse>;
+    /**
+     * Cancel a PIX immediate charge by setting status to REMOVIDA_PELO_USUARIO_RECEBEDOR.
+     * PATCH /api/v2/cob/{txid}
+     */
+    cancel(txid: string): Promise<CobResponse>;
+    /**
+     * List PIX immediate charges with filters.
+     * GET /api/v2/cob
+     */
+    list(params: ListCobParams): Promise<ListCobResponse>;
+    /**
+     * Generate a txid (helper utility).
+     */
+    generateTxId(length?: number): string;
+}
+
+/**
+ * Status of a charge with due date (cobv / Boleto Hibrido).
+ * - ATIVA: Charge is active and can be paid
+ * - CONCLUIDA: Charge has been paid
+ * - REMOVIDA_PELO_USUARIO_RECEBEDOR: Cancelled by the receiver
+ * - REMOVIDA_PELO_PSP: Removed by the Payment Service Provider
+ * - VENCIDA: Charge is past due date + validity period
+ */
+type CobvStatus = 'ATIVA' | 'CONCLUIDA' | 'REMOVIDA_PELO_USUARIO_RECEBEDOR' | 'REMOVIDA_PELO_PSP' | 'VENCIDA';
+/** Date-specific discount entry for modalities 1 and 2 */
+interface DescontoDataFixa {
+    /** @required Date in YYYY-MM-DD format when this discount applies */
+    data: string;
+    /** @required Fixed value or percentage for this date */
+    valorPerc: string;
+}
+/** Discount configuration for charges with due date */
+interface Desconto {
+    /**
+     * @required Discount modality:
+     * - 1 = Fixed value until specific dates
+     * - 2 = Percentage until specific dates
+     * - 3 = Fixed value per anticipation day
+     * - 4 = Percentage per anticipation day
+     * - 5 = Fixed value per anticipation day (up to a date)
+     * - 6 = Percentage per anticipation day (up to a date)
+     */
+    modalidade: 1 | 2 | 3 | 4 | 5 | 6;
+    /** @optional Date-specific discount entries (required for modalities 1-2) */
+    descontoDataFixa?: DescontoDataFixa[];
+    /** @optional Fixed value or percentage (required for modalities 3-6) */
+    valorPerc?: string;
+}
+/** Interest configuration for overdue charges */
+interface Juros {
+    /**
+     * @required Interest modality:
+     * - 1 = Fixed daily value
+     * - 2 = Percentage per month (pro-rata per day)
+     * - 3 = Percentage per year (365 days)
+     * - 4 = Percentage per year (360 days)
+     * - 5 = Percentage per business day (252 days/year)
+     * - 6 = Percentage per business day (360 days/year)
+     * - 7 = Fixed monthly value
+     * - 8 = Exempt (no interest)
+     */
+    modalidade: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
+    /** @required Interest value or percentage as decimal string */
+    valorPerc: string;
+}
+/** Penalty (multa) configuration for overdue charges */
+interface Multa {
+    /** @required Penalty modality: 1 = Fixed value, 2 = Percentage */
+    modalidade: 1 | 2;
+    /** @required Penalty value or percentage as decimal string */
+    valorPerc: string;
+}
+/** Rebate/reduction (abatimento) configuration */
+interface Abatimento {
+    /** @required Rebate modality: 1 = Fixed value, 2 = Percentage */
+    modalidade: 1 | 2;
+    /** @required Rebate value or percentage as decimal string */
+    valorPerc: string;
+}
+/** Value configuration for charges with due date, including financial components */
+interface ValorCobv {
+    /** @required Original charge amount as decimal string (e.g. "150.00") */
+    original: string;
+    /** @optional Final calculated amount after applying interest, penalty, discounts, and rebates (set by server) */
+    final?: string;
+    /** @optional Penalty configuration applied after due date */
+    multa?: Multa;
+    /** @optional Interest configuration applied after due date */
+    juros?: Juros;
+    /** @optional Rebate/reduction applied to the charge */
+    abatimento?: Abatimento;
+    /** @optional Discount configuration for early payment */
+    desconto?: Desconto;
+}
+/** Request body for creating a charge with due date (Boleto Hibrido) */
+interface CreateCobvRequest {
+    /** @required Calendar with due date and validity settings */
+    calendario: CalendarioVencimento;
+    /** @required Debtor information (required for cobv, unlike cob) */
+    devedor: Devedor;
+    /** @required Charge amount with optional financial components */
+    valor: ValorCobv;
+    /** @required PIX key of the receiver */
+    chave: string;
+    /** @optional Free-text message requesting payment info from payer (max 140 chars) */
+    solicitacaoPagador?: string;
+    /** @optional Additional information fields displayed to the payer */
+    infoAdicionais?: InfoAdicional[];
+    /** @optional Link to an existing payload location by ID */
+    loc?: {
+        id: number;
+    };
+}
+/** Response from creating/querying a charge with due date */
+interface CobvResponse {
+    /** @required Calendar with due date info */
+    calendario: CalendarioVencimento;
+    /** @required Transaction ID (26-35 alphanumeric chars) */
+    txid: string;
+    /** @required Revision number (increments on each update) */
+    revisao: number;
+    /** @optional Payload location details */
+    loc?: Loc;
+    /** @optional Payload location URL string */
+    location?: string;
+    /** @required Current status of the charge */
+    status: CobvStatus;
+    /** @required Debtor information */
+    devedor: Devedor;
+    /** @optional Receiver information (set by server) */
+    recebedor?: Recebedor;
+    /** @required Charge amount with financial components */
+    valor: ValorCobv;
+    /** @required PIX key of the receiver */
+    chave: string;
+    /** @optional Free-text message requesting payment info from payer */
+    solicitacaoPagador?: string;
+    /** @optional Additional information fields */
+    infoAdicionais?: InfoAdicional[];
+    /** @optional PIX Copia e Cola string (BR Code payload for copy-paste) */
+    pixCopiaECola?: string;
+    /** @optional BR Code string (raw QR code content) */
+    brcode?: string;
+    /** @optional List of PIX payments received for this charge */
+    pix?: PixPayment[];
+}
+/** Request body for updating (PATCH) a charge with due date */
+interface UpdateCobvRequest {
+    /** @optional Updated calendar/due date settings */
+    calendario?: CalendarioVencimento;
+    /** @optional Updated debtor information */
+    devedor?: Devedor;
+    /** @optional Updated charge amount */
+    valor?: ValorCobv;
+    /** @optional Updated PIX key */
+    chave?: string;
+    /** @optional Updated payment request message */
+    solicitacaoPagador?: string;
+    /** @optional Updated additional information fields */
+    infoAdicionais?: InfoAdicional[];
+    /** @optional Link to an existing payload location by ID */
+    loc?: {
+        id: number;
+    };
+    /** @optional Set to 'REMOVIDA_PELO_USUARIO_RECEBEDOR' to cancel the charge */
+    status?: 'REMOVIDA_PELO_USUARIO_RECEBEDOR';
+}
+/** Parameters for listing charges with due date */
+interface ListCobvParams {
+    /** @required Start date filter (ISO 8601, e.g. "2024-01-01T00:00:00Z") */
+    inicio: string;
+    /** @required End date filter (ISO 8601) */
+    fim: string;
+    /** @optional Filter by debtor CPF (11 digits) */
+    cpf?: string;
+    /** @optional Filter by debtor CNPJ (14 digits) */
+    cnpj?: string;
+    /** @optional Filter by whether a payload location is present */
+    locationPresente?: boolean;
+    /** @optional Filter by charge status */
+    status?: CobvStatus;
+    /** @optional Filter by batch ID (loteCobVId) */
+    loteCobVId?: number;
+    /** @optional Pagination parameters */
+    paginacao?: PaginacaoParams;
+}
+/** Response from listing charges with due date */
+interface ListCobvResponse {
+    /** @required Query parameters and pagination metadata */
+    parametros: {
+        /** @required Start date used in the query */
+        inicio: string;
+        /** @required End date used in the query */
+        fim: string;
+        /** @required Pagination metadata */
+        paginacao: Paginacao;
+    };
+    /** @required List of charges matching the filters */
+    cobs: CobvResponse[];
+}
+
+declare class CobvResource extends BaseResource {
+    /**
+     * Create a Boleto Hibrido (PIX with due date) charge.
+     * PUT /api/v2/cobv/{txid}
+     */
+    create(txid: string, data: CreateCobvRequest): Promise<CobvResponse>;
+    /**
+     * Get a Boleto Hibrido charge by txid.
+     * GET /api/v2/cobv/{txid}
+     */
+    get(txid: string, revisao?: number): Promise<CobvResponse>;
+    /**
+     * Update (patch) a Boleto Hibrido charge.
+     * PATCH /api/v2/cobv/{txid}
+     */
+    update(txid: string, data: UpdateCobvRequest): Promise<CobvResponse>;
+    /**
+     * Cancel a Boleto Hibrido charge.
+     * PATCH /api/v2/cobv/{txid}
+     */
+    cancel(txid: string): Promise<CobvResponse>;
+    /**
+     * List Boleto Hibrido charges with filters.
+     * GET /api/v2/cobv
+     */
+    list(params: ListCobvParams): Promise<ListCobvResponse>;
+}
+
+/** Request body for creating a payload location */
+interface CreateLocRequest {
+    /** @required Type of charge: 'cob' (immediate) or 'cobv' (with due date) */
+    tipoCob: 'cob' | 'cobv';
+}
+/** Response from creating/querying a payload location */
+type LocResponse = LocCompleta;
+/** Parameters for listing payload locations */
+interface ListLocParams {
+    /** @required Start date filter (ISO 8601) */
+    inicio: string;
+    /** @required End date filter (ISO 8601) */
+    fim: string;
+    /** @optional Filter by charge type: 'cob' or 'cobv' */
+    tipoCob?: 'cob' | 'cobv';
+    /** @optional Filter by whether a txid is linked to the location */
+    txIdPresente?: boolean;
+    /** @optional Pagination parameters */
+    paginacao?: PaginacaoParams;
+}
+/** Response from listing payload locations */
+interface ListLocResponse {
+    /** @required Query parameters and pagination metadata */
+    parametros: {
+        /** @required Start date used in the query */
+        inicio: string;
+        /** @required End date used in the query */
+        fim: string;
+        /** @required Pagination metadata */
+        paginacao: Paginacao;
+    };
+    /** @required List of payload locations */
+    loc: LocResponse[];
+}
+
+declare class LocResource extends BaseResource {
+    /**
+     * Create a payload location.
+     * POST /api/v2/loc
+     */
+    create(data: CreateLocRequest): Promise<LocResponse>;
+    /**
+     * Get a payload location by ID.
+     * GET /api/v2/loc/{id}
+     */
+    get(id: number): Promise<LocResponse>;
+    /**
+     * List payload locations.
+     * GET /api/v2/loc
+     */
+    list(params: ListLocParams): Promise<ListLocResponse>;
+    /**
+     * Unlink a charge from a payload location.
+     * DELETE /api/v2/loc/{id}/txid
+     */
+    unlink(id: number): Promise<LocResponse>;
+}
+
+/**
+ * Status of an individual charge within a batch.
+ * - EM_PROCESSAMENTO: Charge is being processed
+ * - CRIADA: Charge was successfully created
+ */
+type LoteCobvItemStatus = 'EM_PROCESSAMENTO' | 'CRIADA';
+/** A single cobv charge request within a batch, requiring a txid */
+interface LoteCobvCobSolicitado extends CreateCobvRequest {
+    /** @required Transaction ID for this charge (26-35 alphanumeric chars) */
+    txid: string;
+}
+/** Request body for creating a batch of cobv charges (PUT /lotecobv/{id}) */
+interface LoteCobvRequest {
+    /** @optional Description for the batch */
+    descricao?: string;
+    /** @required Array of cobv charges to create */
+    cobsv: LoteCobvCobSolicitado[];
+}
+/** Request body for updating specific charges within a batch (PATCH /lotecobv/{id}) */
+interface LoteCobvPatchRequest {
+    /** @required Array of partial updates, each identified by txid */
+    cobsv: Array<Partial<CreateCobvRequest> & {
+        /** @required Transaction ID of the charge to update */
+        txid: string;
+    }>;
+}
+/** Response from querying a batch of cobv charges */
+interface LoteCobvResponse {
+    /** @required Batch ID */
+    id: number;
+    /** @optional Description for the batch */
+    descricao?: string;
+    /** @required ISO 8601 timestamp of batch creation */
+    criacao: string;
+    /** @required Array of cobv charge items with batch-specific status */
+    cobsv: Array<{
+        /** @required Transaction ID for this charge */
+        txid: string;
+        /** @required Batch processing status for this charge */
+        status: LoteCobvItemStatus;
+        /** @optional Full charge details (present when status is CRIADA) */
+        criacao?: CobvResponse;
+        /** @optional Processing error for this specific charge */
+        problema?: {
+            /** @required Error type URI (Bacen error taxonomy) */
+            type: string;
+            /** @required Human-readable error title */
+            title: string;
+            /** @required HTTP status code */
+            status: number;
+            /** @optional Detailed error description */
+            detail?: string;
+        };
+    }>;
+}
+/** Parameters for listing batches of cobv charges */
+interface ListLoteCobvParams {
+    /** @required Start date filter (ISO 8601) */
+    inicio: string;
+    /** @required End date filter (ISO 8601) */
+    fim: string;
+    /** @optional Pagination parameters */
+    paginacao?: PaginacaoParams;
+}
+/** Response from listing batches of cobv charges */
+interface ListLoteCobvResponse {
+    /** @required Query parameters and pagination metadata */
+    parametros: {
+        /** @required Start date used in the query */
+        inicio: string;
+        /** @required End date used in the query */
+        fim: string;
+        /** @required Pagination metadata */
+        paginacao: Paginacao;
+    };
+    /** @required List of batch responses */
+    lotes: LoteCobvResponse[];
+}
+
+declare class LoteCobvResource extends BaseResource {
+    /**
+     * Create or replace a batch of cobv charges.
+     * PUT /api/v2/lotecobv/{id}
+     */
+    create(id: number, data: LoteCobvRequest): Promise<void>;
+    /**
+     * Revise specific charges within a batch.
+     * PATCH /api/v2/lotecobv/{id}
+     */
+    update(id: number, data: LoteCobvPatchRequest): Promise<void>;
+    /**
+     * Query a specific batch of cobv charges.
+     * GET /api/v2/lotecobv/{id}
+     */
+    get(id: number): Promise<LoteCobvResponse>;
+    /**
+     * List batches of cobv charges.
+     * GET /api/v2/lotecobv
+     */
+    list(params: ListLoteCobvParams): Promise<ListLoteCobvResponse>;
+}
+
+/** A received PIX payment (from GET /pix endpoints) */
+interface PixRecebido {
+    /** @required End-to-end ID (unique payment identifier from Bacen) */
+    endToEndId: string;
+    /** @optional Transaction ID (present if payment is linked to a charge) */
+    txid?: string;
+    /** @required Payment amount as decimal string (e.g. "100.00") */
+    valor: string;
+    /** @required PIX key that received the payment */
+    chave: string;
+    /** @optional Payer identification (CPF or CNPJ with name) */
+    pagador?: Pagador;
+    /** @required Payment timestamps */
+    horario: {
+        /** @required ISO 8601 timestamp when payment was requested */
+        solicitacao: string;
+        /** @optional ISO 8601 timestamp when payment was settled */
+        liquidacao?: string;
+    };
+    /** @optional Free-text information from the payer */
+    infoPagador?: string;
+    /** @optional Receiver information */
+    recebedor?: Recebedor;
+    /** @optional Breakdown of payment value (original, saque, troco, juros, multa, desconto, abatimento) */
+    componentesValor?: ComponentesValor;
+    /** @optional List of refunds/returns associated with this payment */
+    devolucoes?: Devolucao[];
+}
+/** Request body for creating a refund/return */
+interface DevolucaoRequest {
+    /** @required Refund amount as decimal string (e.g. "10.00", must be <= original payment) */
+    valor: string;
+    /** @optional Nature of the refund: ORIGINAL (default, MD06) or RETIRADA (SL02, for Saque/Troco) */
+    natureza?: DevolucaoSolicitadaNatureza;
+    /** @optional Description/reason for the refund (max 140 chars, shown in pacs.004 RemittanceInformation) */
+    descricao?: string;
+}
+/** Response from creating/querying a refund/return */
+interface DevolucaoResponse {
+    /** @required Refund ID assigned by PSP */
+    id: string;
+    /** @required Return Transaction Reference ID */
+    rtrId: string;
+    /** @required Refund amount as decimal string */
+    valor: string;
+    /** @optional Nature of the refund */
+    natureza?: DevolucaoNatureza;
+    /** @optional Description/reason for the refund */
+    descricao?: string;
+    /** @required Timestamps for the refund */
+    horario: {
+        /** @required ISO 8601 timestamp when refund was requested */
+        solicitacao: string;
+        /** @optional ISO 8601 timestamp when refund was settled */
+        liquidacao?: string;
+    };
+    /** @required Current status of the refund */
+    status: DevolucaoStatus;
+    /** @optional Reason/description of the status (e.g. explains NAO_REALIZADO reason) */
+    motivo?: string;
+}
+/** Parameters for listing received PIX payments */
+interface ListPixParams {
+    /** @required Start date filter (ISO 8601) */
+    inicio: string;
+    /** @required End date filter (ISO 8601) */
+    fim: string;
+    /** @optional Filter by specific transaction ID */
+    txid?: string;
+    /** @optional Filter by whether a txid is present */
+    txIdPresente?: boolean;
+    /** @optional Filter by whether refunds/returns are present */
+    devolucaoPresente?: boolean;
+    /** @optional Filter by payer CPF (11 digits) */
+    cpf?: string;
+    /** @optional Filter by payer CNPJ (14 digits) */
+    cnpj?: string;
+    /** @optional Pagination parameters */
+    paginacao?: PaginacaoParams;
+}
+/** Response from listing received PIX payments */
+interface ListPixResponse {
+    /** @required Query parameters and pagination metadata */
+    parametros: {
+        /** @required Start date used in the query */
+        inicio: string;
+        /** @required End date used in the query */
+        fim: string;
+        /** @required Pagination metadata */
+        paginacao: Paginacao;
+    };
+    /** @required List of received PIX payments */
+    pix: PixRecebido[];
+}
+
+declare class PixResource extends BaseResource {
+    /**
+     * Query a received PIX payment by its end-to-end ID.
+     * GET /api/v2/pix/{e2eid}
+     */
+    get(e2eid: string): Promise<PixRecebido>;
+    /**
+     * List received PIX payments with filters.
+     * GET /api/v2/pix
+     */
+    list(params: ListPixParams): Promise<ListPixResponse>;
+    /**
+     * Request a refund/return for a received PIX payment.
+     * PUT /api/v2/pix/{e2eid}/devolucao/{id}
+     */
+    requestReturn(e2eid: string, id: string, data: DevolucaoRequest): Promise<DevolucaoResponse>;
+    /**
+     * Query the status of a refund/return.
+     * GET /api/v2/pix/{e2eid}/devolucao/{id}
+     */
+    getReturn(e2eid: string, id: string): Promise<DevolucaoResponse>;
+}
+
+interface WebhookConfigRequest {
+    /** @required URL where Sicredi will send webhook notifications */
+    webhookUrl: string;
+}
+interface WebhookResponse {
+    /** @required Configured webhook URL */
+    webhookUrl: string;
+    /** @required PIX key associated with this webhook */
+    chave: string;
+    /** @required ISO 8601 timestamp of webhook creation */
+    criacao: string;
+}
+interface ListWebhookParams {
+    /** @optional Start date filter (ISO 8601). Unlike other list endpoints, this is optional for webhooks. */
+    inicio?: string;
+    /** @optional End date filter (ISO 8601). Unlike other list endpoints, this is optional for webhooks. */
+    fim?: string;
+    /** @optional Pagination parameters */
+    paginacao?: PaginacaoParams;
+}
+interface ListWebhookResponse {
+    parametros: {
+        /** @required Start date used in the query */
+        inicio: string;
+        /** @required End date used in the query */
+        fim: string;
+        /** @required Pagination metadata */
+        paginacao: Paginacao;
+    };
+    /** @required List of webhook configurations */
+    webhooks: WebhookResponse[];
+}
+/**
+ * Refund/return entry within a webhook callback.
+ * Matches the devolucao structure sent by Bacen/Sicredi in webhook notifications.
+ */
+interface WebhookDevolucao {
+    /** @required Refund ID assigned by PSP */
+    id: string;
+    /** @required Return Transaction Reference ID */
+    rtrId: string;
+    /** @required Refund amount as decimal string (e.g. "10.00") */
+    valor: string;
+    /** @optional Nature of the refund (defaults to ORIGINAL when absent) */
+    natureza?: DevolucaoNatureza;
+    /** @optional Description/reason for the refund */
+    descricao?: string;
+    /** @required Timestamps for the refund */
+    horario: {
+        /** @required ISO 8601 timestamp when refund was requested */
+        solicitacao: string;
+        /** @optional ISO 8601 timestamp when refund was settled */
+        liquidacao?: string;
+    };
+    /** @required Current status of the refund */
+    status: DevolucaoStatus;
+}
+/**
+ * Single PIX payment entry within a webhook callback.
+ *
+ * NOTE: In webhook callbacks, `horario` is a plain ISO 8601 string,
+ * unlike the GET /pix response where it's an object `{ solicitacao, liquidacao? }`.
+ */
+interface WebhookPixEntry {
+    /** @required End-to-end ID (unique payment identifier from Bacen) */
+    endToEndId: string;
+    /** @optional Transaction ID (present if charge was created via cob/cobv) */
+    txid?: string;
+    /** @required PIX key that received the payment */
+    chave: string;
+    /** @required Payment amount as decimal string (e.g. "100.00") */
+    valor: string;
+    /** @required ISO 8601 timestamp of the payment */
+    horario: string;
+    /** @optional Free-text information from the payer */
+    infoPagador?: string;
+    /** @optional Payer identification (CPF or CNPJ with name) */
+    pagador?: Pagador;
+    /** @optional Breakdown of payment value (original, saque, troco) */
+    componentesValor?: ComponentesValor;
+    /** @optional List of refunds/returns associated with this payment */
+    devolucoes?: WebhookDevolucao[];
+}
+/**
+ * Webhook callback payload sent by Sicredi/Bacen.
+ *
+ * IMPORTANT: Sicredi appends '/pix' to your configured webhook URL.
+ * If you configure 'https://example.com/webhook', callbacks will be
+ * sent to 'https://example.com/webhook/pix'.
+ */
+interface WebhookCallbackPayload {
+    /** @required Array of PIX payments received */
+    pix: WebhookPixEntry[];
+}
+
+declare class WebhookResource extends BaseResource {
+    /**
+     * Configure a webhook for a PIX key.
+     * PUT /api/v2/webhook/{chave}
+     */
+    configure(chave: string, webhookUrl: string): Promise<void>;
+    /**
+     * Get webhook configuration for a PIX key.
+     * GET /api/v2/webhook/{chave}
+     */
+    get(chave: string): Promise<WebhookResponse>;
+    /**
+     * Delete webhook configuration for a PIX key.
+     * DELETE /api/v2/webhook/{chave}
+     */
+    delete(chave: string): Promise<void>;
+    /**
+     * List all webhook configurations.
+     * GET /api/v2/webhook
+     */
+    list(params: ListWebhookParams): Promise<ListWebhookResponse>;
+}
+
+declare class Sicredi {
+    readonly cob: CobResource;
+    readonly cobv: CobvResource;
+    readonly pix: PixResource;
+    readonly lotecobv: LoteCobvResource;
+    readonly loc: LocResource;
+    readonly webhook: WebhookResource;
+    private readonly _config;
+    private _initPromise;
+    private _cob;
+    private _cobv;
+    private _pix;
+    private _lotecobv;
+    private _loc;
+    private _webhook;
+    constructor(config: SicrediConfig);
+    private get baseUrl();
+    private _ensureInit;
+    private _initialize;
+}
+
+/** Raw token response from Sicredi OAuth2 endpoint */
+interface TokenResponse {
+    /** @required JWT access token */
+    access_token: string;
+    /** @required Token type (always "Bearer") */
+    token_type: string;
+    /** @required Token validity in seconds (typically 3600) */
+    expires_in: number;
+    /** @required Granted scopes (space-separated) */
+    scope: string;
+}
+/** Internal cached token representation */
+interface CachedToken {
+    /** @required JWT access token string */
+    accessToken: string;
+    /** @required Expiration timestamp in milliseconds (Date.now() based) */
+    expiresAt: number;
+    /** @required Granted scopes */
+    scope: string;
+}
+
+/** A single validation violation in a Bacen error response */
+interface Violacao {
+    /** @required Reason for the validation failure */
+    razao: string;
+    /** @required Property/field that caused the violation (dot-notation path) */
+    propriedade: string;
+}
+/**
+ * Standard error response format from Bacen PIX API.
+ * Returned by Sicredi for 4xx/5xx HTTP responses.
+ */
+interface BacenErrorResponse {
+    /** @optional Error type URI from Bacen taxonomy (e.g. "https://pix.bcb.gov.br/api/v2/error/CobOperacaoInvalida") */
+    type?: string;
+    /** @required Human-readable error title */
+    title: string;
+    /** @required HTTP status code */
+    status: number;
+    /** @optional Detailed error description */
+    detail?: string;
+    /** @optional URI identifying the specific occurrence of the problem (RFC 7807) */
+    instance?: string;
+    /** @optional List of field-level validation violations */
+    violacoes?: Violacao[];
+}
+
+declare class SicrediError extends Error {
+    readonly code: string;
+    readonly hint?: string;
+    constructor(message: string, code: string, hint?: string);
+}
+
+declare class SicrediApiError extends SicrediError {
+    readonly statusCode: number;
+    readonly type?: string;
+    readonly title: string;
+    readonly detail?: string;
+    readonly violacoes?: Violacao[];
+    constructor(statusCode: number, body: BacenErrorResponse);
+    static fromResponse(statusCode: number, body: unknown): SicrediApiError;
+}
+
+declare class SicrediAuthError extends SicrediError {
+    constructor(message: string, hint?: string);
+    static invalidCredentials(): SicrediAuthError;
+    static tokenExpired(): SicrediAuthError;
+    static insufficientScope(required: string): SicrediAuthError;
+}
+
+declare class SicrediValidationError extends SicrediError {
+    readonly field: string;
+    readonly constraint: string;
+    constructor(field: string, constraint: string, hint?: string);
+}
+
+declare class SicrediConnectionError extends SicrediError {
+    readonly cause?: Error;
+    constructor(message: string, cause?: Error, hint?: string);
+    static timeout(ms: number): SicrediConnectionError;
+    static refused(host: string): SicrediConnectionError;
+    static tlsFailure(detail: string): SicrediConnectionError;
+}
+
+declare class SicrediCertificateError extends SicrediError {
+    constructor(message: string, hint?: string);
+    static notFound(path: string): SicrediCertificateError;
+    static invalidFormat(detail: string): SicrediCertificateError;
+    static keyMismatch(): SicrediCertificateError;
+    static expired(): SicrediCertificateError;
+}
+
+declare function generateTxId(length?: number): string;
+declare function isValidTxId(txid: string): boolean;
+
+declare function isValidCpf(cpf: string): boolean;
+declare function isValidCnpj(cnpj: string): boolean;
+type PixKeyType = 'cpf' | 'cnpj' | 'email' | 'phone' | 'evp';
+declare function detectPixKeyType(key: string): PixKeyType | null;
+declare function isValidPixKey(key: string): boolean;
+declare function isValidMonetaryValue(value: string): boolean;
+
+/**
+ * Minimal QR Code generator (zero dependencies).
+ * Supports only alphanumeric mode with error correction level M.
+ * Optimized for PIX "copia e cola" strings.
+ *
+ * For production use with complex data, consider using a dedicated
+ * QR code library. This implementation covers the common PIX use case.
+ */
+/**
+ * Generate a QR Code as an SVG string from a PIX "copia e cola" payload.
+ */
+declare function generateQrCodeSvg(data: string, options?: {
+    size?: number;
+    margin?: number;
+    darkColor?: string;
+    lightColor?: string;
+}): string;
+/**
+ * Generate a QR Code as a data URL (for embedding in img tags or HTML).
+ */
+declare function generateQrCodeDataUrl(data: string, options?: {
+    size?: number;
+    margin?: number;
+    darkColor?: string;
+    lightColor?: string;
+}): string;
+
+/**
+ * Format Date to ISO 8601 string (Bacen format).
+ */
+declare function toISOString(date: Date): string;
+/**
+ * Create date range for list operations.
+ * @param startDaysAgo Number of days in the past for the start date (default: 30)
+ */
+declare function createDateRange(startDaysAgo?: number): {
+    inicio: string;
+    fim: string;
+};
+/**
+ * Parse ISO date string to Date.
+ * Throws if the string is not a valid date.
+ */
+declare function parseDate(isoString: string): Date;
+/**
+ * Format date as YYYY-MM-DD (for cobv vencimento).
+ */
+declare function formatDateOnly(date: Date): string;
+
+declare const SICREDI_URLS: {
+    readonly production: "https://api-pix.sicredi.com.br";
+    readonly sandbox: "https://api-pix-h.sicredi.com.br";
+};
+declare const SICREDI_ISPB = "01181521";
+
+interface WebhookParseResult {
+    valid: boolean;
+    payload?: WebhookCallbackPayload;
+    error?: string;
+}
+/**
+ * Parse a webhook callback body from Sicredi/Bacen.
+ * Works with both string and object inputs (for Express/Koa/Bun).
+ *
+ * IMPORTANT: Sicredi appends '/pix' to your configured webhook URL.
+ * If you configure 'https://example.com/webhook', callbacks will be
+ * sent to 'https://example.com/webhook/pix'.
+ * Make sure your server handles the '/pix' suffix route.
+ */
+declare function parseWebhookPayload(body: string | object): WebhookParseResult;
+
+export { type Abatimento, type BacenErrorResponse, type CachedToken, type Calendario, type CalendarioVencimento, type CertificateOptions, type CobResponse, type CobStatus, type CobvResponse, type CobvStatus, type ComponentesValor, type CreateCobRequest, type CreateCobvRequest, type CreateLocRequest, type Desconto, type DescontoDataFixa, type Devedor, type DevedorCnpj, type DevedorCpf, type Devolucao, type DevolucaoNatureza, type DevolucaoRequest, type DevolucaoResponse, type DevolucaoSolicitadaNatureza, type DevolucaoStatus, type InfoAdicional, type Juros, type ListCobParams, type ListCobResponse, type ListCobvParams, type ListCobvResponse, type ListLocParams, type ListLocResponse, type ListLoteCobvParams, type ListLoteCobvResponse, type ListPixParams, type ListPixResponse, type ListWebhookParams, type ListWebhookResponse, type Loc, type LocCompleta, type LocResponse, type LoteCobvCobSolicitado, type LoteCobvItemStatus, type LoteCobvPatchRequest, type LoteCobvRequest, type LoteCobvResponse, type Multa, type Pagador, type PagadorCnpj, type PagadorCpf, type Paginacao, type PaginacaoParams, type PixKeyType, type PixPayment, type PixRecebido, type Recebedor, SICREDI_ISPB, SICREDI_URLS, type SaqueTroco, Sicredi, SicrediApiError, SicrediAuthError, SicrediCertificateError, type SicrediConfig, SicrediConnectionError, SicrediError, SicrediValidationError, type TokenResponse, type UpdateCobRequest, type UpdateCobvRequest, type Valor, type ValorCobv, type ValorComDesconto, type Violacao, type WebhookCallbackPayload, type WebhookConfigRequest, type WebhookDevolucao, type WebhookParseResult, type WebhookPixEntry, type WebhookResponse, createDateRange, detectPixKeyType, formatDateOnly, generateQrCodeDataUrl, generateQrCodeSvg, generateTxId, isDevedorCnpj, isDevedorCpf, isPagadorCnpj, isPagadorCpf, isValidCnpj, isValidCpf, isValidMonetaryValue, isValidPixKey, isValidTxId, parseDate, parseWebhookPayload, toISOString };