跳到主要内容

修改支付工具额度

修改支付工具额度允许更改现有支付工具的额度金额。

Request

ENDPOINT
/wallet/WALLET_KEY/payment_instrument/PAYMENT_INSTRUMENT_KEY
MÉTODO
PATCH

路径参数

字段类型描述字符数
wallet_key *uuidv4UUID v4 格式的钱包唯一密钥36
payment_instrument_key *uuidv4UUID v4 格式的支付工具唯一密钥36
Request Body
{
"limit_amount": 3000.00
}

请求体参数

字段类型描述字符数
limit_amount *float支付工具的新额度金额-
说明
  • 新额度金额必须大于或等于已用额度(used_limit
  • 新额度金额不能超过钱包的后付费信用额度(postpaid_credit_limit
  • 只有 postpaid_card 类型的支付工具可以更新其额度
  • 只有 default 类型的钱包可以更新其支付工具的额度
  • 支付工具状态必须为 active 才能更新其额度

Response

STATUS
200
Response Body:已更新支付工具额度
{
"payment_instrument_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"limit_amount": 3000.00,
"payment_instrument_status": "active"
}

响应体参数

字段类型描述字符数
payment_instrument_key *uuidv4UUID v4 格式的已更新工具唯一识别密钥36
limit_amount *float更新后的工具新额度金额-
payment_instrument_status *string支付工具状态payment_instrument_status 枚举值

payment_instrument_status 枚举值

枚举值描述
active工具已激活
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
400CIN000074Bad RequestLimit amount is greater than postpaid credit limit of the wallet.Limite é maior que o limite de crédito pós-pago da carteira.
400CIN000081Bad RequestPayment instrument is not activeInstrumento de pagamento não está ativo
400CIN000110Bad RequestNew limit amount is less than used limitNovo valor do limite é menor que o valor utilizado
403CIN000108ForbiddenWallet type payroll is not allowed for this operationTipo de carteira payroll não é permitido para esta operação
403CIN000113ForbiddenPayment instrument type is not allowed for this operationTipo de instrumento de pagamento não é permitido para esta operação
404CIN000007Wallet not FoundWallet with key: e503fa60-285e-4632-96b6-bf3ad908a23c was not foundCarteira com a chave: e503fa60-285e-4632-96b6-bf3ad908a23c não foi encontrado
404CIN000080Payment Instrument Not FoundPayment instrument was not foundInstrumento de pagamento não foi encontrado