Nesta página
https://api.premepay.com/v1/stores/:id/orders
Utilizando a rota acima você pode adicionar uma ordem de pagamento com Pix.
| 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 |
| 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 (pix) | Sim |
| installments | integer | Número de Parcelas | Sim |
| 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> | |
| 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 |
<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 | 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 | 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 |
<aside> 💡 Importante: o cupom de desconto altera o valor final da Ordem de Pagamento.
</aside>
Este é um exemplo de como a sua requisição para autenticar deve parecer.
200: Ok
400: Bad Request
401: Não autorizado
403: Proibido
500: Internal Server Error
Conteúdo Relacionado
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" width="40px" /> POST - Criar ordem de pagamento - Cartão de Crédito
</aside>
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" width="40px" /> GET - Filtrar vendas
</aside>
