Gera um novo boleto

POST 
/charge/bank-slip

Emite um boleto (ou link de pagamento, no caso da Cielo) na integração financeira indicada em IDCompanyIntegration. Em modo avulso os dados vêm do corpo; informando a query idorder ou idserviceorder, o corpo é ignorado e o sistema emite um boleto para cada recebimento do pedido ou da NFSe que ainda não tenha boleto e que aponte para uma integração financeira. Quando o boleto está vinculado a um pedido, o número do pedido é enviado ao emissor e aparece como número do documento no boleto. Disponível apenas para as integrações PagarMe, Banco Inter, Mercado Pago, Itaú e Cielo. Quando a integração estiver parametrizada para isso, o boleto também é enviado ao cliente por WhatsApp e/ou e-mail.

Request

Responses

200

Boleto gerado. No modo avulso (sem as queries idorder/idserviceorder e sem IDAccountPayableReceivable no corpo), devolve um array com um objeto contendo o detalhe completo do boleto recém-criado: IDBankSlip, BankSlipUrl, BankSlipBarCode, BankSlipBarCodeImageLine, TID, UniqueSequentialNumber, ExternalId, IDStatusBankSlip (1 Ag. Pagamento), StatusBankSlip, além dos dados do cliente e da integração. Quando uma das queries idorder/idserviceorder é usada ou o corpo traz IDAccountPayableReceivable, o corpo é apenas a string Sucesso, sem o boleto. Na integração Cielo, TID e UniqueSequentialNumber são preenchidos com o ExternalId do link gerado.

400

Validação ou falha na emissão (prefixo [BadRequest]). Mensagens: Empresa não encontrada; Integração não cadastrada; Integração não permite gerar boleto; Consumidor não cadastrado; Endereço não cadastrado; Recebimentos do pedido já tem boleto gerado ou não possuem integração com boleto/link (apenas nos modos idorder e idserviceorder); Não foi possível emitir o boleto. Tente novamente. (falha de comunicação ao acionar o emissor); Boleto emitido, mas não foi possível carregá-lo. Atualize a tela. (emissão concluída, mas a releitura do boleto falhou). O emissor também pode devolver a própria mensagem de recusa dos dados.