Introdução a API

Autenticação

Cartões para testes

Estabelecimentos

Usuários

Consumidores

Cartão

Links de pagamento

Códigos de Erro

Split de Pagamento

Produtos

Cupons de Desconto

Vendas

Assinaturas

Financeiro

Webhooks

Nesta página

POST Criar venda no Boleto

https://api.premepay.com/v1/stores/:id/orders

Lista de Parâmetros

Parâmetro Tipo Descrição Obrigatório
customerId integer Identificador do consumidor Sim
fingerprint string Identificador único da sessão do usuário Não
includeFeeTransfer boolean Indica se taxas devem ser repassadas ao consumidor Não
amount decimal Valor total a ser cobrado Sim
products array<object> Produtos associados ao pagamento Não
productId integer Id do https://primefy.notion.site/99e9f08b9ec24e4aad637789d3c57e5c Sim, se propriedade products for utilizada
quantity decimal Quantidade do produto associado ao pagamento Sim, se propriedade products for utilizada
description string Descrição da venda Sim
generateAllBoletos boolean Em caso de compra parcelada no boleto, esta propriedade define se todos os boletos serão gerados e enviados no momento da compra para Consumidor Não, se a propriedade for omitida ou receber o valor false, a parcela/boleto será gerada/enviado ao Consumidor automaticamente a cada vencimento
voucher string Cupom de desconto Não
payment object Informações do pagamento Sim
type string Tipo do pagamento (boleto) Sim
installments int Número de Parcelas. Disponível até 12 parcelas. Sim
dueDate date Data de vencimento Sim
lateFee object Cobrança de multa por atraso Não
amount decimal Valor fixo Quando Mode for Daily_Amount ou Fixed
percentage decimal Percentual Quando Mode for Daily_Percentage, Monthly_Percentage ou Percentage
mode string Tipo de cobrança Não
daily_percentage Percentual por dia
daily_amount Valor fixo por dia
monthly_percentage Percentual por mês
fixed Valor fixo
percentage Valor percentual
interestOrFine object Cobrança de juros por atraso Não
amount decimal Valor fixo Quando Mode for Daily_Amount ou Fixed
percentage decimal Percentual Quando Mode for Daily_Percentage, Monthly_Percentage ou Percentage
mode string Tipo de cobrança Não
daily_percentage Percentual por dia
daily_amount Valor fixo por dia
monthly_percentage Percentual por mês
fixed Valor fixo
percentage Valor percentual
discount object Desconto Não
amount decimal Valor fixo Quando Mode for Daily_Amount ou Fixed
percentage decimal Percentual Quando Mode for Daily_Percentage, Monthly_Percentage ou Percentage
limitDate date A data limite para concessão do desconto precisa ser maior ou igual a data atual. Datas retroativas nesta propriedades retornam erro 500. Sim
mode string Tipo de cobrança Sim
daily_percentage Percentual por dia
daily_amount Valor fixo por dia
monthly_percentage Percentual por mês
fixed Valor fixo
percentage Valor percentual
tax object Taxas adicionais Não
amount decimal Valor fixo
mode string Tipo de cobrança
daily_percentage Percentual por dia
daily_amount Percentual por dia
monthly_percentage Percentual por mês
fixed Valor fixo
percentage Valor percentual
splits array<object> Divisões Não
splitRuleId integer Identificador Sim
metadata dictionary<key, value> Utilizado para salvar informações variadas em formato dicionário <chave, valor> Não
warrantyDays integer Tempo em Dias de Garantia do Serviço Não
whenShouldIssueNfe int Quando emitir a NFe Sim, se a propridade sendNfeToCustomer for utilizada
0 No ato da venda
1 Após a garantia
2 Não emitir
sendNfeToCustomer boolean Enviar nota fiscal ao consumidor Sim, se a propridade whenShouldIssueNfe for utilizada

<aside> <img src="/icons/alert_red.svg" alt="/icons/alert_red.svg" width="40px" /> As propriedades de NFE estão disponíveis apenas no caso de integração com o eNotas.

</aside>

Status relacionados a Order

Status Significado
New Status temporário, se este status persistir, contate o suporte
Succeded Order criada com sucesso
Canceled Order cancelada
Failed Falha durante a criação da Order

Status relacionados a Payment

Status Significado
New Status temporário, se este status persistir, contate o suporte
Pending Pagamento Pendente
Succeded Pagamento realizado com Sucesso
Canceled Pagamento Cancelado
Dispute Pagamento em Disputa
Failed Falha no Pagamento
ChargedBack Disputa Perdida
DisputeSucceeded Disputa Vencida
PartiallySucceded Pagamento parcialmente efetuado
PartiallyCanceled Pagamento parcialmente cancelado

<aside> 💡 Importante: o cupom de desconto altera o valor final da Ordem de Pagamento.

</aside>

Exemplo de requisição

Este é um exemplo de como a sua requisição para criar uma nova Ordem de Pagamento com o meio de pagamento Boleto parcelado, onde os boletos serão gerados e enviados ao consumidor de forma instantânea deve parecer. A propriedade generateAllBoletos é utilizada para gerar todos os boletos. Utilize esta propriedade com o valor false para que os boletos sejam gerados automaticamente, apenas a cada vencimento.

Respostas