z-zoop

1.0.3 • Public • Published

z-zoop

Instalação

Instale o pacote z-zoop via npm:

$ npm install --save z-zoop

ou via yarn:

$ yarn add z-zoop

Exemplo

const Zoop = require('z-zoop')({
    token: '<ZOOP_TOKEN_ID>',
    marketplaceId: '<MARKETPLACE_ID>',
});

const boleto = await Zoop.newBillet({
    amount: 500, // Valor em centavos (Mínimo de R$ 3,00 (300) )
    sellerId: '<SELLER_ID>', // ID do Seller Recebedor
    customer: {
        name: 'Rodrigo Henrique Sobrinho', // Nome do Cliente
        email: 'rodrigo@email.com.br', // E-mail do Cliente
        phoneNumber: '11987654321', // Telefone do Cliente
        taxpayerId: '77693351086', // CPF do Cliente
        birthdate: '1989-12-06', // Data de Nascimento do Cliente
        address: {
            publicPlace: 'Avenida Teste', // Logradouro
            number: 1234, // Número
            city: 'São Paulo', // Cidade
            state: 'SP', // Estado
            postalCode: '01234567', // CEP
        },
    },
    // Opcionais
    reference: 'a1b2c3d4', // Código de Referência do Estabelecimento
    description: 'Venda de Ingresso', // Descrição do Boleto
    statement_descriptor: 'Z-Systems', // Nome do beneficiário que aparece no boleto
    bodyInstructions: [
        'SR. CAIXA, COBRAR MULTA DE 10% APÓS O VENCIMENTO',
        'SR. CAIXA, COBRAR MORA DE R$0,01 AO DIA APÓS O VENCIMENTO',
        'EM CASO DE DÚVIDAS ENTRE EM CONTATO CONOSCO',
        'EMITIDO PELA ZOOP WWW.PAGZOOP.COM',
    ],
    split: [ // Regras de Split
        {
            recipient: '<SELLER_ID_SPLIT>', // ID do Seller que fará split
            // O Split é feito por valor fixo (amount) OU pela porcentagem (percentage)
            amount: 400, // Valor em centavos do split
            percentage: 10, // Porcentagem do Split
            liable: 1, // Recebedor arca com prejuízo em caso de chargeback (1) ou não (0). Default: 1
            charge_processing_fee: 0, // Split em cima do valor bruto (0) ou do valor líquido (1)
        },
        .
        .
        .
    ],
    metadata: {
        teste: 1,
        teste2: 'texto'
    },
    // Multa
    lateFee: {
        mode: 'fixed', // Tipo de multa. Fixa (fixed) ou porcentagem (percentage)
        amount: 100, // Valor em centavos para multa fixa.
        percentage: 10, // Porcentagem da multa.
        startDate: '2019-08-20, // Data para começar a cobrar a multa. Por padrão é o vencimento do boleto.
    }
    // Juros
    interest: {
        mode: 'daily_amount', // Tipo de juros. Valor Fixo Diário (daily_amount), Porcentagem Diária (daily_percentage) e Porcentagem Mensal (monthly_percentage).
        amount: 100, // Valor em centavos para juros fixo.
        percentage: 10, // Porcentagem do juros para Porcentagem Diária e Mensal.
        startDate: '2019-08-20, // Data para começar a cobrar o juros. Por padrão é o vencimento do boleto.
    }
});

Readme

Keywords

none

Package Sidebar

Install

npm i z-zoop

Weekly Downloads

2

Version

1.0.3

License

ISC

Unpacked Size

14.7 kB

Total Files

7

Last publish

Collaborators

  • npm.zsystems