跳到主要内容

对象

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"
}

address 对象用于在整个 API 中表示地址，巴西境内地址的表示方式如下：

名称类型描述
streetstring（必填）
地址的街道，包括公路名称，尽可能避免缩写。
numberstring物业编号，如有字母则包含字母。
neighborhoodstring（必填）
区域，不缩写。
例如：Santa Felicidade
citystring（必填）
城市全名，不缩写
ufstring（必填）
联邦单位，两个大写字母。
例如：SP
complementstring用于定位物业的任何补充信息。
例如：Apartamento 101, Conjunto 12
postal_codestring（必填）
该地点的邮政编码，含连字符。
countrystring（必填）
地址国家的 ISO 3166-1 alpha-3 代码。

对于国家不是巴西（"BRA"）的地址，postal_code 和联邦单位可以自由填写。

payment 对象​

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

支付由 payment 对象表示，具有以下字段：

名称类型描述
total_amount整数（必填）
支付的总货币金额
shipping_amount整数配送费用
currency枚举（必填）
根据 ISO 4217 的支付货币
is_recurrenceboolean（必填）
如果这是周期性付款，在此标志中指示 true
transactionsTransaction 数组（必填）
为订单付款执行的交易列表（多卡支付）

transaction 对象 - 信用卡​

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"
}

交易由 transaction 对象表示，具有以下字段：

名称类型描述
idstring（必填）
客户系统中交易的标识符，每笔订单必须唯一
amountinteger（必填）
表示支付金额的货币金额
binstring（必填）
支付使用的卡片 BIN
last4string（必填）
支付使用的卡片后四位数字
cardholder_namestring（必填）
持卡人姓名，如卡片上所写
card_fingerprintstring（必填）
客户系统中的卡片标识符（"Token"）
expiration_datestring卡片到期日期（YYYY-DD）
installmentsinteger（必填）
支付分期数
processor枚举（必填）
负责处理交易的收单机构或子收单机构
payment_type枚举（必填）
支付方式类型
status枚举可选——发送给 QI Tech 时交易的最新状态——用于发送未授权的交易

processor 可用枚举值：

  • cielo
  • rede
  • stone
  • getnet
  • adyen
  • global_payments
  • pagseguro

transaction 对象 - PIX​

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

交易由 transaction 对象表示，具有以下字段：

名称类型描述
idstring（必填）
客户系统中交易的标识符，每笔订单必须唯一
amountinteger（必填）
表示支付金额的货币金额
payment_type枚举（必填）
支付方式类型

dict_key 对象​

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

dict_key 对象用于表示客户（无论是收款人还是付款人）在 DICT 中的绑定密钥数据。该对象的字段为：

名称类型描述
key_typestring包含 DICT 中绑定密钥类型的枚举值。
key_valuestring包含在 DICT 中注册的绑定密钥。

key_type 字段的枚举值与 DICT API 中定义的相同：cpf、cnpj、email、phone 和 evp。

account 对象​

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

表示账户数据的对象。

名称类型描述
participantstring账户所属机构的 ISPB
branchstring账户支行
account_numberstring不含校验位的账户号码
account_digitstring账户校验位
account_type枚举来源账户类型，可能值："CACC"、"SLRY" 和 "SVGS"

phone 对象​

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

phone 对象表示巴西境内或境外的电话号码及其分类。字段如下：

名称类型描述
international_dial_codestring（必填）
国际拨号代码，不含零或加号，仅数字
area_codestring（必填）
区号，不含零，仅数字
numberstring（必填）
电话号码，不含连字符
type枚举（必填）
号码类型：手机、住宅、商务等。
validated布尔值如果电话号码已验证（短信或电话），在此字段发送 true

电话类型的枚举值为：residential、commercial、mobile

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"
  }
}

seller 对象表示执行订单销售或交付的商店或卖家。需要发送的数据如下：

名称类型描述
idstring（必填）
客户系统中商店（或 MarketPlace 卖家）的标识码
namestring（必填）
商店名称（或 MarketPlace 卖家名称）
type枚举表示卖家是自然人还是法人的枚举值
document_numberstring（必填）
卖家的 CNPJ 或 CPF
urlstring平台上卖家页面的地址
emailstring卖家的电子邮件
registration_datedate（必填）
卖家的注册日期
phonephone卖家的电话
addressaddress（必填）
如果是实体店，提供店铺地址

type 枚举值：

  • natural_person
  • legal_person

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": { . . . }
}

customer 对象表示使用自己的信用卡下单的人员数据。由以下字段组成：

名称类型描述
idstring（必填）
买家或用户的唯一标识符
namestring（必填）
全名
gender枚举客户的性别，根据枚举值列表。
document_numberstring（必填）
CPF，格式正确
registration_datedate用户在客户系统中注册的日期
emailstring（必填）
用户的电子邮件
birthdatedate客户的出生日期
addressaddress（必填）
买家/用户的住宅地址
phonephone（必填）
收集到的买家/用户电话

性别枚举值：

  • male
  • female

device 对象​

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

device 对象描述用于购物的设备数据。传递以下数据：

名称类型描述
session_idstring（必填）
会话标识符，也在 Device Scan 中传递
platform枚举正在使用的操作系统枚举
browser枚举正在使用的浏览器（或应用程序）枚举
ipstring购物的来源 IP，符合本文档的标准。注意，以 10.、172.16. 和 192.168. 开头的 IP 通常是内部 IP，因此不适用于欺诈预防*

平台枚举值：

  • android
  • ios
  • windows
  • linux

浏览器枚举值：

  • firefox
  • chrome
  • safari
  • app