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 Cartão

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
currency string Código da moeda corrente a ser cobrada Não
Se não informado, será cobrado em “BRL”
description string Descrição da venda Sim
voucher string Cupom de desconto Não
payment object Informações do pagamento Sim
type string Tipo do pagamento (credit) Sim
installments string Número de Parcelas Sim
cardId integer Identificador do cartão de crédito Sim
payLater boolean Utilize caso queira pré-autorizar e reservar o valor por até 28 dias, para depois capturar. Não
splits array<object> Divisões Não
splitRuleId int Pode ser um ou mais Sim
metadata dictionary<key, value> Utilizado para salvar informações variadas em formato dicionário <chave, valor> Não
warrantyDays int Tempo em Dias de Garantia do Serviço Não
whenShouldIssueNfe object Quando emitir a NFe Sim, se 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 propridade whenShouldIssueNfe for utilizada
paymentForwardSubMerchant array <object> Dados do Seller Sim
subMerchantId int Será o ID na sua plataforma identificando aquele Seller Sim
MCC int Código da Categoria do Comerciante Sim
identificationNumber int CNPJ do Seller Sim
legalName string Nome da empresa Sim
street string Endereço da Empresa Sim
number int Número Sim
city string Cidade Sim
state string Estado Sim
zipcode int CEP Sim
country string País Sim
phone int Telefone Sim
url string Site da empresa Sim

<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
PreAuthorized Pagamento pré-autorizado
EarlyFraudWarning Alerta de Chargeback recebido

<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 Cartão de Crédito deve parecer.

Respostas