Criação de Pedido

Para criar um pedido a ser pago no POS integrado você deve utilizar o endpoint Criar um Pedido. Todos os pedido em aberto, com propriedade closed=false, serão enviados aos POSs integrados.

Existem alguns campos adicionais que podem ser enviados dentro de "metadados" para especificar propriedades especificas de pagamento no POS:\

Lista de propriedades do pedido para pagamentos no POS:

AtributoTipoDescrição
terminalsString
Exemplo: "{"SerialNumbers": ["123456789","223456789","323456789"]}"
Este campo especifica uma lista de terminais que irão receber o pedido. Dessa forma você pode filtrar em terminais cada pedido deverá aparecer
No modelo de pagamento direto esse dado é obrigatório e o pedido só poderá ser enviado a um único terminal. No modelo de seleção de pedido serão aceitos uma lista de terminais e, caso o campo não esteja preenchido, o pedido criado irá ser listado em todos os terminais do lojista afiliado.
printOrderReceiptString in ("TRUE", "FALSE")
Default: "FALSE"
Especifica se o POS deve ou não imprimir um recibo após a finalização do pagamento do pedido.
orderDisplayNameStringNome do pedido que irá aparecer no POS para seleção.
transactionType*String in ("debit", "credit", "voucher")Tipo da transação a ser realizada pelo POS. Se o campo vier vazio/nulo, o operador do POS irá poder selecionar o tipo de pagamento.
installmentType*String in ("merchant", "issuer")
Default: "merchant"
Somente utilizado em transações de credito. Define o tipo do parcelamento a ser realizada pelo POS.
installments*String in ("1" a "12")Somente utilizado em transações de credito. Define a quantidade de parcelas para compras com credito. Campo obrigatório para transactionType=credit

*São aceitos somente no modelo de integração de Pagamento Direto\

Exemplos:

POST /orders
{
    "items": [
        {
            "amount": 400,
            "description": "Produto 1",
            "quantity": 2
        }
    ],
    "customer": {
        "name": "exemplo",
        "email": "[email protected]"
    },
    "closed": "false",
    "metadata": {
        "terminals": "{\"SerialNumbers\": [\"123456789\",\"223456789\",\"323456789\"]}",
        "printOrderReceipt": "FALSE",
        "orderDisplayName": "Mesa 3"
    }
}
POST /orders
{
    "items": [
        {
            "amount": 410000,
            "description": "TV",
            "quantity": 1
        }
    ],
    "customer": {
        "name": "exemplo",
        "email": "[email protected]"
    },
    "closed": "false",
    "metadata": {
        "terminals": "{\"SerialNumbers\": [\"123456789\"]}",
        "printOrderReceipt": "FALSE",
        "orderDisplayName": "Mesa 3",
        "transactionType": "credit",
        "installmentType": "merchant",
        "installments": "12"
    }
}
🚧

Limitação de pagamentos no POS

É importante ressaltar que não há limite de pagamentos para pedidos no fluxo de pagamento Listagem de Pedidos. Isso significa que o sistema do POS não restringe o operador em relação a quantidade de transações e em relação ao valor das transações por pedido.

Por exemplo, foi criado um pedido em aberto de R$ 5,00. Para esse pedido o operador do POS pode realizar 2 pagamentos de R$ 4,00, totalizando R$ 8,00 pagos.

O valor da transação por default no POS é sempre o valor total do pedido, mas o operador pode sobrescrever o valor default caso o comprador queira pagar de forma diferente. Isso garante uma maior flexibilidade no momento do pagamento.

No fluxo de Pagamento direto de pedidos, o valor pago é sempre o valor total do pedido. O sistema não permite pagamentos de outros valores.


Did this page help you?