Skip to content

Commit a07ca40

Browse files
joao-muniz-efijoao-muniz-efi
committed
Release 1.2.21
- Adicionado endpoints de pagamentos por Biometria na API Pix via Open Finance.
1 parent b09b516 commit a07ca40

File tree

8 files changed

+740
-64
lines changed

8 files changed

+740
-64
lines changed

‎dist/cjs/index.cjs

Lines changed: 150 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,6 +515,22 @@ var constants = {
515515
ofReplaceRecurrencyPixParcel: {
516516
route: '/pagamentos-recorrentes/pix/:identificadorPagamento/substituir/:endToEndId',
517517
method: 'patch'
518+
},
519+
ofCreateBiometricEnrollment: {
520+
route: '/jsr/vinculos',
521+
method: 'post'
522+
},
523+
ofListBiometricEnrollment: {
524+
route: '/jsr/vinculos',
525+
method: 'get'
526+
},
527+
ofCreateBiometricPixPayment: {
528+
route: '/jsr/pagamentos/pix',
529+
method: 'post'
530+
},
531+
ofListBiometricPixPayment: {
532+
route: '/jsr/pagamentos/pix',
533+
method: 'get'
518534
}
519535
}
520536
},
@@ -636,7 +652,7 @@ var exports$1 = {
636652
}
637653
};
638654
var description = "Module for integration with Efi Bank API";
639-
var version = "1.2.19";
655+
var version = "1.2.21";
640656
var author = "Efi Bank - Consultoria Técnica | João Vitor Oliveira | João Lucas";
641657
var license = "MIT";
642658
var repository = "efipay/sdk-node-apis-efi";
@@ -5509,6 +5525,139 @@ class OpenFinanceMethods extends PixMethods {
55095525
* }>}
55105526
*/
55115527
ofReplaceRecurrencyPixParcel(params, body) {}
5528+
5529+
/**
5530+
* **POST /v1/jsr/vinculos**
5531+
*
5532+
* Este endpoint permite a criação de um novo vínculo na jornada sem redirecionamento, possibilitando o registro de vínculos com diferentes detentoras de conta. Esses vínculos poderão ser utilizados posteriormente para a iniciação de pagamentos, promovendo maior flexibilidade no processo. O corpo da requisição deve incluir informações essenciais sobre o pagador: CPF ou CNPJ e o idParticipante da instituição detentora onde a conta do pagador está localizada.
5533+
*
5534+
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
5535+
*
5536+
* @param {{}} params
5537+
*
5538+
* @param {{
5539+
* pagador: {
5540+
* idParticipante: string
5541+
* cpf: string
5542+
* cnpj?: string
5543+
* }
5544+
* }} body
5545+
*
5546+
* @returns { Promise<{
5547+
* identificadorVinculo: string,
5548+
* redirectURI: string,
5549+
* }>}
5550+
*/
5551+
ofCreateBiometricEnrollment(params, body) {}
5552+
5553+
/**
5554+
* **GET /v1/jsr/vinculos**
5555+
*
5556+
* Esse endpoint recupera todos os vínculos associados ao usuário informado. Este endpoint permite consultar os vínculos utilizando o CPF obrigatório e, opcionalmente, o CNPJ para filtrar resultados. A resposta contém uma lista de vínculos que podem ser utilizados para operações futuras, como a iniciação de pagamentos e gestão dos mesmos.
5557+
*
5558+
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
5559+
*
5560+
* @param {{
5561+
* cpf: string,
5562+
* cnpj?: string
5563+
* }} params
5564+
* @param {{}} body
5565+
*
5566+
* @returns { Promise<{
5567+
* vinculos: Array<{
5568+
* identificador: string,
5569+
* dataAutorizacao: string,
5570+
* dataExpiracao: string,
5571+
* limiteDiario: string,
5572+
* limiteTransacao: string,
5573+
* conta: {
5574+
* numero: string,
5575+
* agencia: string,
5576+
* ispb: string,
5577+
* tipo: string
5578+
* },
5579+
* participante: {
5580+
* identificador: string,
5581+
* nome: string,
5582+
* descricao: string,
5583+
* logo: string
5584+
* }
5585+
* }>
5586+
* }>}
5587+
*/
5588+
ofListBiometricEnrollment(params, body) {}
5589+
5590+
/**
5591+
* **POST /v1/jsr/pagamentos/pix**
5592+
*
5593+
* Este endpoint permite a criação de um novo pagamento na jornada sem redirecionamento.
5594+
*
5595+
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
5596+
*
5597+
* @param {{}} params
5598+
* @param {{
5599+
* identificadorVinculo: string,
5600+
* favorecido: {
5601+
* contaBanco?: {
5602+
* nome: string,
5603+
* documento: string,
5604+
* codigoBanco: string,
5605+
* agencia: string,
5606+
* conta: string,
5607+
* tipoConta: 'CACC' | 'SVGS' | 'TRAN'
5608+
* },
5609+
* chave?: string
5610+
* },
5611+
* pagamento: {
5612+
* valor: string,
5613+
* codigoBanco?: string,
5614+
* infoPagador?: string,
5615+
* idProprio?: string,
5616+
* qrCode?: string,
5617+
* identificadorTransacao?: string,
5618+
* }
5619+
* }} body
5620+
*
5621+
* @returns { Promise<{
5622+
* identificadorPagamento: string,
5623+
* redirectURI: string,
5624+
* }>}
5625+
*/
5626+
ofCreateBiometricPixPayment(params, body) {}
5627+
5628+
/**
5629+
* **GET /v1/jsr/pagamentos/pix**
5630+
*
5631+
* O endpoint em questão é uma ferramenta de pesquisa. Ele permite que o usuário busque por um pagamento específico, por pagamentos que possuem um status especifico ou por pagamentos que atendem ou não um critério dentro de um determinado período.
5632+
*
5633+
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
5634+
*
5635+
* @param {{
5636+
* inicio: string,
5637+
* fim: string,
5638+
* status?: 'pendente' | 'rejeitado' | 'aceito' | 'expirado' | 'cancelado',
5639+
* identificador?: string
5640+
* }} params
5641+
* @param {{}} body
5642+
*
5643+
* @returns { Promise<{
5644+
* vinculos: Array<{
5645+
* identificadorPagamento: string,
5646+
* endToEndId: string,
5647+
* valor: string,
5648+
* status: 'pendente' | 'rejeitado' | 'aceito' | 'expirado',
5649+
* dataCriacao: string,
5650+
* idProprio: string,
5651+
* devolucoes?: Array<{
5652+
* identificadorDevolucao: string,
5653+
* valor: string,
5654+
* status: 'pendente' | 'rejeitado' | 'aceito',
5655+
* dataCriacao: string
5656+
* }>
5657+
* }>
5658+
* }>}
5659+
*/
5660+
ofListBiometricPixPayment(params, body) {}
55125661
}
55135662

55145663
// @ts-nocheck

‎dist/esm/index.mjs

Lines changed: 150 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -506,6 +506,22 @@ var constants = {
506506
ofReplaceRecurrencyPixParcel: {
507507
route: '/pagamentos-recorrentes/pix/:identificadorPagamento/substituir/:endToEndId',
508508
method: 'patch'
509+
},
510+
ofCreateBiometricEnrollment: {
511+
route: '/jsr/vinculos',
512+
method: 'post'
513+
},
514+
ofListBiometricEnrollment: {
515+
route: '/jsr/vinculos',
516+
method: 'get'
517+
},
518+
ofCreateBiometricPixPayment: {
519+
route: '/jsr/pagamentos/pix',
520+
method: 'post'
521+
},
522+
ofListBiometricPixPayment: {
523+
route: '/jsr/pagamentos/pix',
524+
method: 'get'
509525
}
510526
}
511527
},
@@ -627,7 +643,7 @@ var exports = {
627643
}
628644
};
629645
var description = "Module for integration with Efi Bank API";
630-
var version = "1.2.19";
646+
var version = "1.2.21";
631647
var author = "Efi Bank - Consultoria Técnica | João Vitor Oliveira | João Lucas";
632648
var license = "MIT";
633649
var repository = "efipay/sdk-node-apis-efi";
@@ -5500,6 +5516,139 @@ class OpenFinanceMethods extends PixMethods {
55005516
* }>}
55015517
*/
55025518
ofReplaceRecurrencyPixParcel(params, body) {}
5519+
5520+
/**
5521+
* **POST /v1/jsr/vinculos**
5522+
*
5523+
* Este endpoint permite a criação de um novo vínculo na jornada sem redirecionamento, possibilitando o registro de vínculos com diferentes detentoras de conta. Esses vínculos poderão ser utilizados posteriormente para a iniciação de pagamentos, promovendo maior flexibilidade no processo. O corpo da requisição deve incluir informações essenciais sobre o pagador: CPF ou CNPJ e o idParticipante da instituição detentora onde a conta do pagador está localizada.
5524+
*
5525+
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
5526+
*
5527+
* @param {{}} params
5528+
*
5529+
* @param {{
5530+
* pagador: {
5531+
* idParticipante: string
5532+
* cpf: string
5533+
* cnpj?: string
5534+
* }
5535+
* }} body
5536+
*
5537+
* @returns { Promise<{
5538+
* identificadorVinculo: string,
5539+
* redirectURI: string,
5540+
* }>}
5541+
*/
5542+
ofCreateBiometricEnrollment(params, body) {}
5543+
5544+
/**
5545+
* **GET /v1/jsr/vinculos**
5546+
*
5547+
* Esse endpoint recupera todos os vínculos associados ao usuário informado. Este endpoint permite consultar os vínculos utilizando o CPF obrigatório e, opcionalmente, o CNPJ para filtrar resultados. A resposta contém uma lista de vínculos que podem ser utilizados para operações futuras, como a iniciação de pagamentos e gestão dos mesmos.
5548+
*
5549+
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
5550+
*
5551+
* @param {{
5552+
* cpf: string,
5553+
* cnpj?: string
5554+
* }} params
5555+
* @param {{}} body
5556+
*
5557+
* @returns { Promise<{
5558+
* vinculos: Array<{
5559+
* identificador: string,
5560+
* dataAutorizacao: string,
5561+
* dataExpiracao: string,
5562+
* limiteDiario: string,
5563+
* limiteTransacao: string,
5564+
* conta: {
5565+
* numero: string,
5566+
* agencia: string,
5567+
* ispb: string,
5568+
* tipo: string
5569+
* },
5570+
* participante: {
5571+
* identificador: string,
5572+
* nome: string,
5573+
* descricao: string,
5574+
* logo: string
5575+
* }
5576+
* }>
5577+
* }>}
5578+
*/
5579+
ofListBiometricEnrollment(params, body) {}
5580+
5581+
/**
5582+
* **POST /v1/jsr/pagamentos/pix**
5583+
*
5584+
* Este endpoint permite a criação de um novo pagamento na jornada sem redirecionamento.
5585+
*
5586+
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
5587+
*
5588+
* @param {{}} params
5589+
* @param {{
5590+
* identificadorVinculo: string,
5591+
* favorecido: {
5592+
* contaBanco?: {
5593+
* nome: string,
5594+
* documento: string,
5595+
* codigoBanco: string,
5596+
* agencia: string,
5597+
* conta: string,
5598+
* tipoConta: 'CACC' | 'SVGS' | 'TRAN'
5599+
* },
5600+
* chave?: string
5601+
* },
5602+
* pagamento: {
5603+
* valor: string,
5604+
* codigoBanco?: string,
5605+
* infoPagador?: string,
5606+
* idProprio?: string,
5607+
* qrCode?: string,
5608+
* identificadorTransacao?: string,
5609+
* }
5610+
* }} body
5611+
*
5612+
* @returns { Promise<{
5613+
* identificadorPagamento: string,
5614+
* redirectURI: string,
5615+
* }>}
5616+
*/
5617+
ofCreateBiometricPixPayment(params, body) {}
5618+
5619+
/**
5620+
* **GET /v1/jsr/pagamentos/pix**
5621+
*
5622+
* O endpoint em questão é uma ferramenta de pesquisa. Ele permite que o usuário busque por um pagamento específico, por pagamentos que possuem um status especifico ou por pagamentos que atendem ou não um critério dentro de um determinado período.
5623+
*
5624+
* Para capturar uma falha utilize o `catch`, os campos disponíveis no objeto serão `nome` e `mensagem`.
5625+
*
5626+
* @param {{
5627+
* inicio: string,
5628+
* fim: string,
5629+
* status?: 'pendente' | 'rejeitado' | 'aceito' | 'expirado' | 'cancelado',
5630+
* identificador?: string
5631+
* }} params
5632+
* @param {{}} body
5633+
*
5634+
* @returns { Promise<{
5635+
* vinculos: Array<{
5636+
* identificadorPagamento: string,
5637+
* endToEndId: string,
5638+
* valor: string,
5639+
* status: 'pendente' | 'rejeitado' | 'aceito' | 'expirado',
5640+
* dataCriacao: string,
5641+
* idProprio: string,
5642+
* devolucoes?: Array<{
5643+
* identificadorDevolucao: string,
5644+
* valor: string,
5645+
* status: 'pendente' | 'rejeitado' | 'aceito',
5646+
* dataCriacao: string
5647+
* }>
5648+
* }>
5649+
* }>}
5650+
*/
5651+
ofListBiometricPixPayment(params, body) {}
55035652
}
55045653

55055654
// @ts-nocheck

0 commit comments

Comments
 (0)