@movelabs/pix-sicoob
Version:
Cliente PIX para integração com API do Sicoob - Sistema de Cobranças e Pagamentos Instantâneos
61 lines • 1.88 kB
TypeScript
import { CobPayload, CobResponse, ListPixQuery, ListPixResponse, SicoobAuthConfig } from "./types";
/**
* Cliente PIX para integração com API do Sicoob
*
* @example
* ```typescript
* import { SicoobPixClient } from '@movelabs/pix-sicoob';
* import fs from 'fs';
*
* const client = new SicoobPixClient({
* clientId: 'seu-client-id',
* pfxBuffer: fs.readFileSync('certificado.pfx'),
* pfxPassword: 'senha-do-certificado',
* scope: 'cob.write cob.read webhook.read webhook.write',
* debug: true
* });
*
* // Criar cobrança PIX
* const cobranca = await client.createPixCob({
* calendario: { expiracao: 3600 },
* valor: { original: '10.50' },
* chave: 'sua-chave-pix@email.com',
* solicitacaoPagador: 'Pagamento do pedido #123'
* });
* ```
*/
export declare class SicoobPixClient {
private axiosInstanceAuth;
private axiosInstancePix;
private config;
private authResponse?;
private tokenExpiresAt?;
private debug;
private logger?;
constructor(config: SicoobAuthConfig);
private log;
getAccessToken(): Promise<string>;
isTokenValid(): boolean;
getTokenInfo(): {
token_type: string;
scope: string;
expires_in: number;
expiresAt: Date;
isValid: boolean;
} | null;
private getAuthHeaders;
getWebhook(chave: string): Promise<{
webhookUrl: string;
chave: string;
criacao: string;
}>;
setWebhook(chave: string, webhookUrl: string): Promise<void>;
deleteWebhook(chave: string): Promise<void>;
createPixCob(data: CobPayload): Promise<CobResponse>;
getPixCob(txid: string): Promise<CobResponse>;
getPixCobImagem(txid: string): Promise<Blob>;
listPix(query: ListPixQuery): Promise<ListPixResponse>;
}
export * from "./types";
export { SicoobPixClient as default };
//# sourceMappingURL=index.d.ts.map