sdk-node-apis-efi

export declare const endpoints: { readonly APIS: { readonly DEFAULT: { readonly URL: { readonly PRODUCTION: "https://cobrancas.api.efipay.com.br"; readonly SANDBOX: "https://cobrancas-h.api.efipay.com.br"; }; readonly ENDPOINTS: { readonly authorize: { readonly route: "/v1/authorize"; readonly method: "post"; }; readonly sendSubscriptionLinkEmail: { readonly route: "/v1/charge/:id/subscription/resend"; readonly method: "post"; }; readonly settleCarnet: { readonly route: "/v1/carnet/:id/settle"; readonly method: "put"; }; readonly sendLinkEmail: { readonly route: "/v1/charge/:id/link/resend"; readonly method: "post"; }; readonly createOneStepLink: { readonly route: "/v1/charge/one-step/link"; readonly method: "post"; }; readonly createCharge: { readonly route: "/v1/charge"; readonly method: "post"; }; readonly detailCharge: { readonly route: "/v1/charge/:id"; readonly method: "get"; }; readonly updateChargeMetadata: { readonly route: "/v1/charge/:id/metadata"; readonly method: "put"; }; readonly updateBillet: { readonly route: "/v1/charge/:id/billet"; readonly method: "put"; }; readonly definePayMethod: { readonly route: "/v1/charge/:id/pay"; readonly method: "post"; }; readonly cancelCharge: { readonly route: "/v1/charge/:id/cancel"; readonly method: "put"; }; readonly createCarnet: { readonly route: "/v1/carnet"; readonly method: "post"; }; readonly detailCarnet: { readonly route: "/v1/carnet/:id"; readonly method: "get"; }; readonly updateCarnetParcel: { readonly route: "/v1/carnet/:id/parcel/:parcel"; readonly method: "put"; }; readonly updateCarnetParcels: { readonly route: "/v1/carnet/:id/parcels"; readonly method: "put"; }; readonly updateCarnetMetadata: { readonly route: "/v1/carnet/:id/metadata"; readonly method: "put"; }; readonly getNotification: { readonly route: "/v1/notification/:token"; readonly method: "get"; }; readonly listPlans: { readonly route: "/v1/plans"; readonly method: "get"; }; readonly createPlan: { readonly route: "/v1/plan"; readonly method: "post"; }; readonly deletePlan: { readonly route: "/v1/plan/:id"; readonly method: "delete"; }; readonly createSubscription: { readonly route: "/v1/plan/:id/subscription"; readonly method: "post"; }; readonly createOneStepSubscription: { readonly route: "/v1/plan/:id/subscription/one-step"; readonly method: "post"; }; readonly createOneStepSubscriptionLink: { readonly route: "/v1/plan/:id/subscription/one-step/link"; readonly method: "post"; }; readonly detailSubscription: { readonly route: "/v1/subscription/:id"; readonly method: "get"; }; readonly defineSubscriptionPayMethod: { readonly route: "/v1/subscription/:id/pay"; readonly method: "post"; }; readonly cancelSubscription: { readonly route: "/v1/subscription/:id/cancel"; readonly method: "put"; }; readonly updateSubscriptionMetadata: { readonly route: "/v1/subscription/:id/metadata"; readonly method: "put"; }; readonly getInstallments: { readonly route: "/v1/installments"; readonly method: "get"; }; readonly sendBilletEmail: { readonly route: "/v1/charge/:id/billet/resend"; readonly method: "post"; }; readonly createChargeHistory: { readonly route: "/v1/charge/:id/history"; readonly method: "post"; }; readonly sendCarnetEmail: { readonly route: "/v1/carnet/:id/resend"; readonly method: "post"; }; readonly sendCarnetParcelEmail: { readonly route: "/v1/carnet/:id/parcel/:parcel/resend"; readonly method: "post"; }; readonly createCarnetHistory: { readonly route: "/v1/carnet/:id/history"; readonly method: "post"; }; readonly cancelCarnet: { readonly route: "/v1/carnet/:id/cancel"; readonly method: "put"; }; readonly cancelCarnetParcel: { readonly route: "/v1/carnet/:id/parcel/:parcel/cancel"; readonly method: "put"; }; readonly defineLinkPayMethod: { readonly route: "/v1/charge/:id/link"; readonly method: "post"; }; readonly updateChargeLink: { readonly route: "/v1/charge/:id/link"; readonly method: "put"; }; readonly updatePlan: { readonly route: "/v1/plan/:id"; readonly method: "put"; }; readonly updateSubscription: { readonly route: "/v1/subscription/:id"; readonly method: "put"; }; readonly createSubscriptionHistory: { readonly route: "/v1/subscription/:id/history"; readonly method: "post"; }; readonly defineBalanceSheetBillet: { readonly route: "/v1/charge/:id/balance-sheet"; readonly method: "post"; }; readonly settleCharge: { readonly route: "/v1/charge/:id/settle"; readonly method: "put"; }; readonly settleCarnetParcel: { readonly route: "/v1/carnet/:id/parcel/:parcel/settle"; readonly method: "put"; }; readonly createOneStepCharge: { readonly route: "/v1/charge/one-step"; readonly method: "post"; }; readonly cardPaymentRetry: { readonly route: "/v1/charge/:id/retry"; readonly method: "post"; }; readonly refundCard: { readonly route: "/v1/charge/card/:id/refund"; readonly method: "post"; }; readonly listCharges: { readonly route: "/v1/charges"; readonly method: "get"; }; readonly createChargeCard: { readonly route: "/v2/charge/card"; readonly method: "post"; }; }; }; readonly PIX: { readonly URL: { readonly PRODUCTION: "https://pix.api.efipay.com.br"; readonly SANDBOX: "https://pix-h.api.efipay.com.br"; }; readonly ENDPOINTS: { readonly authorize: { readonly route: "/oauth/token"; readonly method: "post"; }; readonly pixCreateDueCharge: { readonly route: "/v2/cobv/:txid"; readonly method: "put"; }; readonly pixUpdateDueCharge: { readonly route: "/v2/cobv/:txid"; readonly method: "patch"; }; readonly pixDetailDueCharge: { readonly route: "/v2/cobv/:txid"; readonly method: "get"; }; readonly pixListDueCharges: { readonly route: "/v2/cobv/"; readonly method: "get"; }; readonly createReport: { readonly route: "/v2/gn/relatorios/extrato-conciliacao"; readonly method: "post"; }; readonly detailReport: { readonly route: "/v2/gn/relatorios/:id"; readonly method: "get"; }; readonly pixCreateCharge: { readonly route: "/v2/cob/:txid"; readonly method: "put"; }; readonly pixUpdateCharge: { readonly route: "/v2/cob/:txid"; readonly method: "patch"; }; readonly pixCreateImmediateCharge: { readonly route: "/v2/cob"; readonly method: "post"; }; readonly pixDetailCharge: { readonly route: "/v2/cob/:txid"; readonly method: "get"; }; readonly pixListCharges: { readonly route: "/v2/cob"; readonly method: "get"; }; readonly pixDetailReceived: { readonly route: "/v2/pix/:e2eId"; readonly method: "get"; }; readonly pixReceivedList: { readonly route: "/v2/pix"; readonly method: "get"; }; readonly pixSend: { readonly route: "/v3/gn/pix/:idEnvio"; readonly method: "put"; }; readonly pixSendDetail: { readonly route: "/v2/gn/pix/enviados/:e2eId"; readonly method: "get"; }; readonly pixSendList: { readonly route: "/v2/gn/pix/enviados"; readonly method: "get"; }; readonly pixDevolution: { readonly route: "/v2/pix/:e2eId/devolucao/:id"; readonly method: "put"; }; readonly pixDetailDevolution: { readonly route: "/v2/pix/:e2eId/devolucao/:id"; readonly method: "get"; }; readonly pixConfigWebhook: { readonly route: "/v2/webhook/:chave"; readonly method: "put"; }; readonly pixDetailWebhook: { readonly route: "/v2/webhook/:chave"; readonly method: "get"; }; readonly pixListWebhook: { readonly route: "/v2/webhook"; readonly method: "get"; }; readonly pixDeleteWebhook: { readonly route: "/v2/webhook/:chave"; readonly method: "delete"; }; readonly pixCreateLocation: { readonly route: "/v2/loc"; readonly method: "post"; }; readonly pixLocationList: { readonly route: "/v2/loc"; readonly method: "get"; }; readonly pixDetailLocation: { readonly route: "/v2/loc/:id"; readonly method: "get"; }; readonly pixGenerateQRCode: { readonly route: "/v2/loc/:id/qrcode"; readonly method: "get"; }; readonly pixUnlinkTxidLocation: { readonly route: "/v2/loc/:id/txid"; readonly method: "delete"; }; readonly pixCreateEvp: { readonly route: "/v2/gn/evp"; readonly method: "post"; }; readonly pixListEvp: { readonly route: "/v2/gn/evp"; readonly method: "get"; }; readonly pixDeleteEvp: { readonly route: "/v2/gn/evp/:chave"; readonly method: "delete"; }; readonly getAccountBalance: { readonly route: "/v2/gn/saldo"; readonly method: "get"; }; readonly updateAccountConfig: { readonly route: "/v2/gn/config"; readonly method: "put"; }; readonly listAccountConfig: { readonly route: "/v2/gn/config"; readonly method: "get"; }; readonly pixSplitDetailCharge: { readonly route: "/v2/gn/split/cob/:txid"; readonly method: "get"; }; readonly pixSplitLinkCharge: { readonly route: "/v2/gn/split/cob/:txid/vinculo/:splitConfigId"; readonly method: "put"; }; readonly pixSplitUnlinkCharge: { readonly route: "/v2/gn/split/cob/:txid/vinculo"; readonly method: "delete"; }; readonly pixSplitDetailDueCharge: { readonly route: "/v2/gn/split/cobv/:txid"; readonly method: "get"; }; readonly pixSplitLinkDueCharge: { readonly route: "/v2/gn/split/cobv/:txid/vinculo/:splitConfigId"; readonly method: "put"; }; readonly pixSplitUnlinkDueCharge: { readonly route: "/v2/gn/split/cobv/:txid/vinculo"; readonly method: "delete"; }; readonly pixSplitConfig: { readonly route: "/v2/gn/split/config"; readonly method: "post"; }; readonly pixSplitConfigId: { readonly route: "/v2/gn/split/config/:id"; readonly method: "put"; }; readonly pixSplitDetailConfig: { readonly route: "/v2/gn/split/config/:id"; readonly method: "get"; }; readonly pixSendDetailId: { readonly route: "/v2/gn/pix/enviados/id-envio/:idEnvio"; readonly method: "get"; }; readonly pixCreateDueChargeBatch: { readonly route: "/v2/lotecobv/:id"; readonly method: "put"; }; readonly pixUpdateDueChargeBatch: { readonly route: "/v2/lotecobv/:id"; readonly method: "patch"; }; readonly pixDetailDueChargeBatch: { readonly route: "/v2/lotecobv/:id"; readonly method: "get"; }; readonly pixListDueChargeBatch: { readonly route: "/v2/lotecobv"; readonly method: "get"; }; readonly medDefense: { readonly route: "/v2/gn/infracoes/:idInfracao/defesa"; readonly method: "post"; }; readonly medList: { readonly route: "/v2/gn/infracoes"; readonly method: "get"; }; readonly pixQrCodePay: { readonly route: "/v2/gn/pix/:idEnvio/qrcode"; readonly method: "put"; }; readonly pixResendWebhook: { readonly route: "/v2/gn/webhook/reenviar"; readonly method: "post"; }; readonly pixGetReceipt: { readonly route: "/v2/gn/pix/comprovantes"; readonly method: "get"; readonly responseType: "arraybuffer"; }; readonly pixSendSameOwnership: { readonly route: "/v2/gn/pix/:idEnvio/mesma-titularidade"; readonly method: "put"; }; readonly pixKeysBucket: { readonly route: "/v2/gn/chaves/balde"; readonly method: "get"; }; readonly pixDetailRecurrenceAutomatic: { readonly route: "/v2/rec/:idRec"; readonly method: "get"; }; readonly pixUpdateRecurrenceAutomatic: { readonly route: "/v2/rec/:idRec"; readonly method: "patch"; }; readonly pixListRecurrenceAutomatic: { readonly route: "/v2/rec"; readonly method: "get"; }; readonly pixCreateRecurrenceAutomatic: { readonly route: "/v2/rec"; readonly method: "post"; }; readonly pixCreateRequestRecurrenceAutomatic: { readonly route: "/v2/solicrec"; readonly method: "post"; }; readonly pixDetailRequestRecurrenceAutomatic: { readonly route: "/v2/solicrec/:idSolicRec"; readonly method: "get"; }; readonly pixUpdateRequestRecurrenceAutomatic: { readonly route: "/v2/solicrec/:idSolicRec"; readonly method: "patch"; }; readonly pixCreateAutomaticChargeTxid: { readonly route: "/v2/cobr/:txid"; readonly method: "put"; }; readonly pixUpdateAutomaticCharge: { readonly route: "/v2/cobr/:txid"; readonly method: "patch"; }; readonly pixDetailAutomaticCharge: { readonly route: "/v2/cobr/:txid"; readonly method: "get"; }; readonly pixCreateAutomaticCharge: { readonly route: "/v2/cobr"; readonly method: "post"; }; readonly pixListAutomaticCharge: { readonly route: "/v2/cobr"; readonly method: "get"; }; readonly pixRetryRequestAutomatic: { readonly route: "/v2/cobr/:txid/retentativa/:data"; readonly method: "post"; }; readonly pixCreateLocationRecurrenceAutomatic: { readonly route: "/v2/locrec"; readonly method: "post"; }; readonly pixListLocationRecurrenceAutomatic: { readonly route: "/v2/locrec"; readonly method: "get"; }; readonly pixDetailLocationRecurrenceAutomatic: { readonly route: "/v2/locrec/:id"; readonly method: "get"; }; readonly pixUnlinkLocationRecurrenceAutomatic: { readonly route: "/v2/locrec/:id/idRec"; readonly method: "delete"; }; readonly pixConfigWebhookRecurrenceAutomatic: { readonly route: "/v2/webhookrec"; readonly method: "put"; }; readonly pixListWebhookRecurrenceAutomatic: { readonly route: "/v2/webhookrec"; readonly method: "get"; }; readonly pixDeleteWebhookRecurrenceAutomatic: { readonly route: "/v2/webhookrec"; readonly method: "delete"; }; readonly pixConfigWebhookAutomaticCharge: { readonly route: "/v2/webhookcobr"; readonly method: "put"; }; readonly pixListWebhookAutomaticCharge: { readonly route: "/v2/webhookcobr"; readonly method: "get"; }; readonly pixDeleteWebhookAutomaticCharge: { readonly route: "/v2/webhookcobr"; readonly method: "delete"; }; readonly pixSplitDevolution: { readonly route: "/v2/gn/split/pix/:e2eid/devolucao/:id"; readonly method: "put"; }; }; }; readonly OPENFINANCE: { readonly URL: { readonly PRODUCTION: "https://openfinance.api.efipay.com.br/v1"; readonly SANDBOX: "https://openfinance-h.api.efipay.com.br/v1"; }; readonly ENDPOINTS: { readonly authorize: { readonly route: "/oauth/token"; readonly method: "post"; }; readonly ofListParticipants: { readonly route: "/participantes/"; readonly method: "get"; }; readonly ofStartPixPayment: { readonly route: "/pagamentos/pix"; readonly method: "post"; }; readonly ofListPixPayment: { readonly route: "/pagamentos/pix"; readonly method: "get"; }; readonly ofConfigUpdate: { readonly route: "/config"; readonly method: "put"; }; readonly ofConfigDetail: { readonly route: "/config"; readonly method: "get"; }; readonly ofDevolutionPix: { readonly route: "/pagamentos/pix/:identificadorPagamento/devolver"; readonly method: "post"; }; readonly ofCancelSchedulePix: { readonly route: "/pagamentos-agendados/pix/:identificadorPagamento/cancelar"; readonly method: "patch"; }; readonly ofListSchedulePixPayment: { readonly route: "/pagamentos-agendados/pix"; readonly method: "get"; }; readonly ofStartSchedulePixPayment: { readonly route: "/pagamentos-agendados/pix"; readonly method: "post"; }; readonly ofDevolutionSchedulePix: { readonly route: "/pagamentos-agendados/pix/:identificadorPagamento/devolver"; readonly method: "post"; }; readonly ofStartRecurrencyPixPayment: { readonly route: "/pagamentos-recorrentes/pix"; readonly method: "post"; }; readonly ofListRecurrencyPixPayment: { readonly route: "/pagamentos-recorrentes/pix"; readonly method: "get"; }; readonly ofCancelRecurrencyPix: { readonly route: "/pagamentos-recorrentes/pix/:identificadorPagamento/cancelar"; readonly method: "patch"; }; readonly ofDevolutionRecurrencyPix: { readonly route: "/pagamentos-recorrentes/pix/:identificadorPagamento/devolver"; readonly method: "post"; }; readonly ofReplaceRecurrencyPixParcel: { readonly route: "/pagamentos-recorrentes/pix/:identificadorPagamento/substituir/:endToEndId"; readonly method: "patch"; }; readonly ofCreateBiometricEnrollment: { readonly route: "/pagamentos-biometria/vinculos"; readonly method: "post"; }; readonly ofListBiometricEnrollment: { readonly route: "/pagamentos-biometria/vinculos"; readonly method: "get"; }; readonly ofCreateBiometricPixPayment: { readonly route: "/pagamentos-biometria/pix"; readonly method: "post"; }; readonly ofListBiometricPixPayment: { readonly route: "/pagamentos-biometria/pix"; readonly method: "get"; }; readonly ofRevokeBiometricEnrollment: { readonly route: "/pagamentos-biometria/vinculos"; readonly method: "patch"; }; readonly ofCreateAutomaticEnrollment: { readonly route: "/pagamentos-automaticos/adesao"; readonly method: "post"; }; readonly ofListAutomaticEnrollment: { readonly route: "/pagamentos-automaticos/adesao"; readonly method: "get"; }; readonly ofUpdateAutomaticEnrollment: { readonly route: "/pagamentos-automaticos/adesao"; readonly method: "patch"; }; readonly ofCreateAutomaticPixPayment: { readonly route: "/pagamentos-automaticos/pix"; readonly method: "post"; }; readonly ofListAutomaticPixPayment: { readonly route: "/pagamentos-automaticos/pix"; readonly method: "get"; }; readonly ofCancelAutomaticPixPayment: { readonly route: "/pagamentos-automaticos/pix"; readonly method: "patch"; }; }; }; readonly PAGAMENTOS: { readonly URL: { readonly PRODUCTION: "https://pagarcontas.api.efipay.com.br/v1"; readonly SANDBOX: "https://pagarcontas-h.api.efipay.com.br/v1"; }; readonly ENDPOINTS: { readonly authorize: { readonly route: "/oauth/token"; readonly method: "post"; }; readonly payDetailBarCode: { readonly route: "/codBarras/:codBarras"; readonly method: "GET"; }; readonly payRequestBarCode: { readonly route: "/codBarras/:codBarras"; readonly method: "POST"; }; readonly payDetailPayment: { readonly route: "/:idPagamento"; readonly method: "GET"; }; readonly payListPayments: { readonly route: "/resumo"; readonly method: "GET"; }; readonly payConfigWebhook: { readonly route: "/webhook"; readonly method: "PUT"; }; readonly payListWebhook: { readonly route: "/webhook"; readonly method: "GET"; }; readonly payDeleteWebhook: { readonly route: "/webhook"; readonly method: "DELETE"; }; }; }; readonly CONTAS: { readonly URL: { readonly PRODUCTION: "https://abrircontas.api.efipay.com.br/v1"; readonly SANDBOX: "https://abrircontas-h.api.efipay.com.br/v1"; }; readonly ENDPOINTS: { readonly authorize: { readonly route: "/oauth/token"; readonly method: "post"; }; readonly createAccount: { readonly route: "/conta-simplificada"; readonly method: "post"; }; readonly createAccountCertificate: { readonly route: "/conta-simplificada/:idContaSimplificada/certificado"; readonly method: "post"; }; readonly getAccountCredentials: { readonly route: "/conta-simplificada/:idContaSimplificada/credenciais"; readonly method: "get"; }; readonly accountConfigWebhook: { readonly route: "/webhook"; readonly method: "post"; }; readonly accountDeleteWebhook: { readonly route: "/webhook/:identificadorWebhook"; readonly method: "delete"; }; readonly accountDetailWebhook: { readonly route: "/webhook/:identificadorWebhook"; readonly method: "get"; }; readonly accountListWebhook: { readonly route: "/webhooks"; readonly method: "get"; }; }; }; readonly EXTRATOS: { readonly URL: { readonly PRODUCTION: "https://extratos.api.efipay.com.br/v1"; readonly SANDBOX: "https://extratos-h.api.efipay.com.br/v1"; }; readonly ENDPOINTS: { readonly authorize: { readonly route: "/oauth/token"; readonly method: "post"; }; readonly listStatementFiles: { readonly route: "/extrato-cnab/arquivos"; readonly method: "get"; }; readonly getStatementFile: { readonly route: "/extrato-cnab/download/:nome_arquivo"; readonly method: "get"; }; readonly listStatementRecurrences: { readonly route: "/extrato-cnab/agendamentos"; readonly method: "get"; }; readonly createStatementRecurrency: { readonly route: "/extrato-cnab/agendar"; readonly method: "post"; }; readonly updateStatementRecurrency: { readonly route: "/extrato-cnab/agendar/:identificador"; readonly method: "patch"; }; readonly createSftpKey: { readonly route: "/extrato-cnab/gerar-chaves"; readonly method: "post"; }; }; }; }; }; export type ApiKey = keyof typeof endpoints.APIS; export type ApiConfig = (typeof endpoints.APIS)[ApiKey]; export type EndpointConfig = ApiConfig['ENDPOINTS'][keyof ApiConfig['ENDPOINTS']];