Histórico da Página

JSON de Pagamento de Pedido

Este JSON é utilizado para enviar informações de pagamento relacionadas a um pedido por meio de um serviço de integração. Ele inclui informações sobre a chave de identificação da integração, tipo e chave do pedido, além de um objeto de pagamento detalhado.

Campos:

• integrationHubServiceId (string, obrigatório)

  • Descrição: Chave de identificação da integração. Este campo é essencial para identificar de forma única a integração em questão.
  • Exemplo: "string"

• orderKeyType (string, obrigatório)

  • Descrição: Tipo de chave do pedido. Define como o pedido é identificado e pode assumir os valores "TABLE", "CARD" ou "ORDER_ID".
  • Valores possíveis: "TABLE", "CARD", "ORDER_ID"
  • Exemplo: "TABLE"

• orderKey (string, obrigatório)

  • Descrição: Chave específica do pedido. Este campo deve conter o identificador do pedido de acordo com o tipo especificado em orderKeyType.
  • Exemplo: "string"

• paymentObject (object, obrigatório)

  • Descrição: Objeto que contém todas as informações necessárias para o processamento do pagamento do pedido.

  • Campos do paymentObject:

    • printOrderAtPos (boolean, obrigatório)

      • Descrição: Controla se o pedido deve ser impresso no ponto de venda (POS).
      • Valores:
        • true: O pedido será impresso no POS.
        • false: O pedido não será impresso no POS.
      • Exemplo: true

    • generateInvoice (boolean, obrigatório)

      • Descrição: Controla se a fatura deve ser gerada no POS.
      • Valores:
        • true: A fatura será gerada no POS.
        • false: A fatura não será gerada no POS (a integração gerará a fatura).
      • Exemplo: true

    • printInvoiceAtPos (boolean, obrigatório)

      • Descrição: Controla se a fatura deve ser impressa no POS.
      • Valores:
        • true: A fatura será impressa no POS.
        • false: A fatura não será impressa no POS.
      • Exemplo: true

    • sendInvoiceEmail (boolean, obrigatório)

      • Descrição: Controla se a fatura será enviada por e-mail.
      • Valores:
        • true: A fatura será enviada por e-mail.
        • false: A fatura não será enviada por e-mail.
      • Exemplo: true

    • summaryExtract (boolean, obrigatório)

      • Descrição: Indica se um resumo deve ser incluído na resposta da solicitação.
      • Valores:
        • true: O resumo será incluído.
        • false: O resumo não será incluído.
      • Exemplo: true

    • customerDocument (string)

      • Descrição: Documento do cliente. Necessário quando documentInReceipt é true.
      • Exemplo: "string"

    • documentInReceipt (boolean, obrigatório)

      • Descrição: Indica se o documento do cliente deve aparecer na fatura.
      • Valores:
        • true: O documento do cliente aparecerá na fatura.
        • false: O documento do cliente não aparecerá na fatura.
      • Exemplo: true

    • numberPersons (number)

      • Descrição: Indica o número de pessoas associado ao pedido no momento do fechamento.
      • Exemplo: 0

    • removeServiceFee (boolean, obrigatório)

      • Descrição: Indica se a taxa de serviço deve ser removida do total da conta.
      • Valores:
        • true: A taxa de serviço será removida.
        • false: A taxa de serviço não será removida.
      • Exemplo: true

    • methods (array de objetos, obrigatório)

      • Descrição: Lista de métodos de pagamento utilizados para o pedido.

      • Campos do methods:

        • value (number, obrigatório)

          • Descrição: Valor do pagamento para o método específico. Aceita até 4 casas decimais.
          • Exemplo: 0.00

        • currency (string, obrigatório)

          • Descrição: Código da moeda no formato ISO 4217.
          • Exemplo: "string"

        • type (string, obrigatório)

          • Descrição: Tipo de método de pagamento. Pode ser "OFFLINE" ou "ONLINE".
          • Valores possíveis: "OFFLINE", "ONLINE"
          • Exemplo: "OFFLINE"

        • method (string, obrigatório)

          • Descrição: Método de pagamento utilizado. Pode ser um dos seguintes valores: "CREDIT", "DEBIT", "MEAL_VOUCHER", "FOOD_VOUCHER", "DIGITAL_WALLET", "PIX", "CASH", "CREDIT_DEBIT", "COUPON", "REDEEM", "PREPAID_REDEEM", "OTHER".
          • Valores possíveis: "CREDIT", "DEBIT", "MEAL_VOUCHER", "FOOD_VOUCHER", "DIGITAL_WALLET", "PIX", "CASH", "CREDIT_DEBIT", "COUPON", "REDEEM", "PREPAID_REDEEM", "OTHER"
          • Exemplo: "CREDIT"

        • brand (string)

          • Descrição: Marca do cartão selecionado no campo method. Deve ser preenchido somente se method for "CREDIT", "DEBIT", "CREDIT_DEBIT", "MEAL_VOUCHER" ou "FOOD_VOUCHER".
          • Valores possíveis: "VISA", "MASTERCARD", "DINERS", "AMEX", "HIPERCARD", "ELO", "AURA", "DISCOVER", "VR_BENEFICIOS", "SODEXO", "TICKET", "GOOD_CARD", "BANESCARD", "SOROCARD", "POLICARD", "VALECARD", "AGICARD", "JCB", "CREDSYSTEM", "CABAL", "GREEN_CARD", "VEROCHEQUE", "AVISTA", "OTHER"
          • Exemplo: "VISA"

        • methodInfo (string)

          • Descrição: Informações adicionais sobre o método de pagamento. Pode ser usado para indicar o nome da carteira digital ou número de autorização.
          • Exemplo: "string"

        • changeFor (number)

          • Descrição: Indica o valor total que será pago em dinheiro pelo cliente e que deve ser considerado para o cálculo do troco. Obrigatório apenas quando method for "CASH".
          • Exemplo: 0.00

    • orderAmount (number, obrigatório)

      • Descrição: Valor final do pedido (total + taxas - descontos).
      • Exemplo: 0.00

    • discounts (number)

      • Descrição: Valor total de descontos aplicados ao pedido.
      • Exemplo: 0.00

    • fees (number, obrigatório)

      • Descrição: Valor total das taxas aplicadas ao pedido.
      • Exemplo: 0.00

    • total (number, obrigatório)

      • Descrição: Valor total do pedido (soma dos itens).
      • Exemplo: 0.00