拒付

开始之前

您的 API 请求使用访问令牌进行身份验证。任何不包含有效访问令牌的请求都将返回错误。在身份验证中了解更多信息。

基础 URL

UAT：https://transactions.transactional.uat.unico.app/api/public/v1
生产环境：https://transactions.transactional.unico.app/api/public/v1

申请拒付分析

POST /credit/transactions/{transaction_id}/chargeback — 为指定交易申请拒付分析。

请求头

请求头	值
`Authorization`	`Bearer {token}` — 一个有效的访问令牌。

请求体

{
  "datetime": "2023-01-05T03:00:00.000Z",
  "requestor": { "key": "cpf", "value": "USER_CPF" },
  "name": "USER_NAME",
  "reason": "REQUEST_REASON",
  "observation": "GENERAL_OBSERVATIONS",
  "documents": [
    { "label": "FILE_NAME", "data": "JVBERi0xLjQKMSAwI==" }
  ]
}

字段	类型	是否必填	描述
`datetime`	string	是	拒付申请的日期和时间，ISO 8601 格式。
`requestor`	object	是	申请人的信息。
`requestor.key`	string	是	申请人的识别键类型（例如 `cpf`）。
`requestor.value`	string	是	申请人的识别键值。
`name`	string	是	申请人的姓名。
`reason`	string	是	拒付申请的原因。
`observation`	string	否	有关该申请的一般性说明。
`documents`	array	否	与该拒付相关的文件。最多 3 项，每项均为 Base64 编码——仅限 PDF。
`documents[].label`	string	是（每项）	文件名或描述。
`documents[].data`	string	是（每项）	Base64 编码的 PDF 文件。

200 OK

{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0"
}

字段	描述
`id`	生成的拒付 ID。

有关错误响应，请参阅错误 — 交易创建。

获取拒付分析状态

GET /credit/transactions/{transaction_id}/chargeback/{chargeback_id} — 查询指定拒付的状态。

请求头

请求头	值
`Authorization`	`Bearer {token}` — 一个有效的访问令牌。

200 OK

{
  "id": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "status": "waiting"
}

字段	描述
`id`	拒付 ID。
`status`	拒付的当前状态。

有关所有可能的状态，请参阅枚举 — 拒付结果。为优化性能，建议实现 Webhook，而非轮询此端点。

开始之前​

申请拒付分析​

获取拒付分析状态​

开始之前

申请拒付分析

获取拒付分析状态