Cobrança Pix

Identificador do processo;

É um valor para identificar a chamada que está sendo realizada. Este valor será retornado no final do processo para facilitar a identificação do registro de cobrança;

Informação obrigatória.

Informar o nome do banco que deseja realizar o pix;

Bancos aceitos: Itaú (ITAU), Santander (SANTANDER), Banco do Brasil (BANCO_DO_BRASIL) e Bradesco (BRADESCO);

Informação obrigatória.

Informar os dados da empresa que fará a solicitação do pix;

Informar o identificador da empresa (id) e/ou código da empresa (code);

Todos os campos são opcionais, mas pelo menos um deles deve ser enviado para geração do pix.

Informar os dados da filial que fará a solicitação do pix;

Informar os campos:

• Identificador da filial (id);
• Código da filial (code);
• Número do documento (CPF/CNPJ) (documentNumber) e/ou número de identificação fiscal (nifNumber).

Todos os campos são opcionais, mas pelo menos um deles deve ser enviado para geração do pix.

Informar os dados bancários de geração do pix;

Informar os campos:

• Chave pix (pixKey);
• Número da agência (branchNumber);
• Dígito da agência (branchDigit);
• Número da conta (accountNumber);
• Dígito da conta (accountDigit);

Todos os campos são obrigatórios.

Informar os dados do título para registrar a cobrança;

Informar os campos:

• Identificador do Título (accountReceivableId);
• Número do Título (accountReceivableNumber);
• Tipo do Título (accountReceivableType);
•  Identificador do Cliente (customer);
•  Data de Vencimento (dueDate);
•  Dias Corridos Após o Vencimento que a Cobrança Poderá ser Paga (validityAfterExpiration);
•  Valores do Título (values);
•  Informações Adicionais do Pix (additionalPixInformations);

Observações

O campo validityAfterExpiration e additionalPixInformations são opcionais;

O campo validityAfterExpiration só deve ser informado para cobranças com vencimento (COBV);

O campo values é obrigatório, mas é necessário informar os campos listados abaixo apenas para cobranças com vencimento (COBV):

• Valor Original (original);
• Juros (interest);
• Multas (assessment);
• Abatimentos (rebate);
• Desconto (discount).

Caso contrário, quando é cobrança imediata (COB), é necessário informar apenas o campo Valor Original (original);

Para mais detalhes sobre o preenchimento destes campos, acesse o item Como preencher o campo de Juros (interest), Multas (assessment), Abatimentos (rebate) e Desconto (discount) da documentação.

O campo de Customer deve ser informado:

• Identificador do cliente (id);
• Número do documento (CPF/CNPJ) (documentNumber);
• Nome (name) e/ou Nome fantasia (tradeName).

Todos os campos são opcionais, mas sempre deve ser informado o Identificador do cliente (id) ou o Número do documento (CPF/CNPJ) (documentNumber);

Se enviado o Número do documento (CPF/CNPJ) (documentNumber), deve ser informado o Nome (name);

Se o Número do documento (CPF/CNPJ) (documentNumber) for CNPJ, deve ser informado o Nome fantasia (tradeName).

Informe o campo Tipo de cálculo (calculationType), que será buscado do enumCalculationTypeInterest (o enumCalculationTypeInterest representa a modalidade de juros para a cobrança) e o campo Valor ou Percentual (valueOrPercentage).

enumeration enumCalculationTypeInterest {
            "Valor (dias corridos)"
            VALUE_FOR_CALENDAR_DAYS

            "Percentual ao dia (dias corridos)"
            PERCENTAGE_FOR_CALENDAR_DAYS

            "Percentual ao mês (dias corridos)"
            PERCENTAGE_FOR_CALENDAR_MONTH

            "Percentual ao ano (dias corridos)"
            PERCENTAGE_FOR_CALENDAR_YEAR

            "Valor (dias úteis)"
            VALUE_FOR_BUSINESS_DAYS

            "Percentual ao dia (dias úteis)"
            PERCENTAGE_FOR_BUSINESS_DAYS

            "Percentual ao mês (dias úteis)"
            PERCENTAGE_FOR_BUSINESS_MONTH

            "Percentual ao ano (dias úteis)"
            PERCENTAGE_FOR_BUSINESS_YEAR
        }

Informe o campo Tipo de cálculo (calculationType), que será buscado do enumCalculationType (o enumCalculationType representa a modalidade de abatimento para a cobrança) e o campo Valor ou Percentual (valueOrPercentage).

           enumeration enumCalculationType {
            "Percentual"
            PERCENTAGE

            "Valor fixo"
            FIXED_VALUE
        }

Informe o campo Tipo de cálculo (calculationType), que será buscado do enumCalculationTypeDiscount (o enumCalculationTypeDiscount representa a modalidade de desconto para a cobrança), Valor ou Percentual (valueOrPercentage) e o campo Descontos definidos de acordo com a data estabelecida (discountFixedDate).

           enumeration enumCalculationTypeDiscount {
            "Valor fixo até a(s) data(s) informada(s)"
            FIXED_VALUE_UNTIL_LIMIT_DATE

            "Percentual até a data informada"
            PERCENTAGE_UNTIL_LIMIT_DATE

            "Valor por antecipação dia corrido"
            VALUE_FOR_ADVANCE_CALENDAR_DAY

            "Valor por antecipação dia útil"
            VALUE_FOR_ADVANCE_BUSINESS_DAY

            "Percentual por antecipação dia corrido"
            PERCENTAGE_FOR_ADVANCE_CALENDAR_DAY

            "Percentual por antecipação dia útil"
            PERCENTAGE_FOR_ADVANCE_BUSINESS_DAY
        }

• A API registerPixBilling só pode ser chamada em lote de no máximo 100 títulos por payload;
• O mesmo título não pode ser enviado para geração ou cancelamento do pix;
• Não é possível alterar um Pix gerado. É possível apenas cancelar e depois gerar novamente;
• Os retornos de confirmação do Pix pago são realizados um por vez.

1. Identifica se o cliente do título já está cadastrado. Caso não esteja, é realizado o cadastro do cliente;
2. A requisição é enviada para o parceiro bancário. O parceiro bancário é responsável por enviar para o banco a solicitação de Pix;
3. Após o banco gerar o Pix, devolve para o banking e entrega para o solicitante;
4. Após pago, o Pix é identificado como pago pelo banco e entregue para o solicitante.

Identificador do processo;

É um valor para identificar a chamada que está sendo realizada.

Informação obrigatória.

Informar os títulos que deseja cancelar.

• A API cancelPixBilling só pode ser chamada em lote de no máximo 100 títulos por payload;
• O mesmo título não pode ser enviado para geração ou cancelamento do pix;
• Não é possível alterar um Pix gerado. É possível apenas cancelar e depois gerar novamente;