TOTVS Food Service

Páginas filhas
  • API Order Cartão - Payment

Versões comparadas

Versão antiga 4

changes.mady.by.user Usuário desconhecido (mothe.cristiano)

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Usuário desconhecido (mothe.cristiano)

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Dicionário da Request

Este endpoint processa pagamentos e emite a NFC-e, gerenciando o envio e acompanhamento do status de pagamento até sua conclusão e emissão da nota fiscal.


  • Estrutura Payment:

Campo

Valor

Descrição

integrationHubServiceId *stringIdentificador único da integração
orderKeyType *enum Tipo de chave do pedido (veja na tabela orderKeyType)
orderKey *arrayChave do pedido correspondente 

paymentObject *

arrayObjeto que contém todas as informações necessárias para o processamento do pagamento do pedido

orderAmount *

numberValor final do pedido (total + taxas - descontos)

discounts 

numberValor total de descontos aplicados ao pedido

fees *

numberValor total das taxas aplicadas ao pedido

total *

numberValor total do pedido (soma dos itens).


  • Estrutura Payment (dentro de paymentObject):
CampoValorDescrição
printOrderAtPos * boolean

Controla se o pedido deve ser impresso no ponto de venda (POS).

generateInvoice *booleanControla se a fatura deve ser gerada no POS
printInvoiceAtPos  *booleanControla se a fatura deve ser impressa no POS
sendInvoiceEmail *booleanControla se a fatura será enviada por e-mail
summaryExtract *boolean

Indica se um resumo deve ser incluído na resposta da solicitação

customerDocument stringDocumento do cliente. Necessário quando documentInReceipt é true
documentInReceipt  *boolean

Indica se o documento do cliente deve aparecer na fatura

numberPersons numberIndica o número de pessoas associado ao pedido no momento do fechamento
removeServiceFee *booleanIndica se a taxa de serviço deve ser removida do total da conta
methods *arrayLista de métodos de pagamento utilizados para o pedido


  • Estrutura Payment - paymentObject  (dentro de methods):
CampoValorDescrição
currency *stringCódigo da moeda no formato ISO 4217
type *enumTipo de método de pagamento. Pode ser "OFFLINE" ou "ONLINE".
method *enumMétodo de pagamento utilizado. (veja a tabela method)
brand enum

Marca do cartão selecionado no campo method (veja a tabela brand)

methodInfostringInformações adicionais sobre o método de pagamento
changeFor numberIndica 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"



Tabela de auxiliares e enumerações

  • Estrutura Enumeração orderKeyType
    Âncora
    table_orderKeyType
    table_orderKeyType

Enum

Valor

Descrição

TABLETABLEIdentifica o pedido pelo número da mesa
CARDCARDIdentifica o pedido pelo número do cartão
ORDER_IDORDER_IDIdentifica o pedido por um ID exclusivo


  • Estrutura Payment - methods (dentro de type):

Enum

Valor

Descrição

OFFLINEOFFLINEPagamento será realizado OFFILINE
ONLINE ONLINE Pagamento será realizado ONLINE


  • Estrutura Payment - methods (dentro de type):

Enum

Valor

Descrição

CREDITCREDITForma de pagmendo crédito
DEBITDEBITForma de pagmendo débito
MEAL_VOUCHERMEAL_VOUCHERForma de pagmendo vale refeição
FOOD_VOUCHERFOOD_VOUCHERForma de pagmendo vale
DIGITAL_WALLETDIGITAL_WALLETForma de pagmendo alimentação
PIXPIXForma de pagmendo PIX
CASHCASHForma de pagmendo dinheiro
CREDIT_DEBITCREDIT_DEBITForma de pagmendo crédito em débito
COUPONCOUPONForma de pagmendo cupom
REDEEMREDEEMForma de pagmendo resgater
PREPAID_REDEEMPREPAID_REDEEMForma de pagmendo resgater pré-pago
OTHEROTHERForma de pagmendo outro
Dica
titleCampos obrigatórios

Campos marcaos com o * (asteristico) o seu preenchimento é obrigatório


...

04. ERROS
Âncora
erros
erros

A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:

...