Criar Lote de Cobranças com Boleto Híbrido

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

Este serviço realiza a criação de cobranças de Boletos Híbridos em lote

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

callback_url

string

A URL informada será notificada com as seguintes informações, toda vez que a cobrança alterar de status:
"bank_slip_batch_id"
"event".

external_id

string

required

Identificador único do boleto equivalente ao seu_número, utilizado para controle do cliente
Observação:
Não é permitido utilizar external_id repetidos, pois se trata de um identificador único.

orders

array of objects

required

length between 1 and 100

Lista de cobranças do tipo Boleto Híbrido.
É obrigatório o envio de pelo menos uma cobrança e máximo de 100.

orders*

amount_details

object

Detalhes sobre juros, multa, desconto e abatimento nas cobranças.
Observação:
Cada banco parceiro possui particularidades para criação, alteração e cancelamento. Para detalhamento e comparação acessar a planilha: Particularidades de cada banco

bank_slip_type

string

required

Natureza do boleto gerado.

natureza	descrição
merchandise_sales	Boleto referente à cobrança de venda de mercadorias.
service_provision	Boleto referente à cobrança de prestação de serviços.
bank_slip_proposal	Boleto proposta.
general	Diversos.

charge_enabled

string

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".

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 .

buyer

object

required

Dados do devedor.

calendar

object

required

Os campos alinhados sob o identificador calendário organizam informações a respeito de controle de tempo da cobrança.

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.

convenant_code

string

Código do convênio ou carteira.

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á uma um Boleto Híbrido. Se for enviado como true, será registrado um Boleto Híbrido.

items

array of objects

required

Lista de itens da cobrança. É obrigatório enviar ao menos um item. No caso de pagamento parcial, ver https://docs.shipay.com.br/faq/#pagamento_parcial.

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.

pix_dict_key

string

Chave Pix da conta bancária que criou a 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, esse valor será sempre "pix", independente do provedor de serviço de pagamentos (PSP).

Headers

authorization

string

required

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

Response

Language


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

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

application/json

200Successful response