按密钥查询支付工具条目

按密钥查询支付工具条目将返回特定条目的完整详情，包括所有相关发票项目。

Request

ENDPOINT

/wallet/WALLET_KEY/payment_instrument/PAYMENT_INSTRUMENT_KEY/payment_instrument_entry/PAYMENT_INSTRUMENT_ENTRY_KEY

MÉTODO

GET

路径参数

字段	类型	描述	字符数
`wallet_key`	uuidv4	UUID v4 格式的钱包唯一密钥	36
`payment_instrument_key`	uuidv4	UUID v4 格式的支付工具唯一密钥	36
`payment_instrument_entry_key`	uuidv4	UUID v4 格式的条目唯一密钥	36

Response

STATUS

200

Response Body：支付工具条目详情

{
  "payment_instrument_entry_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "payment_instrument_entry_amount": 150.00,
  "payment_instrument_entry_type": "purchase",
  "payment_instrument_entry_status": "concluded",
  "payment_instrument_entry_data": {
    "merchant_name": "Merchant Name",
    "merchant_country": "Merchant Country",
    "merchant_postal_code": "Merchant Postal Code",
    "merchant_city": "Merchant City",
    "merchant_street": "Merchant Street"
  },
  "invoice_items": [
    {
      "invoice_item_key": "3571e292-3a83-4011-904d-20ee963022ef",
      "invoice_key": "f2cad6b4-2a68-9572-99a7-2849c8d6ecf8",
      "wallet_entry_key": null,
      "payment_instrument_entry_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "installment_number": 1,
      "invoice_description": "Compra no estabelecimento XYZ",
      "amount": 150.00,
      "used_limit": 150.00,
      "invoice_item_status": "concluded",
      "invoice_item_due_date": "2024-02-15",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "created_at": "2024-01-15T10:30:00Z"
}

响应体参数

字段	类型	描述	字符数
`payment_instrument_entry_key` *	uuidv4	uuid v4 格式的条目唯一识别密钥	36
`payment_instrument_entry_amount` *	number	条目金额	-
`payment_instrument_entry_type` *	string	支付工具条目类型	payment_instrument_entry_type 枚举值
`payment_instrument_entry_status` *	string	工具条目状态	payment_instrument_entry_status 枚举值
`invoice_items` *	object array	相关发票项目	invoice_item 对象
`payment_instrument_entry_data`	object	附加数据	payment_instrument_entry_data 对象
`created_at` *	string	创建日期（ISO 8601 UTC 格式）	-

payment_instrument_entry_data 对象（purchase | withdraw）

字段	类型	描述	字符数
`merchant_name` *	string	商家名称	-
`merchant_country` *	string	商家所在国家	-
`merchant_postal_code` *	string	商家邮政编码	-
`merchant_city` *	string	商家所在城市	-
`merchant_street` *	string	商家街道地址	-

payment_instrument_entry_data 对象（postpaid_card_issuance）

字段	类型	描述	字符数
`postpaid_card_issuance_name` *	string	后付费卡发卡名称	-
`payment_instrument_key` *	string	UUID v4 格式的支付工具唯一密钥	36
`postpaid_card_key` *	string	UUID v4 格式的后付费卡唯一密钥	36

说明

此条目仅适用于代扣卡钱包卡。

payment_instrument_entry_type 枚举值

枚举值	描述
purchase	购买
withdraw	提款
postpaid_card_issuance	后付费卡发卡

payment_instrument_entry_status 枚举值

枚举值	描述
processing_conclusion	正在处理结算
processing_cancellation	正在处理取消
concluded	条目已结算
canceled	条目已取消

说明

支付工具条目可以直接从 processing_conclusion 转换为 processing_cancellation 和 canceled。在这种情况下，不会创建发票项目。

invoice_item 对象

字段	类型	描述	字符数
`invoice_item_key` *	uuidv4	uuid v4 格式的发票项目唯一识别密钥	36
`invoice_key` *	uuidv4	uuid v4 格式的发票唯一识别密钥	36
`wallet_entry_key`	uuidv4	uuid v4 格式的钱包条目唯一识别密钥	36
`payment_instrument_entry_key`	uuidv4	uuid v4 格式的支付工具条目唯一识别密钥	36
`installment_number` *	integer	分期编号	-
`invoice_description` *	string	发票项目描述	-
`amount` *	number	项目金额	-
`used_limit` *	number	已用额度	-
`invoice_item_status` *	string	发票项目状态	invoice_item_status 枚举值
`invoice_item_due_date` *	string	项目到期日（YYYY-MM-DD 格式）	10
`created_at` *	string	创建日期（ISO 8601 UTC 格式）	-

invoice_item_status 枚举值

枚举值	描述
concluded	项目已结算（所属发票未支付）
canceled	项目已取消

错误响应

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

HTTP 代码 `status`	QI 代码 `code`	标题 `title`	描述（英文） `description`	描述（葡文） `translation`
404	CIN000007	Wallet not Found	Wallet with key: abeca0d0-a09d-4b3b-a495-40b553422ced was not found	Carteira com a chave: abeca0d0-a09d-4b3b-a495-40b553422ced não foi encontrado
404	CIN000017	Payment Instrument Not Found	Payment instrument was not found	Instrumento de pagamento não foi encontrado
404	CIN000086	Not Found	Payment instrument entry was not found	Transação para instrumento de pagamento não foi encontrada

Request​

路径参数​

Response​

响应体参数​

payment_instrument_entry_data 对象（purchase | withdraw）​

payment_instrument_entry_data 对象（postpaid_card_issuance）​

payment_instrument_entry_type 枚举值​

payment_instrument_entry_status 枚举值​

invoice_item 对象​

invoice_item_status 枚举值​

错误响应​