Alteração de Limite de Instrumento de Pagamento

A alteração de limite de instrumento de pagamento permite alterar o valor do limite de um instrumento de pagamento existente.

Request

ENDPOINT

/wallet/WALLET_KEY/payment_instrument/PAYMENT_INSTRUMENT_KEY

MÉTODO

PATCH

Path Parameters

Campo	Tipo	Descrição	Caracteres
wallet_key *	uuidv4	Chave única da carteira no formato UUID v4	36
payment_instrument_key *	uuidv4	Chave única do instrumento de pagamento no formato UUID v4	36

Request Body

{
  "limit_amount": 3000.00
}

Request Body Params

Campo	Tipo	Descrição	Caracteres
limit_amount *	float	Novo valor do limite do instrumento de pagamento	-

Observação

• O novo valor do limite deve ser maior ou igual ao limite utilizado (used_limit)
• O novo valor do limite não pode ser maior que o limite de crédito pós-pago da carteira (postpaid_credit_limit)
• Apenas instrumentos de pagamento do tipo postpaid_card podem ter seus limites atualizados
• Apenas carteiras do tipo default podem ter instrumentos de pagamento com limites atualizados
• O instrumento de pagamento deve estar com status active para ter seu limite atualizado

Response

STATUS

200

Response Body: Limite de instrumento de pagamento atualizado

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

Response Body Params

Campo	Tipo	Descrição	Caracteres
payment_instrument_key *	uuidv4	Chave única de identificação do instrumento atualizado no formato UUID v4	36
limit_amount *	float	Novo valor do limite do instrumento após a atualização	-
payment_instrument_status *	string	Status do instrumento de pagamento	Enumeradores payment_instrument_status

Enumeradores payment_instrument_status

Enumerador	Descrição
active	Instrumento ativo
canceled	Instrumento cancelado

Error Response

STATUS

4xx

Response Body: Error

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

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (pt-br) translation
400	CIN000074	Bad Request	Limit amount is greater than postpaid credit limit of the wallet.	Limite é maior que o limite de crédito pós-pago da carteira.
400	CIN000081	Bad Request	Payment instrument is not active	Instrumento de pagamento não está ativo
400	CIN000110	Bad Request	New limit amount is less than used limit	Novo valor do limite é menor que o valor utilizado
403	CIN000108	Forbidden	Wallet type payroll is not allowed for this operation	Tipo de carteira payroll não é permitido para esta operação
403	CIN000113	Forbidden	Payment instrument type is not allowed for this operation	Tipo de instrumento de pagamento não é permitido para esta operação
404	CIN000007	Wallet not Found	Wallet with key: e503fa60-285e-4632-96b6-bf3ad908a23c was not found	Carteira com a chave: e503fa60-285e-4632-96b6-bf3ad908a23c não foi encontrado
404	CIN000080	Payment Instrument Not Found	Payment instrument was not found	Instrumento de pagamento não foi encontrado