Objetos

Objeto address

Request Body

{
  "street": "Rua do Exemplo, 111",
  "neighborhood": "Bairro do Teste",
  "city": "Aparecida de Goiânia",
  "uf": "GO",
  "complement": "",
  "postal_code": "00000-000",
  "country": "BRA"
}

O objeto address é utilizado para representar endereços em toda a API, endereços no território brasileiro são representados da seguinte maneira:

nome	tipo	descrição
street	string	(obrigatório) Rua do endereço, incluindo o logradouro, evitando, se possível, abreviações.
number	string	Número do imóvel, incluindo letras caso possua.
neighborhood	string	(obrigatório) Bairro, sem abreviações. e.g.: Santa Felicidade
city	string	(obrigatório) Nome completo da cidade, sem abreviações
uf	string	(obrigatório) A unidade federativa, com duas letras maiúsculas. e.g.: SP
complement	string	Quaisquer complementos para localizar o imóvel. e.g.: Apartamento 101, Conjunto 12
postal_code	string	(obrigatório) O código postal da localidade, contendo o hífen.
country	string	(obrigatório) Código ISO 3166-1 alfa-3 do país do endereço.

No caso dos endereços cujo país não seja Brasil ("BRA"), o postal_code e a unidade federativa poderão ser preenchidos livremente.

Objeto payment

Request Body

{
  "total_amount": 10000,
  "shipping_amount": 500,
  "currency": "BRL",
  "is_recurrence": false,
  "transactions": [ . . . ]
}

Um pagamento é representado pelo objeto payment, que possui os seguintes campos:

nome	tipo	descrição
total_amount	inteiro	(obrigatório) Valor monetário total pago
shipping_amount	inteiro	Valor do frete cobrado para entrega
currency	Enumerador	(obrigatório) Moeda de pagamento de acordo com a ISO 4217
is_recurrence	boolean	(obrigatório) Caso este seja um pagamento de recorrência, indicar true nesta flag
transactions	Array de Transaction	(obrigatório) Lista de transações que foram realizadas para o pagamento do pedido (Pagamento com múltiplos cartões)

Objeto transaction - Cartão de Crédito

Request Body

{
  "id": "124234",
  "amount": 10000,
  "bin": "123456",
  "last_4": "1234",
  "cardholder_name": "JOHN SAMPLE",
  "card_fingerprint": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "expiration_date": "2020-11",
  "installments": 6,
  "processor": "stone",
  "payment_type": "credit"
}

Uma transação é representada pelo objeto transaction, que possui os seguintes campos:

nome	tipo	descrição
id	string	(obrigatório) Um identificador no sistema do cliente da transação, deve ser único por pedido
amount	integer	(obrigatório) Valor monetário que representa o valor pago
bin	string	(obrigatório) BIN do cartão utilizado no pagamento
last4	string	(obrigatório) Quatro últimos dígitos do cartão utilizado no pagamento
cardholder_name	string	(obrigatório) Nome do portador, como está escrito no cartão
card_fingerprint	string	(obrigatório) Identificador do cartão no sistema do cliente ("Token")
expiration_date	string	Data de vencimento definida pelo cartão (YYYY-DD)
installments	integer	(obrigatório) Número de parcelas do pagamento
processor	enumerador	(obrigatório) Adquirente ou subadquirente responsável pelo processamento da transação
payment_type	enumerador	(obrigatório) Tipo de meio de pagamento
status	enumerador	Opcional - Último status da transação no momento do envio para a QI Tech - Útil para envio de transações não autorizadas

Enumeradores disponíveis para processor:

cielo
rede
stone
getnet
adyen
global_payments
pagseguro

Objeto transaction - PIX

Request Body

{
  "id": "124234",
  "amount": 10000,
  "payment_type": "pix"
}

Uma transação é representada pelo objeto transaction, que possui os seguintes campos:

nome	tipo	descrição
id	string	(obrigatório) Um identificador no sistema do cliente da transação, deve ser único por pedido
amount	integer	(obrigatório) Valor monetário que representa o valor pago
payment_type	enumerador	(obrigatório) Tipo de meio de pagamento

Objeto dict_key

Request Body

  {
    "key_type": "cpf",
    "key_value": "09991222669"
  }

O objeto dict_key é utilizado para representar os dados da chave de vínculo no DICT do cliente, seja ele o recebedor ou o pagador da transação. Os campos desse objeto são:

nome	tipo	descrição
key_type	string	Enumerador que contém o tipo da chave de vinculo no DICT.
key_value	string	Contém a chave de vínculo cadastrada no DICT.

Os enumeradores para o campo key_type são os mesmos definidos na API do DICT: cpf,cnpj,email,phone e evp.

Objeto account

Request Body

{
    "participant": "17315359",
    "branch": "0000",
    "account_number": "10442",
    "account_digit": "6",
    "account_type": "CACC"
}

Objeto que representa os dados de uma conta.

nome	tipo	descrição
participant	string	ISPB da instituição detentora da conta
branch	string	Agência da Conta
account_number	string	Número da Conta sem o dígito
account_digit	string	Dígito da conta
account_type	enum	Tipo da conta de origem, possíveis valores: "CACC", "SLRY" e "SVGS"

Objeto phone

Request Body

{
  "international_dial_code": "1",
  "area_code": "11",
  "number": "999999999",
  "type": "mobile",
  "validated": false
}

Um objeto phone representa um número telefônico, dentro ou fora do Brasil e sua classificação. Para isso, os campos são:

nome	tipo	descrição
international_dial_code	string	(obrigatório) Código de discagem internacional, sem zero ou +, somente números
area_code	string	(obrigatório) Código de área, sem zero, somente números
number	string	(obrigatório) Número do telefone, sem o hífen
type	enum	(obrigatório) Tipo de número: celular, residencial, comercial, etc.
validated	booleano	Caso o número de telefone tenha sido validado (SMS ou Ligação), enviar true neste campo

Existem os seguintes enumeradores para tipo de telefone: residential, commercial, mobile

Objeto seller

Request Body

{
  "id": "COD",
  "name": "Restaurante do Aeroporto de Congonhas",
  "type": "legal_person",
  "document_number": "00.000.000/0001-00",
  "email": "seller@gmail.com",
  "registration_date": "2019-12-20T15:23:12-03:00",
  "url": "https://www.qitech.com.br",
  "phone": {
      "international_dial_code": "1",
      "area_code": "11",
      "number": "999999999",
      "type": "mobile"
  },
  "address": {
    "street": "Rua do Exemplo",
    "neighborhood": "Bairro do Teste",
    "city": "Aparecida de Goiânia",
    "number": "1000",
    "uf": "GO",
    "complement": "Térreo",
    "postal_code": "00000-000"
  }
}

O objeto seller representa uma loja ou vendedor que realiza a venda ou entrega do pedido. Os dados a serem enviados podem ser vistos abaixo:

nome	tipo	descrição
id	string	(obrigatório) O código identificador da loja (Ou vendedor em MarketPlace) no cliente
name	string	(obrigatório) O nome da loja (Ou vendedor em MarketPlace)
type	enum	Enumerador que representa se o seller é uma pessoa física ou pessoa jurídica
document_number	string	(obrigatório) O CNPJ ou CPF do seller
url	string	Endereço para a página do seller na plataforma
email	string	O e-mail do seller
registration_date	date	(obrigatório) A data de cadastro do seller
phone	phone	O telefone do seller
address	address	(obrigatório) O endereço da loja, caso seja uma loja física

Enumeradores de type:

natural_person
legal_person

Objeto customer

Request Body

{
  "id": "5ce7fab5-8165-44a5-9b89-bb2d6d61e4f4",
  "name": "Mary Sample",
  "gender": "female",
  "document_number": "000.000.000-00",
  "registration_date": "2019-12-20T15:23:12Z",
  "email": "test@sample.com",
  "birthdate": "1990-01-02",
  "address": { . . . },
  "phone": { . . . }
}

O objeto customer representa os dados de quem realizou a compra do pedido, com o próprio cartão de crédito. Ele é composto por:

nome	tipo	descrição
id	string	(obrigatório) Um identificador único do comprador ou usuário
name	string	(obrigatório) Nome completo
gender	enum	O gênero do customer, de acordo com a lista de enumeradores.
document_number	string	(obrigatório) O CPF, formatado adequadamente
registration_date	date	A data quando o usuário se cadastrou no sistema do cliente
email	string	(obrigatório) O e-mail do usuário
birthdate	date	A data de nascimento do customer
address	address	(obrigatório) O endereço residencial do comprador/usuário
phone	phone	(obrigatório) O telefone colhidos do comprador/usuário

Enumeradores de gênero:

male
female

Objeto device

Request Body

{
  "session_id": "595c46c1-b8c2-449d-8a86-6aeba2e5b0da",
  "platform": "android",
  "browser": "chrome",
  "ip": "243.178.100.37"
}

O objeto device descreve dados do dispositivo usado para realizar a compra. Os seguintes dados são passados:

nome	tipo	descrição
session_id	string	(obrigatório) O identificador da sessão, repassada também no device scan
platform	enumerador	Enumerador do sistema operacional em uso
browser	enumerador	Enumerador do browser em uso (Ou aplicativo)
ip	string	O ip de origem da compra, de acordo com a padronização desta documentação. Atenção, IPs iniciados em 10. , 172.16. e 192.168.* em geral são internos e portanto não são aplicáveis para prevenção a fraudes**

Enumeradores de plataforma:

android
ios
windows
linux

Enumeradores de browser:

firefox
chrome
safari
app

Objeto address​

Objeto payment​

Objeto transaction - Cartão de Crédito​

Objeto transaction - PIX​

Objeto dict_key​

Objeto account​

Objeto phone​

Objeto seller​

Objeto customer​

Objeto device​

Objeto address

Objeto payment

Objeto transaction - Cartão de Crédito

Objeto transaction - PIX

Objeto dict_key

Objeto account

Objeto phone

Objeto seller

Objeto customer

Objeto device