Payment Instrument Limit Change

The payment instrument limit change allows you to modify the limit value of an existing payment instrument.

Request

ENDPOINT

/wallet/WALLET_KEY/payment_instrument/PAYMENT_INSTRUMENT_KEY

METHOD

PATCH

Path Parameters

Field	Type	Description	Characters
wallet_key *	uuidv4	Unique wallet key in UUID v4 format	36
payment_instrument_key *	uuidv4	Unique payment instrument key in UUID v4 format	36

Request Body

{
  "limit_amount": 3000.00
}

Request Body Params

Field	Type	Description	Characters
limit_amount *	float	New payment instrument limit value	-

Note

• The new limit value must be greater than or equal to the used limit (used_limit)
• The new limit value cannot be greater than the wallet's postpaid credit limit (postpaid_credit_limit)
• Only postpaid_card type payment instruments can have their limits updated
• Only default type wallets can have payment instruments with updated limits
• The payment instrument must have active status to have its limit updated

Response

STATUS

200

Response Body: Payment instrument limit updated

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

Response Body Params

Field	Type	Description	Characters
payment_instrument_key *	uuidv4	Unique identification key of the updated instrument in UUID v4 format	36
limit_amount *	float	New instrument limit value after update	-
payment_instrument_status *	string	Payment instrument status	payment_instrument_status Enumerators

payment_instrument_status Enumerators

Enumerator	Description
active	Active instrument
canceled	Canceled instrument

Error Response

STATUS

4xx

Response Body: Error

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

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (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