API Reference

Registrar um Boleto Híbrido

post
https://api-staging.shipay.com.br/v2/order-due-date

Este serviço registra um boleto híbrido (Boleto + QR Code Pix).

Caso o QR Code seja pago, o boleto é automaticamente cancelado e vice-versa para o caso de pagamento via código de barras.

Atualmente, este serviço está disponível na Shipay com os seguintes bancos parceiros:

  • Itaú
  • Banco do Brasil
  • Sicoob
  • Bradesco
  • Santander
  • Sicredi
  • Caixa

IMPORTANTE:

  • Cada banco parceiro possui particularidades para criação, alteração e cancelamento. Para detalhamento e comparação acessar a planilha: Particularidades de cada banco
Body Params
integer

Quantidade de dias corridos após o vencimento da cobrança, para o banco iniciar a negativação automática do devedor.

integer

Quantidade de dias corridos após o vencimento da cobrança, para o banco iniciar o protesto automático do devedor.

string
length ≤ 255

Chave de idempotencia única atrelada ao body da chamada e ao caixa configurado no nosso painel.
Deve ser utilizada para evitar o cenário de duplicidade na emissão de boletos híbridos.
Recomendamos que seja utilizado um UUID para melhor controle.

boolean
required

Indica se a cobrança a ser gerada será um Boleto Híbrido.

string
required

Natureza do boleto gerado.

naturezadescrição
merchandise_salesBoleto referente à cobrança de venda de mercadorias.
service_provisionBoleto referente à cobrança de prestação de serviços.
bank_slip_proposalBoleto proposta.
generalDiversos.
string

Número de equivalência ao seu número (Identificador do Boleto).
Identificado como "Num do documento" no boleto em PDF .

string

Identificador único de equivalência ao nosso número (Identificador do Boleto)
Identificado como "Nosso número" no boleto em PDF.

integer

Código do convênio ou carteira.

string

CNPJ do beneficiário final, deve ser utilizado para fazer o controle de qual será o beneficiário final em casos de múltiplos beneficiários cadastrados em uma mesma conta.

buyer
object
required

Informações do devedor.

guarantor
object

Informações do sacador/avalista.

boolean

Indica se a cobrança a ser gerada será um Boleto Híbrido ou boleto comum.
Se for enviado como true, será registrado um Boleto Comum.

⚠️

Importante:

Boleto comum disponível apenas para o Banco do Brasil, em desenvolvimento para os demais bancos

number
⚠️

Importante:

Campo disponível apenas para o Banco do Brasil.
Se enviado para outros bancos, a requisição retornará erro.

Indica o tipo de modalidade da emissão do boleto:

ValorModalidade
1Modalidade Simples
2Modalidade Vinculada
string

A URL informada será notificada toda vez que a cobrança alterar de status. Para mais detalhes, acessar https://docs.shipay.com.br/faq/#callback.

string

Chave Pix da conta bancária cadastrada na Shipay.

boolean

Quando "true", os seguintes campos serão retornados na response:

  • charge_url: URL para abrir o boleto no navegador.
  • charge_url_pdf: URL para download do boleto, permitindo que o cliente faça a impressão.

Quando "false", apenas o campo charge_url será retornado com o valor "null".

amount_details
object

Detalhamento de juros, multa, desconto e abatimento que incidirão sobre as cobranças.
Para mais detalhamentos e comparações acessar a planilha: Particularidades de cada banco

items
array of objects
required
length ≥ 1

Lista de itens da cobrança. É obrigatório enviar ao menos um item.

items*
string

EAN do item.

string
required

Nome do item.

float
required

Quantidade do item.

string

SKU do item.

float
required

Valor unitário do item.

string

Mensagem para o pagador.

additional_information
array of objects

Informações adicionais.

additional_information
string
required

Referência da cobrança.

float
required

Valor total da cobrança.

string
required

Nome da conta na qual a cobrança foi criada. Neste caso específico do Boleto Híbrido, esse valor será sempre "pix", independente do provedor de serviço de pagamentos (PSP).

calendar
object
required
Headers
string
required

Token de acesso obtido através do serviço de autenticação /pdvauth.

Responses

Updated 2 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?