Criar uma Cobrança Pix com Vencimento

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

Este serviço cria cobranças Pix com vencimento, permitindo:

Estipular prazo para pagamento após o vencimento
Aplicar juros
Aplicar multa
Gerar descontos
Gerar abatimento de valores

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

Itaú
Bradesco
Tbanks
Sicredi

Body Params

buyer

object

required

Informações do devedor.

charge_enabled

boolean

Defaults to false

Quando "true" gera um link para uma página com todos os detalhes da cobrança incluídos no campo amount_details junto com o QR Code em imagem e o copia e cola. Facilitando para seu cliente ter todas as informações e opções de pagamento, além de poder salvar em PDF ou encaminhar via WhatsApp.
Importante: Esse campo por padrão será "false".

amount_details

object

Detalhamento de juros, multa, desconto e abatimento que incidirão sobre as cobranças.

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*

calendar

object

required

Informações a respeito de controle de tempo da cobrança, como data de vencimento e quantidade de dias após o vencimento que a cobrança pode ser paga.

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. Este valor tem que ser sempre igual ao somatório dos valores dos itens.

wallet

string

required

Nome da conta associada na qual a cobrança foi criada. No caso de Pix, o valor desse campo é "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.

Responses

Response body

object

charge_url

string

URL que direciona o usuário para a páginade pagamento.

deep_link

string

URL que redireciona o usuário para o aplicativo da conta associada. No caso de cobranças Pix, esse campo retorna "null".

expiration_date

date-time

Soma dos valores de data de vencimento com o valor configurado em "days_valid_after_due".

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 Pix foi gerada.

qr_code

string

QR Code em imagem, codificado em Base64.

qr_code_text

string

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

status

string

Status da cobrança. Neste caso, os status possíveis são:

status	descrição
pendingv	Cobrança aberta aguardando pagamento.

wallet

string

Nome da conta associada na qual a cobrança foi criado. No caso desse serviço, o valor desse campo é "pix", independente do provedor de serviço de pagamentos (PSP).

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-staging.shipay.com.br/v1/bacen/order-due-date \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

201Cobrança com vencimento criada

400Bad request

403Forbidden

404Not Found

422Unprocessable Entity

500Internal Server Error

502Bad Gateway