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

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

days_to_negative_report

integer

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

days_to_protest

integer

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

enable_bank_slip

boolean

required

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

bank_slip_type

string

required

Tipo do boleto. Ex: "merchandise_sales" para venda de mercadorias.

bank_slip_client_number

string

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

covenant_code

integer

Código do convênio ou carteira.

buyer

object

required

callback_url

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.

pix_dict_key

string

Chave Pix da conta bancária cadastrada na Shipay.

charge_enabled

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

items

message_to_payer

string

Mensagem para o pagador.

additional_information

array of objects

Informações adicionais.

additional_information

order_ref

string

required

Referência da cobrança.

total

float

required

Valor total da cobrança.

wallet

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

authorization

string

required

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

Responses

Response body

object

bank_slip_id

integer

Identificador do Boleto Híbrido.(Nosso número)

barcode

string

Código de barras do boleto.

charge_url

string

URL para abrir o boleto no navegador.

charge_url_pdf

string

URL para baixar o boleto em PDF e auxiliar na impressão do mesmo.

covenant_code

integer

Código do convênio.

deep_link

string

Deeplink para o aplicativo do PSP pagador. Pode ser nulo.

expedition_date

date

Data de expedição do boleto.

expiration_date

date-time

Data de expiração do boleto.

order_id

string

Identificador da cobrança na Shipay.

pix_dict_key

string

Chave Pix da conta bancária que criou a cobrança..

pix_psp

string

Nome do provedor de serviço de pagamentos (PSP) no qual a cobrança foi gerada.

qr_code

string

QR Code em imagem, codificado em Base64.

qr_code_text

string

QR Code do boleto em formato de texto (facilitando a impressão do QR Code em impressora térmica). No caso de Pix, esse campo é o código utilizado para a funcionalidade "copia e cola".

reference

string

Referência da cobrança.

status

string

Status do Boleto Híbrido. Neste caso, o único status possível é:

status	descrição
pending	Cobrança aberta e ainda não paga.

typeable_line

string

Linha digitável do boleto.

wallet

string

Conta utilizada para gerar a cobrança.

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-staging.shipay.com.br/v2/order-due-date \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "enable_bank_slip": true
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Boleto Híbrido Registrado

400Bad request

403Forbidden

404Not Found

422Unprocessable Entity

502Bad Gateway