sdk-node-apis-efi
Version:
Module for integration with Efi Bank API
1,327 lines • 75.1 kB
JavaScript
"use strict";
/// <reference types="node" preserve="true" />
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.PixCreateRequestRecurrenceAutomaticResponseSchema = exports.PixCreateRequestRecurrenceAutomaticBodySchema = exports.PixListRecurrenceAutomaticResponseSchema = exports.PixListRecurrenceAutomaticParamsSchema = exports.PixUpdateRecurrenceAutomaticResponseSchema = exports.PixUpdateRecurrenceAutomaticBodySchema = exports.PixUpdateRecurrenceAutomaticParamsSchema = exports.PixDetailRecurrenceAutomaticResponseSchema = exports.PixDetailRecurrenceAutomaticParamsSchema = exports.PixCreateRecurrenceAutomaticResponseSchema = exports.PixCreateRecurrenceAutomaticBodySchema = exports.PixListDueChargesResponseSchema = exports.PixListDueChargesParamsSchema = exports.PixDetailDueChargeResponseSchema = exports.PixDetailDueChargeParamsSchema = exports.PixUpdateDueChargeResponseSchema = exports.PixUpdateDueChargeBodySchema = exports.PixUpdateDueChargeParamsSchema = exports.PixCreateDueChargeResponseSchema = exports.PixCreateDueChargeBodySchema = exports.PixCreateDueChargeParamsSchema = exports.PixListChargesResponseSchema = exports.PixListChargesParamsSchema = exports.PixDetailChargeResponseSchema = exports.PixDetailChargeParamsSchema = exports.PixUpdateChargeResponseSchema = exports.PixUpdateChargeBodySchema = exports.PixUpdateChargeParamsSchema = exports.PixCreateChargeResponseSchema = exports.PixCreateChargeBodySchema = exports.PixCreateChargeParamsSchema = exports.PixCreateImmediateChargeResponseSchema = exports.PixCreateImmediateChargeBodySchema = exports.PixInfoAdicionalSchema = exports.PixRecValorSchema = exports.PixCobVValorSchema = exports.PixCobValorSchema = exports.PixCobVRecebedorSchema = exports.PixAutomaticChargeDebtorSchema = exports.PixCobVDevedorSchema = exports.PixCobDevedorSchema = exports.PixRecCalendarioSchema = exports.PixCobVCalendarioSchema = exports.PixCobCalendarioSchema = exports.StatusPixCobRSchema = exports.StatusPixSolicRecSchema = exports.StatusPixRecSchema = exports.StatusPixSendSchema = exports.StatusPixDevolutionSchema = exports.StatusPixReceivedSchema = void 0;
exports.PixCreateLocationRecurrenceAutomaticResponseSchema = exports.PixUnlinkTxidLocationResponseSchema = exports.PixUnlinkTxidLocationParamsSchema = exports.PixDetailLocationResponseSchema = exports.PixDetailLocationParamsSchema = exports.PixLocationListResponseSchema = exports.PixLocationListParamsSchema = exports.PixCreateLocationResponseSchema = exports.PixCreateLocationBodySchema = exports.PixDetailDevolutionResponseSchema = exports.PixDetailDevolutionParamsSchema = exports.PixDevolutionResponseSchema = exports.PixDevolutionBodySchema = exports.PixDevolutionParamsSchema = exports.PixListReceivedResponseSchema = exports.PixListReceivedParamsSchema = exports.PixDetailReceivedResponseSchema = exports.PixDetailReceivedParamsSchema = exports.PixQrCodePayResponseSchema = exports.PixQrCodeBodySchema = exports.PixQrCodePayParamsSchema = exports.PixQrCodeDetailResponseSchema = exports.PixQrCodeDetailBodySchema = exports.PixSendListResponseSchema = exports.PixSendListParamsSchema = exports.PixSendDetailIdResponseSchema = exports.PixSendDetailIdParamsSchema = exports.PixSendDetailResponseSchema = exports.PixSendDetailParamsSchema = exports.PixSendSameOwnershipResponseSchema = exports.PixSendSameOwnershipBodySchema = exports.PixSendSameOwnershipParamsSchema = exports.PixSendResponseSchema = exports.PixSendBodySchema = exports.PixSendParamsSchema = exports.PixCreateAutomaticChargeResponseSchema = exports.PixCreateAutomaticChargeBodySchema = exports.PixDetailAutomaticChargeResponseSchema = exports.PixDetailAutomaticChargeParamsSchema = exports.PixUpdateAutomaticChargeResponseSchema = exports.PixUpdateAutomaticChargeBodySchema = exports.PixUpdateAutomaticChargeParamsSchema = exports.PixCreateAutomaticChargeTxidResponseSchema = exports.PixCreateAutomaticChargeTxidBodySchema = exports.PixCreateAutomaticChargeTxidParamsSchema = exports.PixUpdateRequestRecurrenceAutomaticResponseSchema = exports.PixUpdateRequestRecurrenceAutomaticBodySchema = exports.PixUpdateRequestRecurrenceAutomaticParamsSchema = exports.PixDetailRequestRecurrenceAutomaticResponseSchema = exports.PixDetailRequestRecurrenceAutomaticParamsSchema = void 0;
exports.CreateReportBodySchema = exports.MedSubmitDefenseBodySchema = exports.MedSubmitDefenseParamsSchema = exports.MedListResponseSchema = exports.MedListParamsSchema = exports.PixKeysBucketResponseSchema = exports.PixGetReceiptParamsSchema = exports.ListAccountConfigResponseSchema = exports.UpdateAccountConfigBodySchema = exports.GetAccountBalanceResponseSchema = exports.GetAccountBalanceParamsSchema = exports.PixDeleteEvpParamsSchema = exports.PixListEvpResponseSchema = exports.PixCreateEvpResponseSchema = exports.PixResendWebhookBodySchema = exports.PixListWebhookAutomaticChargeResponseSchema = exports.PixConfigWebhookAutomaticChargeBodySchema = exports.PixListWebhookRecurrenceAutomaticResponseSchema = exports.PixConfigWebhookRecurrenceAutomaticBodySchema = exports.PixDeleteWebhookParamsSchema = exports.PixListWebhookResponseSchema = exports.PixListWebhookParamsSchema = exports.PixDetailWebhookResponseSchema = exports.PixDetailWebhookParamsSchema = exports.PixConfigWebhookResponseSchema = exports.PixConfigWebhookBodySchema = exports.PixConfigWebhookParamsSchema = exports.PixSplitUnlinkDueChargeParamsSchema = exports.PixSplitDetailDueChargeResponseSchema = exports.PixSplitDetailDueChargeParamsSchema = exports.PixSplitLinkDueChargeParamsSchema = exports.PixSplitUnlinkChargeParamsSchema = exports.PixSplitDetailChargeResponseSchema = exports.PixSplitDetailChargeParamsSchema = exports.PixSplitLinkChargeParamsSchema = exports.PixSplitDetailConfigResponseSchema = exports.PixSplitDetailConfigParamsSchema = exports.PixSplitConfigIdResponseSchema = exports.PixSplitConfigIdBodySchema = exports.PixSplitConfigIdParamsSchema = exports.PixSplitConfigResponseSchema = exports.PixSplitConfigBodySchema = exports.PixGenerateQRCodeResponseSchema = exports.PixGenerateQRCodeParamsSchema = exports.PixUnlinkLocationRecurrenceAutomaticResponseSchema = exports.PixUnlinkLocationRecurrenceAutomaticParamsSchema = exports.PixDetailLocationRecurrenceAutomaticResponseSchema = exports.PixDetailLocationRecurrenceAutomaticParamsSchema = exports.PixListLocationRecurrenceAutomaticResponseSchema = exports.PixListLocationRecurrenceAutomaticParamsSchema = void 0;
exports.PixSplitDevolutionResponseSchema = exports.PixSplitDevolutionBodySchema = exports.PixSplitDevolutionParamsSchema = exports.PixRetryRequestAutomaticResponseSchema = exports.PixRetryRequestAutomaticParamsSchema = exports.PixListAutomaticChargeResponseSchema = exports.PixListAutomaticChargeParamsSchema = exports.PixListDueChargeBatchResponseSchema = exports.PixListDueChargeBatchParamsSchema = exports.PixDetailDueChargeBatchResponseSchema = exports.PixDetailDueChargeBatchParamsSchema = exports.PixUpdateDueChargeBatchResponseSchema = exports.PixCreateDueChargeBatchResponseSchema = exports.PixDueChargeBatchResponseSchema = exports.PixUpdateDueChargeBatchBodySchema = exports.PixUpdateDueChargeBatchParamsSchema = exports.PixCreateDueChargeBatchBodySchema = exports.PixDueChargeBatchItemSchema = exports.PixCreateDueChargeBatchParamsSchema = exports.DetailReportResponseSchema = exports.DetailReportParamsSchema = exports.CreateReportResponseSchema = void 0;
const z = __importStar(require("zod"));
exports.StatusPixReceivedSchema = z.enum(['ATIVA', 'CONCLUIDA', 'REMOVIDA_PELO_USUARIO_RECEBEDOR', 'REMOVIDA_PELO_PSP']);
exports.StatusPixDevolutionSchema = z.enum(['EM_PROCESSAMENTO', 'DEVOLVIDO', 'NAO_REALIZADO']);
exports.StatusPixSendSchema = z.enum(['EM_PROCESSAMENTO', 'REALIZADO', 'NAO_REALIZADO']);
exports.StatusPixRecSchema = z.enum(['CRIADA', 'APROVADA', 'REJEITADA', 'EXPIRADA', 'CANCELADA']);
exports.StatusPixSolicRecSchema = z.enum(['CRIADA', 'ENVIADA', 'RECEBIDA', 'REJEITADA', 'ACEITA', 'EXPIRADA', 'CANCELADA']);
exports.StatusPixCobRSchema = z.enum(['CRIADA', 'ATIVA', 'CONCLUIDA', 'EXPIRADA', 'REJEITADA', 'CANCELADA']);
exports.PixCobCalendarioSchema = z
.object({
expiracao: z.number(),
})
.strict();
exports.PixCobVCalendarioSchema = z
.object({
dataDeVencimento: z.string(),
validadeAposVencimento: z.number().optional(),
})
.strict();
exports.PixRecCalendarioSchema = z.object({
dataFinal: z.string().optional(),
dataInicial: z.string(),
periodicidade: z.enum(['SEMANAL', 'MENSAL', 'TRIMESTRAL', 'SEMESTRAL', 'ANUAL']),
}).strict();
exports.PixCobDevedorSchema = z
.union([
z
.object({
cpf: z.string().describe('CPF do devedor (somente números)'),
nome: z.string().describe('Nome do devedor'),
})
.strict(),
z
.object({
cnpj: z.string().describe('CNPJ do devedor (somente números)'),
nome: z.string().describe('Nome do devedor'),
})
.strict(),
])
.optional();
exports.PixCobVDevedorSchema = z.union([
z
.object({
cpf: z.string(),
nome: z.string(),
email: z.email().optional(),
logradouro: z.string().optional(),
cidade: z.string().optional(),
uf: z.string().optional(),
cep: z.string().optional(),
})
.strict(),
z
.object({
cnpj: z.string(),
nome: z.string(),
email: z.email().optional(),
logradouro: z.string().optional(),
cidade: z.string().optional(),
uf: z.string().optional(),
cep: z.string().optional(),
})
.strict(),
]);
exports.PixAutomaticChargeDebtorSchema = z
.object({
email: z.email().optional(),
logradouro: z.string().max(200).optional(),
cidade: z.string().max(200).optional(),
uf: z.string().max(2).optional(),
cep: z.string().max(8).optional(),
})
.strict();
exports.PixCobVRecebedorSchema = z.union([
z
.object({
cpf: z.string(),
nome: z.string(),
email: z.email(),
logradouro: z.string(),
cidade: z.string(),
uf: z.string(),
cep: z.string(),
})
.strict(),
z
.object({
cnpj: z.string(),
nome: z.string(),
email: z.email(),
logradouro: z.string(),
cidade: z.string(),
uf: z.string(),
cep: z.string(),
nomeFantasia: z.string()
})
.strict(),
]);
exports.PixCobValorSchema = z
.object({
original: z.string(),
})
.strict();
exports.PixCobVValorSchema = z
.object({
original: z.string(),
multa: z
.object({
modalidade: z.number(),
valorPerc: z.string(),
})
.strict()
.optional(),
juros: z
.object({
modalidade: z.number(),
valorPerc: z.string(),
})
.strict()
.optional(),
abatimento: z
.object({
modalidade: z.number(),
valorPerc: z.string(),
})
.strict()
.optional(),
desconto: z
.union([
z
.object({
modalidade: z.number(),
valorPerc: z.string(),
})
.strict(),
z
.object({
modalidade: z.number(),
descontoDataFixa: z.array(z.object({
data: z.string(),
valorPerc: z.string(),
})),
})
.strict(),
])
.optional(),
})
.strict();
exports.PixRecValorSchema = z.union([
z.object({
valorRec: z.string()
}).strict(),
z.object({
valorMinimoRecebedor: z.string(),
}).strict()
]);
exports.PixInfoAdicionalSchema = z
.object({
nome: z.string(),
valor: z.string(),
})
.strict();
// -------------------------------------------
// Criar cobrança imediata (sem txid)
// -------------------------------------------
exports.PixCreateImmediateChargeBodySchema = z
.object({
calendario: exports.PixCobCalendarioSchema,
devedor: exports.PixCobDevedorSchema,
valor: exports.PixCobValorSchema,
chave: z.string(),
solicitacaoPagador: z.string().optional(),
loc: z.object({ id: z.number() }).optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
})
.strict();
exports.PixCreateImmediateChargeResponseSchema = z
.object({
calendario: exports.PixCobCalendarioSchema.extend({ criacao: z.string() }),
txid: z.string(),
revisao: z.number(),
status: exports.StatusPixReceivedSchema,
valor: exports.PixCobValorSchema,
chave: z.string(),
devedor: exports.PixCobDevedorSchema,
solicitacaoPagador: z.string().optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
loc: z.object({
id: z.number(),
location: z.string(),
tipoCob: z.literal('cob'),
criacao: z.string(),
}),
location: z.string(),
pixCopiaECola: z.string(),
})
.loose();
// -------------------------------------------
// Criar cobrança (com txid)
// -------------------------------------------
exports.PixCreateChargeParamsSchema = z
.object({
txid: z.string(),
})
.strict();
exports.PixCreateChargeBodySchema = exports.PixCreateImmediateChargeBodySchema;
exports.PixCreateChargeResponseSchema = exports.PixCreateImmediateChargeResponseSchema;
// -------------------------------------------
// Revisar cobrança
// -------------------------------------------
exports.PixUpdateChargeParamsSchema = z
.object({
txid: z.string(),
})
.strict();
exports.PixUpdateChargeBodySchema = z
.object({
calendario: exports.PixCobCalendarioSchema.optional(),
devedor: exports.PixCobDevedorSchema,
valor: exports.PixCobValorSchema.optional(),
status: exports.StatusPixReceivedSchema.optional(),
chave: z.string().optional(),
solicitacaoPagador: z.string().optional(),
loc: z.object({ id: z.number() }).optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
})
.strict();
exports.PixUpdateChargeResponseSchema = z
.object({
calendario: exports.PixCobCalendarioSchema.extend({
criacao: z.string(),
}),
txid: z.string(),
status: exports.StatusPixReceivedSchema,
revisao: z.number(),
valor: exports.PixCobValorSchema,
chave: z.string(),
devedor: exports.PixCobDevedorSchema,
solicitacaoPagador: z.string().optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
loc: z.object({
id: z.number(),
location: z.string(),
tipoCob: z.literal('cob'),
criacao: z.string(),
}),
location: z.string(),
pixCopiaECola: z.string(),
})
.loose();
// -------------------------------------------
// Consultar cobrança
// -------------------------------------------
exports.PixDetailChargeParamsSchema = z
.object({
txid: z.string(),
revisao: z.number().optional(),
})
.strict();
exports.PixDetailChargeResponseSchema = z
.object({
calendario: exports.PixCobCalendarioSchema.extend({
criacao: z.string(),
}),
txid: z.string(),
revisao: z.number(),
status: exports.StatusPixReceivedSchema,
valor: exports.PixCobValorSchema,
chave: z.string(),
devedor: exports.PixCobDevedorSchema,
solicitacaoPagador: z.string().optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
loc: z.object({
id: z.number(),
location: z.string(),
tipoCob: z.literal('cob'),
criacao: z.string(),
}),
location: z.string(),
pixCopiaECola: z.string().optional(),
pix: z
.array(z
.object({
endToEndId: z.string(),
txid: z.string(),
valor: z.string(),
horario: z.string(),
infoPagador: z.string().optional(),
devolucoes: z
.array(z
.object({
id: z.string(),
rtrId: z.string(),
valor: z.string(),
horario: z.object({
solicitacao: z.string(),
}),
status: exports.StatusPixDevolutionSchema,
})
.strict())
.optional(),
})
.strict())
.optional(),
})
.loose();
// -------------------------------------------
// Consultar lista de cobranças
// -------------------------------------------
exports.PixListChargesParamsSchema = z
.object({
inicio: z.string(),
fim: z.string(),
cpf: z.string().optional(),
cnpj: z.string().optional(),
status: exports.StatusPixReceivedSchema.optional(),
'paginacao.paginaAtual': z.number().optional(),
'paginacao.itensPorPagina': z.number().optional(),
})
.strict();
exports.PixListChargesResponseSchema = z
.object({
parametros: z
.object({
inicio: z.string(),
fim: z.string(),
paginacao: z
.object({
paginaAtual: z.number(),
itensPorPagina: z.number(),
quantidadeDePaginas: z.number(),
quantidadeTotalDeItens: z.number(),
})
.strict(),
cpf: z.string().optional(),
cnpj: z.string().optional(),
status: exports.StatusPixReceivedSchema.optional(),
})
.strict(),
cobs: z.array(z
.object({
calendario: exports.PixCobCalendarioSchema.extend({
criacao: z.string(),
}),
txid: z.string(),
revisao: z.number(),
status: exports.StatusPixReceivedSchema,
valor: exports.PixCobValorSchema,
chave: z.string(),
devedor: exports.PixCobDevedorSchema,
solicitacaoPagador: z.string().optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
loc: z.object({
id: z.number(),
location: z.string(),
tipoCob: z.literal('cob'),
criacao: z.string(),
}),
location: z.string(),
pixCopiaECola: z.string().optional(),
pix: z
.array(z
.object({
endToEndId: z.string(),
txid: z.string(),
valor: z.string(),
chave: z.string(),
horario: z.string(),
infoPagador: z.string().optional(),
devolucoes: z
.array(z
.object({
id: z.string(),
rtrId: z.string(),
valor: z.string(),
horario: z.object({
solicitacao: z.string(),
liquidacao: z.string().optional(),
}),
status: exports.StatusPixDevolutionSchema,
})
.strict())
.optional(),
})
.strict())
.optional(),
})
.strict()),
})
.loose();
// -------------------------------------------
// Criar cobrança com vencimento
// -------------------------------------------
exports.PixCreateDueChargeParamsSchema = z
.object({
txid: z.string(),
})
.strict();
exports.PixCreateDueChargeBodySchema = z
.object({
calendario: exports.PixCobVCalendarioSchema,
devedor: exports.PixCobVDevedorSchema,
valor: exports.PixCobVValorSchema,
chave: z.string(),
solicitacaoPagador: z.string().optional(),
loc: z.object({ id: z.number() }).optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
})
.strict();
exports.PixCreateDueChargeResponseSchema = z
.object({
calendario: exports.PixCobVCalendarioSchema.extend({
criacao: z.string(),
validadeAposVencimento: z.number()
}),
txid: z.string(),
revisao: z.number(),
status: exports.StatusPixReceivedSchema,
devedor: exports.PixCobVDevedorSchema,
recebedor: exports.PixCobVRecebedorSchema,
valor: exports.PixCobVValorSchema,
chave: z.string(),
solicitacaoPagador: z.string().optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
loc: z.object({
id: z.number(),
location: z.string(),
tipoCob: z.literal('cobv'),
criacao: z.string(),
}),
pixCopiaECola: z.string(),
})
.loose();
// -------------------------------------------
// Revisar cobrança com vencimento
// -------------------------------------------
exports.PixUpdateDueChargeParamsSchema = z
.object({
txid: z.string(),
})
.strict();
exports.PixUpdateDueChargeBodySchema = z
.object({
calendario: exports.PixCobVCalendarioSchema.partial().strict().optional(),
devedor: z
.object({
cpf: z.string().optional(),
cnpj: z.string().optional(),
nome: z.string().optional(),
email: z.email().optional(),
logradouro: z.string().optional(),
cidade: z.string().optional(),
uf: z.string().optional(),
cep: z.string().optional(),
})
.strict()
.optional(),
valor: z
.object({
original: z.string().optional(),
multa: z.object({ modalidade: z.number().optional(), valorPerc: z.string().optional() }).strict().optional(),
juros: z.object({ modalidade: z.number().optional(), valorPerc: z.string().optional() }).strict().optional(),
abatimento: z.object({ modalidade: z.number().optional(), valorPerc: z.string().optional() }).strict().optional(),
desconto: z
.object({
modalidade: z.number().optional(),
valorPerc: z.string().optional(),
descontoDataFixa: z
.array(z.object({ data: z.string().optional(), valorPerc: z.string().optional() }).strict())
.optional(),
})
.strict()
.optional(),
})
.strict()
.optional(),
status: exports.StatusPixReceivedSchema.optional(),
chave: z.string().optional(),
solicitacaoPagador: z.string().optional(),
loc: z.object({ id: z.number() }).optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
})
.strict();
exports.PixUpdateDueChargeResponseSchema = z
.object({
calendario: exports.PixCobVCalendarioSchema.extend({
criacao: z.string(),
validadeAposVencimento: z.number()
}).strict(),
txid: z.string(),
revisao: z.number(),
status: exports.StatusPixReceivedSchema,
devedor: exports.PixCobVDevedorSchema,
recebedor: exports.PixCobVRecebedorSchema,
valor: exports.PixCobVValorSchema,
chave: z.string(),
solicitacaoPagador: z.string().optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
loc: z.object({
id: z.number(),
location: z.string(),
tipoCob: z.literal('cobv'),
criacao: z.string(),
}).strict(),
pixCopiaECola: z.string(),
})
.loose();
// -------------------------------------------
// Consultar cobrança com vencimento
// -------------------------------------------
exports.PixDetailDueChargeParamsSchema = exports.PixDetailChargeParamsSchema;
exports.PixDetailDueChargeResponseSchema = z
.object({
calendario: exports.PixCobVCalendarioSchema.extend({
criacao: z.string(),
validadeAposVencimento: z.number()
}).strict(),
txid: z.string(),
revisao: z.number(),
loc: z.object({
id: z.number(),
location: z.string(),
tipoCob: z.literal('cobv')
}).strict(),
status: exports.StatusPixReceivedSchema,
devedor: exports.PixCobVDevedorSchema,
recebedor: exports.PixCobVDevedorSchema,
valor: exports.PixCobVValorSchema,
chave: z.string(),
solicitacaoPagador: z.string().optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
pixCopiaECola: z.string().optional(),
pix: z
.array(z
.object({
endToEndId: z.string(),
txid: z.string(),
valor: z.string(),
chave: z.string(),
horario: z.string(),
infoPagador: z.string().optional(),
devolucoes: z
.array(z
.object({
id: z.string(),
rtrId: z.string(),
valor: z.string(),
horario: z.object({
solicitacao: z.string(),
liquidacao: z.string().optional(),
}),
status: exports.StatusPixDevolutionSchema,
})
.strict())
.optional(),
})
.strict())
.optional(),
})
.loose();
// -------------------------------------------
// Consultar lista de cobranças com vencimento
// -------------------------------------------
exports.PixListDueChargesParamsSchema = z
.object({
inicio: z.string(),
fim: z.string(),
cpf: z.string().optional(),
cnpj: z.string().optional(),
locationPresente: z.boolean().optional(),
status: exports.StatusPixReceivedSchema.optional(),
loteCobVId: z.string().optional(),
'paginacao.paginaAtual': z.number().optional(),
'paginacao.itensPorPagina': z.number().optional(),
})
.strict();
exports.PixListDueChargesResponseSchema = z
.object({
parametros: z
.object({
inicio: z.string(),
fim: z.string(),
paginacao: z
.object({
paginaAtual: z.number(),
itensPorPagina: z.number(),
quantidadeDePaginas: z.number(),
quantidadeTotalDeItens: z.number(),
})
.strict(),
cpf: z.string().optional(),
cnpj: z.string().optional(),
locationPresente: z.boolean().optional(),
status: exports.StatusPixReceivedSchema.optional(),
loteCobVId: z.string().optional(),
})
.strict(),
cobs: z.array(z
.object({
calendario: exports.PixCobVCalendarioSchema.extend({
criacao: z.string(),
validadeAposVencimento: z.number()
}),
txid: z.string(),
revisao: z.number(),
status: exports.StatusPixReceivedSchema,
devedor: exports.PixCobVDevedorSchema,
recebedor: exports.PixCobVRecebedorSchema,
valor: exports.PixCobVValorSchema,
chave: z.string(),
solicitacaoPagador: z.string().optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
loc: z.object({
id: z.number(),
location: z.string(),
tipoCob: z.literal('cobv'),
criacao: z.string(),
}),
pixCopiaECola: z.string().optional(),
pix: z
.array(z
.object({
endToEndId: z.string(),
txid: z.string(),
valor: z.string(),
chave: z.string(),
horario: z.string(),
infoPagador: z.string().optional(),
devolucoes: z
.array(z
.object({
id: z.string(),
rtrId: z.string(),
valor: z.string(),
horario: z.object({
solicitacao: z.string(),
liquidacao: z.string().optional(),
}),
status: exports.StatusPixDevolutionSchema,
})
.strict())
.optional(),
})
.strict())
.optional(),
})
.strict()),
})
.loose();
// -------------------------------------------
// Criar recorrência de Pix Automático
// -------------------------------------------
exports.PixCreateRecurrenceAutomaticBodySchema = z.object({
vinculo: z.object({
contrato: z.string(),
devedor: exports.PixCobDevedorSchema.nonoptional(),
objeto: z.string().optional()
}).strict(),
calendario: exports.PixRecCalendarioSchema,
valor: exports.PixRecValorSchema,
politicaRetentativa: z.enum(['NAO_PERMITE', 'PERMITE_3R_7D']),
loc: z.number().optional(),
ativacao: z.object({
dadosJornada: z.object({
txid: z.string(),
}).strict()
}).strict().optional(),
}).strict();
exports.PixCreateRecurrenceAutomaticResponseSchema = z.object({
idRec: z.string(),
status: exports.StatusPixRecSchema,
valor: exports.PixRecValorSchema,
vinculo: z.object({
contrato: z.string(),
devedor: exports.PixCobDevedorSchema.nonoptional(),
objeto: z.string().optional()
}).strict(),
calendario: exports.PixRecCalendarioSchema,
politicaRetentativa: z.enum(['NAO_PERMITE', 'PERMITE_3R_7D']),
recebedor: z.object({
cnpj: z.string(),
nome: z.string(),
}).strict(),
loc: z.object({
criacao: z.string(),
id: z.number(),
location: z.string(),
idRec: z.string(),
}).strict(),
ativacao: z.object({
tipoJornada: z.string(),
dadosJornada: z.object({
txid: z.string(),
}).strict().optional()
}).strict(),
atualizacao: z.array(z.object({
status: exports.StatusPixRecSchema,
data: z.string(),
}).strict())
}).loose();
// -------------------------------------------
// Consultar recorrência de Pix Automático
// -------------------------------------------
exports.PixDetailRecurrenceAutomaticParamsSchema = z.object({
idRec: z.string(),
}).strict();
exports.PixDetailRecurrenceAutomaticResponseSchema = exports.PixCreateRecurrenceAutomaticResponseSchema.extend({
pagador: z.union([
z.object({
codMun: z.string(),
cpf: z.string(),
ispbParticipante: z.string(),
}).strict(),
z.object({
codMun: z.string(),
cnpj: z.string(),
ispbParticipante: z.string(),
}).strict()
]).optional(),
dadosQR: z.object({
jornada: z.string(),
pixCopiaECola: z.string(),
}).strict(),
}).loose();
// -------------------------------------------
// Revisar recorrência de Pix Automático
// -------------------------------------------
exports.PixUpdateRecurrenceAutomaticParamsSchema = exports.PixDetailRecurrenceAutomaticParamsSchema;
exports.PixUpdateRecurrenceAutomaticBodySchema = z.object({
loc: z.number().optional(),
status: z.literal('CANCELADA').optional(),
vinculo: z.object({
devedor: z.object({
nome: z.string()
}).strict()
}).strict().optional(),
calendario: z.object({
dataInicial: z.string()
}).strict().optional(),
ativacao: z.object({
dadosJornada: z.object({
txid: z.string(),
}).strict()
}).strict().optional(),
}).strict();
exports.PixUpdateRecurrenceAutomaticResponseSchema = exports.PixCreateRecurrenceAutomaticResponseSchema;
// -------------------------------------------
// Consultar lista de recorrências de Pix Automático
// -------------------------------------------
exports.PixListRecurrenceAutomaticParamsSchema = z.object({
inicio: z.string(),
fim: z.string(),
cpf: z.string().optional(),
cnpj: z.string().optional(),
locationPresente: z.boolean().optional(),
status: exports.StatusPixRecSchema.optional(),
convenio: z.string().optional(),
'paginacao.paginaAtual': z.number().optional(),
'paginacao.itensPorPagina': z.number().optional(),
}).strict();
exports.PixListRecurrenceAutomaticResponseSchema = z.object({
parametros: z.object({
inicio: z.string(),
fim: z.string(),
paginacao: z.object({
paginaAtual: z.number(),
itensPorPagina: z.number(),
quantidadeDePaginas: z.number(),
quantidadeTotalDeItens: z.number(),
}).strict(),
cpf: z.string().optional(),
cnpj: z.string().optional(),
locationPresente: z.boolean().optional(),
status: exports.StatusPixRecSchema.optional(),
convenio: z.string().optional(),
}).strict(),
recs: z.array(exports.PixDetailRecurrenceAutomaticResponseSchema)
}).loose();
// -------------------------------------------
// Criar solicitação de confirmação de recorrência de Pix Automático
// -------------------------------------------
exports.PixCreateRequestRecurrenceAutomaticBodySchema = z.object({
idRec: z.string(),
calendario: z.object({
dataExpiracaoSolicitacao: z.string(),
}).strict(),
destinatario: z.union([
z.object({
agencia: z.string(),
conta: z.string(),
cpf: z.string(),
ispbParticipante: z.string(),
}).strict(),
z.object({
agencia: z.string(),
conta: z.string(),
cnpj: z.string(),
ispbParticipante: z.string(),
}).strict(),
]),
}).strict();
exports.PixCreateRequestRecurrenceAutomaticResponseSchema = z.object({
idSolicRec: z.string(),
idRec: z.string(),
calendario: z.object({
dataExpiracaoSolicitacao: z.string(),
}).strict(),
status: exports.StatusPixSolicRecSchema,
destinatario: z.union([
z.object({
agencia: z.string(),
conta: z.string(),
cpf: z.string(),
ispbParticipante: z.string(),
}).strict(),
z.object({
agencia: z.string(),
conta: z.string(),
cnpj: z.string(),
ispbParticipante: z.string(),
}).strict(),
]),
atualizacao: z.array(z.object({
data: z.string(),
status: exports.StatusPixSolicRecSchema,
}).strict()),
recPayload: exports.PixCreateRecurrenceAutomaticResponseSchema
}).loose();
// -------------------------------------------
// Consultar solicitação de confirmação de recorrência de Pix Automático
// -------------------------------------------
exports.PixDetailRequestRecurrenceAutomaticParamsSchema = z.object({
idSolicRec: z.string(),
}).strict();
exports.PixDetailRequestRecurrenceAutomaticResponseSchema = exports.PixCreateRequestRecurrenceAutomaticResponseSchema;
// -------------------------------------------
// Revisar solicitação de confirmação de recorrência de Pix Automático
// -------------------------------------------
exports.PixUpdateRequestRecurrenceAutomaticParamsSchema = exports.PixDetailRequestRecurrenceAutomaticParamsSchema;
exports.PixUpdateRequestRecurrenceAutomaticBodySchema = z.object({
status: z.literal('CANCELADA'),
}).strict();
exports.PixUpdateRequestRecurrenceAutomaticResponseSchema = exports.PixCreateRequestRecurrenceAutomaticResponseSchema;
// -------------------------------------------
// Criar cobrança de Pix Automático (com txid)
// -------------------------------------------
exports.PixCreateAutomaticChargeTxidParamsSchema = z.object({
txid: z.string(),
}).strict();
exports.PixCreateAutomaticChargeTxidBodySchema = z.object({
idRec: z.string(),
infoAdicional: z.string().optional(),
calendario: z.object({
dataDeVencimento: z.string(),
}).strict(),
valor: exports.PixCobValorSchema,
ajusteDiaUtil: z.boolean(),
devedor: exports.PixAutomaticChargeDebtorSchema.optional(),
recebedor: z.object({
conta: z.string(),
tipoConta: z.enum(['CORRENTE', 'POUPANCA', 'PAGAMENTO']),
agencia: z.string(),
}).strict()
}).strict();
exports.PixCreateAutomaticChargeTxidResponseSchema = z.object({
idRec: z.string(),
txid: z.string(),
infoAdicional: z.string().optional(),
calendario: z.object({
criacao: z.string(),
dataDeVencimento: z.string(),
}).strict(),
valor: exports.PixCobValorSchema,
status: exports.StatusPixCobRSchema,
politicaRetentativa: z.enum(['NAO_PERMITE', 'PERMITE_3R_7D']),
ajusteDiaUtil: z.boolean(),
devedor: exports.PixAutomaticChargeDebtorSchema.optional(),
recebedor: z.object({
conta: z.string(),
tipoConta: z.enum(['CORRENTE', 'POUPANCA', 'PAGAMENTO']),
agencia: z.string(),
cnpj: z.string(),
nome: z.string(),
}).strict(),
atualizacao: z.array(z.object({
data: z.string(),
status: exports.StatusPixCobRSchema,
}).strict())
}).loose();
// -------------------------------------------
// Revisar cobrança de Pix Automático
// -------------------------------------------
exports.PixUpdateAutomaticChargeParamsSchema = exports.PixCreateAutomaticChargeTxidParamsSchema;
exports.PixUpdateAutomaticChargeBodySchema = z.object({
status: z.literal('CANCELADA')
}).strict();
exports.PixUpdateAutomaticChargeResponseSchema = exports.PixCreateAutomaticChargeTxidResponseSchema;
// -------------------------------------------
// Consultar cobrança de Pix Automático
// -------------------------------------------
exports.PixDetailAutomaticChargeParamsSchema = exports.PixCreateAutomaticChargeTxidParamsSchema;
exports.PixDetailAutomaticChargeResponseSchema = exports.PixCreateAutomaticChargeTxidResponseSchema.extend({
pix: z.array(z.object({
endToEndId: z.string(),
txid: z.string(),
valor: z.string(),
horario: z.string(),
devolucoes: z.array(z.object({
id: z.string(),
rtrId: z.string(),
valor: z.string(),
horario: z.object({
solicitacao: z.string(),
liquidacao: z.string().optional(),
}),
status: exports.StatusPixDevolutionSchema,
})
.strict())
.optional(),
}).strict()).optional(),
tentativas: z.array(z.object({
dataLiquidacao: z.string(),
tipo: z.string(),
status: z.string(),
endToEndId: z.string(),
atualizacao: z.array(z.object({
data: z.string(),
status: z.string(),
}).strict())
}).strict()).optional(),
encerramento: z
.object({
cancelamento: z
.object({
solicitante: z.string(),
codigo: z.string(),
descricao: z.string(),
})
.loose(),
})
.loose()
.optional(),
}).loose();
// -------------------------------------------
// Criar cobrança de Pix Automático (sem txid)
// -------------------------------------------
exports.PixCreateAutomaticChargeBodySchema = exports.PixCreateAutomaticChargeTxidBodySchema;
exports.PixCreateAutomaticChargeResponseSchema = exports.PixCreateAutomaticChargeTxidResponseSchema;
// -------------------------------------------
// Consultar lista de cobranças de Pix Automático
// -------------------------------------------
// -------------------------------------------
// Requisitar envio de Pix
// -------------------------------------------
exports.PixSendParamsSchema = z
.object({
idEnvio: z.string(),
})
.strict();
exports.PixSendBodySchema = z.object({
valor: z.string(),
pagador: z.object({
chave: z.string(),
infoPagador: z.string().optional(),
}).strict(),
favorecido: z.union([
z.object({
chave: z.string(),
cpf: z.string().optional(),
}).strict(),
z.object({
chave: z.string(),
cnpj: z.string().optional(),
}).strict(),
z.object({
contaBanco: z.object({
nome: z.string(),
cpf: z.string(),
codigoBanco: z.string(),
agencia: z.string(),
conta: z.string(),
tipoConta: z.enum(['cacc', 'svgs'])
})
}).strict(),
z.object({
contaBanco: z.object({
nome: z.string(),
cnpj: z.string(),
codigoBanco: z.string(),
agencia: z.string(),
conta: z.string(),
tipoConta: z.enum(['cacc', 'svgs'])
})
}).strict(),
])
});
exports.PixSendResponseSchema = z
.object({
endToEndId: z.string(),
idEnvio: z.string(),
valor: z.string(),
horario: z.object({
solicitacao: z.string()
}),
status: z.literal('EM_PROCESSAMENTO')
})
.loose();
// -------------------------------------------
// Requisitar envio de Pix para contas de mesma titularidade
// -------------------------------------------
exports.PixSendSameOwnershipParamsSchema = exports.PixSendParamsSchema;
exports.PixSendSameOwnershipBodySchema = exports.PixSendBodySchema;
exports.PixSendSameOwnershipResponseSchema = exports.PixSendResponseSchema;
// -------------------------------------------
// Consultar Pix enviado através do endToEndId
// -------------------------------------------
exports.PixSendDetailParamsSchema = z
.object({
e2eId: z.string(),
})
.strict();
exports.PixSendDetailResponseSchema = z.object({
endToEndId: z.string(),
idEnvio: z.string(),
valor: z.string(),
chave: z.string(),
status: exports.StatusPixSendSchema,
infoPagador: z.string().optional(),
horario: z.object({
solicitacao: z.string(),
liquidacao: z.string().optional(),
}),
favorecido: z.union([
z.object({
chave: z.string(),
}).strict(),
z.object({
contaBanco: z.object({
nome: z.string(),
cpf: z.string(),
agencia: z.string(),
conta: z.string(),
tipoConta: z.enum(['cacc', 'svgs'])
})
}).strict(),
z.object({
contaBanco: z.object({
nome: z.string(),
cnpj: z.string(),
agencia: z.string(),
conta: z.string(),
tipoConta: z.enum(['cacc', 'svgs'])
})
}).strict(),
]),
devolucoes: z.array(z.object({
rtrId: z.string(),
valor: z.string(),
horario: z.string()
}).strict()).optional(),
}).loose();
// -------------------------------------------
// Consultar Pix enviado através do Identificador da transação
// -------------------------------------------
exports.PixSendDetailIdParamsSchema = z
.object({
idEnvio: z.string(),
})
.strict();
exports.PixSendDetailIdResponseSchema = exports.PixSendDetailResponseSchema;
// -------------------------------------------
// Consultar lista de Pix enviados
// -------------------------------------------
exports.PixSendListParamsSchema = z.object({
inicio: z.string(),
fim: z.string(),
status: exports.StatusPixSendSchema.optional(),
exibirCodigoBanco: z.boolean().optional(),
cpf: z.string().optional(),
cnpj: z.string().optional(),
'paginacao.paginaAtual': z.number().optional(),
'paginacao.itensPorPagina': z.number().optional(),
}).strict();
exports.PixSendListResponseSchema = z
.object({
parametros: z
.object({
inicio: z.string(),
fim: z.string(),
paginacao: z
.object({
paginaAtual: z.number(),
itensPorPagina: z.number(),
quantidadeDePaginas: z.number(),
quantidadeTotalDeItens: z.number(),
}),
status: exports.StatusPixSendSchema.optional(),
exibirCodigoBanco: z.boolean().optional(),
cpf: z.string().optional(),
cnpj: z.string().optional(),
})
.strict(),
pix: z.array(exports.PixSendDetailResponseSchema)
}).loose();
// -------------------------------------------
// Detalhar QR Code Pix
// -------------------------------------------
exports.PixQrCodeDetailBodySchema = z
.object({
pixCopiaECola: z.string(),
})
.strict();
const PixQrCodeDetailCommonShape = {
txid: z.string(),
revisao: z.number(),
status: exports.StatusPixReceivedSchema,
devedor: z.union([
z.object({ cpf: z.string(), nome: z.string() }).loose(),
z.object({ cnpj: z.string(), nome: z.string() }).loose(),
]).optional(),
recebedor: z.union([
z.object({ cpf: z.string(), nome: z.string() }).loose(),
z.object({ cnpj: z.string(), nome: z.string() }).loose(),
z
.object({
logradouro: z.string(),
cidade: z.string(),
uf: z.string(),
cep: z.string(),
nome: z.string(),
cnpj: z.string(),
})
.loose(),
z
.object({
logradouro: z.string(),
cidade: z.string(),
uf: z.string(),
cep: z.string(),
nome: z.string(),
cpf: z.string(),
})
.loose(),
]).optional(),
chave: z.string(),
solicitacaoPagador: z.string().optional(),
infoAdicionais: z.array(exports.PixInfoAdicionalSchema).optional(),
};
exports.PixQrCodeDetailResponseSchema = z.discriminatedUnion('tipoCob', [
z
.object({
...PixQrCodeDetailCommonShape,
tipoCob: z.literal('cob'),
calendario: z
.object({
criacao: z.string(),
apresentacao: z.string(),
expiracao: z.number(),
})
.loose(),
valor: exports.PixCobValorSchema,
})
.loose(),
z
.object({
...PixQrCodeDetailCommonShape,
tipoCob: z.literal('cobv'),
calendario: z
.object({
criacao: z.string(),
apresentacao: z.string(),
dataDeVencimento: z.string(),
validadeAposVencimento: z.number(),
})
.loose(),
valor: exports.PixCobVValorSchema,
})
.loose(),
]);
// -------------------------------------------
// Pagar QR Code Pix
// -------------------------------------------
exports.PixQrCodePayParamsSchema = z
.object({
idEnvio: z.string(),
})
.strict();
exports.PixQrCodeBodySchema = z.object({
pagador: z.object({
chave: z.string(),
infoPagador: z.string().optional(),
}).strict(),
pixCopiaECola: z.string(),
});
exports.PixQrCodePayResponseSchema = exports.PixSendResponseSchema;
// -------------------------------------------
// Consultar Pix
// -------------------------------------------
exports.PixDetailReceivedParamsSchema = z
.object({
e2eId: z.string(),
exibirCodigoBanco: z.boolean().optional(),
})
.strict();
exports.PixDetailReceivedResponseSchema = z.object({
endToEndId: z.string(),
txid: z.string().optional(),
valor: z.string(),
chave: z.string(),
horario: z.string(),
pagador: z.object({
contaBanco: z.object({
codigoBanco: z.string(),
})
}).strict().optional(),
devolucoes: z.array(z.object({
id: z.string(),
rtrId: z.string(),
valor: z.string(),
horario: z.object({
solicitacao: z.string(),
liquidacao: z.string().optional()
}),
status: exports.StatusPixDevolutionSchema,
}).strict()).optional(),
infoPagador: z.string().optional(),
}).loose();
// -------------------------------------------
// Consultar Pix recebidos
// -------------------------------------------
exports.PixListReceivedParamsSchema = z.object({
inicio: z.string(),
fim: z.string(),
txid: z.string().optional(),
txIdPresente: z.boolean().optional(),
devolucaoPresente: z.boolean().optional(),
cpf: z.string().optional(),
cnpj: z.string().optional(),
'paginacao.paginaAtual': z.number().optional(),
'paginacao.itensPorPagina': z.number().optional(),
exibirCodigoBanco: z.boolean().optional(),
}).strict();
exports.PixListReceivedResponseSchema = z
.object({
parametros: z
.object({
inicio: z.string(),
fim: z.string(),
paginacao: z
.object({
paginaAtual: z.number(),
itensPorPagina: z.number(),
quantidadeDePaginas: z.number(),
quantidadeTotalDeItens: z.number(),
})
.strict(),
txid: z.string().optional(),
txIdPresente: z.boolean().optional(),
devolucaoPresente: z.boolean().optional(),
cpf: z.string().optional(),
cnpj: z.string().optional(),
exibirCodigoBanco: z.boolean().optional(),
})
.strict(),
pix: z.array(exports.PixDetailReceivedResponseSchema),
})
.loose();
// -------------------------------------------
// Solicitar devolução
// -------------------------------------------
exports.PixDevolutionParamsSchema = z
.object({
e2eId: z.string(),
id: z.string(),
})
.strict();
exports.PixDevolutionBodySchema = z
.object({
valor: z.string(),
})
.strict();
exports.PixDevolutionResponseSchema = z
.object({
id: z.string(),
rtrId: z.string(),
valor: z.string(),
horario: z.object({
solicitacao: z.string(),