取消支付工具

取消支付工具允许取消现有的支付工具，将其状态更改为 canceled，同时自动取消关联的后付费卡。

Request

ENDPOINT

/wallet/WALLET_KEY/payment_instrument/PAYMENT_INSTRUMENT_KEY/cancel

MÉTODO

PATCH

路径参数

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

说明

此请求没有请求体。取消操作仅通过路径参数执行。

Response

STATUS

200

Response Body：已取消支付工具

{
  "payment_instrument_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "payment_instrument_status": "canceled"
}

响应体参数

字段	类型	描述	字符数
`payment_instrument_key` *	uuidv4	UUID v4 格式的已取消工具唯一识别密钥	36
`payment_instrument_status` *	string	取消后的工具状态	payment_instrument_status 枚举值

payment_instrument_status 枚举值

枚举值	描述
canceled	工具已取消

行为说明

支付工具取消后将转为 canceled 状态
关联的后付费卡也将自动取消
已取消的工具无法用于新交易

错误响应

STATUS

4xx

Response Body: Error

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

Request​

路径参数​

Response​

响应体参数​

payment_instrument_status 枚举值​

错误响应​