As entidades representam os principais objetos de dados utilizados na comunicação com a API da Integração Remota da Cielo Smart. Elas definem a estrutura das informações que são enviadas e recebidas durante as operações de pedidos e pagamentos.

Em seguida, você aprende os atributos específicos de cada entidade.

Order

A Order é uma representação de um pedido para a venda de um ou mais produtos e/ou serviços. É fundamental que exista uma Order para que um pagamento seja realizado na Cielo Smart.

Campo	Tipo	Descrição	Obrigatório
`id`	String	UUID que identifica unicamente o pedido	Criado pela API
`number`	String	Número do pedido. Geralmente, esse número representa o identificador do pedido em um sistema externo através da integração com parceiros	Não
`reference`	String	Referência do pedido. Utilizada para facilitar seu acesso ou localização	Não
`status`	String	Status do pedido (ENTERED, RE-ENTERED, PAID, CANCELED e CLOSED)	Sim
`created_at`	String	Data de criação do pedido. A data deve estar no formato: YYYY-MM-DDThh:mm:ssZ (Exemplo: 20151020T13:13:29.000Z)	Criado pela API
`updated_at`	String	Data da última atualização do pedido. A data deve estar no formato: YYYY-MM-DDThh:mm:ssZ (Exemplo: 20151020T13:13:29.000Z)	Criado pela API
`items`	Array - Order Item	Lista de itens contidos no pedido	Sim
`notes`	String	Campo disponível para uso do Merchant	Não
`transactions`	Array - Transaction	Lista de transações de pagamento (ou outros tipos) efetuadas no pedido	Sim
`price`	Number	Valor total do pedido em centavos. Exemplo: O valor R$ 10,00 é representado como 1000	Sim
`remaining`	Number	Valor restante do pagamento do pedido em centavos. Exemplo: O valor R$ 10,00 é representado como 1000	Sim
`payment_code`	String	Forma de pagamento estabelecida na criação do pedido. Caso não seja informado, será necessário escolher a forma no POS. Funcionalidade indisponível para LIO	Não

Order item

O Order Item é uma representação dos itens presentes em uma Order.

ℹ️
É obrigatória a existência de, no mínimo, um item para uma Order.

Campo	Tipo	Descrição	Obrigatório
`sku`	String	SKU do produto. Exemplo: c2f5fb9a-5542-406e-8b79-17892329cda8	Sim
`name`	String	Nome do produto	Não
`description`	String	Descrição do produto	Não
`unit_price`	Number	Valor unitário do produto em centavos. Exemplo: O valor R$ 10,00 é representado como 1000	Sim
`quantity`	Number	Quantidade de itens. Caso não seja informado, será considerado o valor 1	Não
`unit_of_measure`	String	Unidade de medida (EACH, HOURS, DAYS, SECONDS, CRATE_OF_12, SIX_PACK, GALLON e LITRE)	Sim
`details`	String	Detalhes do produto	Não
`created_at`	String	Data de criação do pedido. A data deve estar no formato: YYYY-MM-DDThh:mm:ssZ (Exemplo: 20151020T13:13:29.000Z)	Não
`updated_at`	String	Data de última atualização do pedido. A data deve estar no formato: YYYY-MM-DDThh:mm:ssZ (Exemplo: 20151020T13:13:29.000Z)	Sim

Transaction

A Transaction é uma representação com todos os pagamentos que foram realizados em uma Order. O objetivo é utilizá-la para consultar os pagamentos (transactions) que foram efetuados em uma Order.

Campo	Tipo	Descrição	Obrigatório
`id`	String	UUID que identifica unicamente a transação	Sim
`external_id`	String	Identificador unico ordem	Sim
`status`	String	Status da transação (CONFIRMED, PENDING e CANCELLED)	Sim
`terminal_number`	Number	Número do terminal da Cielo Smart em que o pagamento foi realizado	Sim
`authorization_code`	Number	Código de autorização da transação	Sim
`number`	String	Número Sequencial Único (NSU) da transação	Sim
`amount`	Number	Valor da transação em centavos. Exemplo: O valor de R$ 10,00 é representado como 1000	Sim
`transaction_type`	String	Tipo da transação (PAYMENT e CANCELLATION)	Sim

Card

O Card é uma representação do cartão que foi utilizado para realizar o pagamento/transação.

Campo	Tipo	Descrição	Obrigatório
`brand`	String	Bandeira do cartão (VISA e MASTER).	Sim
`mask`	Number	Número do cartão mascarado	Sim

Payment product

O Payment Product é uma representação da forma de pagamento utilizada para realizar um pagamento.
Ex.: Crédito, Débito, etc.

Campo	Tipo	Descrição	Obrigatório
`primary_product_name`	String	Forma de pagamento (CREDITO ou DEBITO)	Sim
`secondary_product_name`	String	Tipo de pagamento (A VISTA, PARCELADO LOJA ou PARCELADO ADM)	Sim
`number_of_quotas`	Number	Número de parcelas (0 para pagamentos à vista)	Sim