Edit wallet

Wallet editing overrides the default settings (configuration_data) of the bill wallet and all its child objects.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY

METHOD

PUT

Path parameters

Field	Type	Description	Characters
`account_key`	uuidv4	Unique account identification key in uuid v4 format	36
`requester_profile_key`	uuidv4	Unique wallet identification key in uuid v4 format	36

Request Body

{
  "max_payment_days": 1,
  "protest_settings": {
    "days_to_protest": 0
  },
  "bankruptcy_protest_settings": {
    "days_to_bankruptcy_protest": 0
  },
  "write_off_settings": {
    "days_to_write_off": 0
  },
  "fine_settings": {
    "fine_type": "absolute",
    "fine_amount": 10,
    "days_to_fine": 0
  },
  "interest_settings": {
    "interest_type": "workdays_daily_amount",
    "interest_amount": 10,
    "days_to_interest": 0
  },
  "qr_code_settings": {
    "pix_key": "248ebea3-9bdd-44b3-a8b9-7f2bd34cd7bf",
    "qr_code_on_discharge_enabled": false
  },
  "cnab_settings": {
    "default_bank": "qi_scd",
    "preferred_layout": "400"
  }
}

Request Body Params

Field	Type	Description	Characters
`max_payment_days` *	integer	Maximum calendar days the bill will remain available for payment after due date (can be at most 365)	-
`write_off_settings`	object	Default write-off configuration	write_off_settings object
`protest_settings`	object	Default protest configuration	protest_settings object
`bankruptcy_protest_settings`	object	Default bankruptcy protest configuration	bankruptcy_protest_settings object
`fine_settings`	object	Default fine configuration	fine_settings object
`interest_settings`	object	Default interest configuration	interest_settings object
`qr_code_settings`	object	Default PIX QR Code configuration (for bolePix)	qr_code_settings object
`cnab_settings`	object	Default CNAB file configuration	cnab_settings object

write_off_settings object

Field	Type	Description	Characters
`days_to_write_off` *	integer	Days after due date for the bill to be automatically written off	-

protest_settings object

Field	Type	Description	Characters
`days_to_protest` *	integer	Days after due date for the bill to be automatically protested	-

bankruptcy_protest_settings object

Field	Type	Description	Characters
`days_to_bankruptcy_protest` *	integer	Days after due date for a bankruptcy protest process to be automatically started	-

fine_settings object

Option 1: absolute value fine (fine_type=absolute)

Field	Type	Description	Characters
`fine_type` *	string	Fine type	fine_type enumerators
`fine_amount` *	float	Fine absolute value	-
`days_to_fine` *	integer	Days after due date for the fine to be charged	-

Option 2: percentage value fine (fine_type=percentage)

Field	Type	Description	Characters
`fine_type` *	string	Fine type	fine_type enumerators
`fine_percentage` *	integer	Fine percentage value, from 1 to 100	-
`days_to_fine` *	integer	Days after due date for the fine to be charged	-

fine_type enumerators

Enumerator	Description
absolute	absolute value
percentage	percentage value

interest_settings object

Option 1: interest using absolute values (interest_type=calendar_days_daily_amount or interest_type=workdays_daily_amount)

Field	Type	Description	Characters
`interest_type` *	string	Interest type	interest_type enumerators
`interest_amount` *	float	Amount to be charged per determined time unit (business days or calendar days)	-
`days_to_interest` *	integer	Days after due date to start charging interest	-

Option 2: interest using percentage values (interest_type=calendar_days_monthly_percentage)

Field	Type	Description	Characters
`interest_type` *	string	Interest type	interest_type enumerators
`interest_percentage` *	integer	Percentage to be charged per determined time unit (business days or calendar days)	-
`days_to_interest` *	integer	Days after due date to start charging interest	-

interest_type enumerators

Enumerator	Description
calendar_days_daily_amount	Daily amount on calendar days
workdays_daily_amount	Daily amount on business days
calendar_days_monthly_percentage	Monthly interest percentage charged based on calendar days

qr_code_settings object

Field	Type	Description	Characters
`pix_key` *	uuidv4	Random type Pix key	36
`qr_code_on_discharge_enabled` *	boolean	Determines if QR Code information will appear in the return file (CNAB)	-

Information

The PIX copy and paste will be returned in the CNAB file at positions 029 to 105.

Attention!

If the qr_code_settings object is sent in the request, this wallet will have bolePix generation as its default configuration. BolePix are bills whose payment is linked to a Pix QR Code. Therefore, the payer can make bill payments both using the bill's digital lines and by reading the linked Pix QR Codes. If payment is made via QR Code, financial settlement occurs instantly. Regarding notifications, two webhooks are sent: one at the time of the PIX transfer (payment notice, bill goes to payment_notice status); and another a few seconds or minutes later, after confirmation of discharge at CIP/Nuclea (paid, bill goes to paid status).

cnab_settings object

Field	Type	Description	Characters
`default_bank`	string	Default bank layout for CNAB file processing	default_bank enumerators
`preferred_layout`	string	Preferred layout for CNAB files	preferred_layout enumerators

default_bank enumerators

Enumerator	Description
santander	Banco Santander
itau	Banco Itaú
bradesco	Banco Bradesco
qi_scd	QI SCD

preferred_layout enumerators

Enumerator	Description
400	CNAB 400 Layout
240	CNAB 240 Layout

Response

STATUS

200

Response Body

{
  "requester_profile_key": "c92e8666-e310-4a72-b15e-753525684ae2",
  "requester_profile_code": "329-48-2628-2625918",
  "request_control_key": "727a5f00-1f86-4a7a-9aa5-c45cf8a2394c",
  "account_key": "e0089187-ab08-42c0-82f2-259d40726117",
  "requester_profile_status": "pending",
  "configuration_data": {
    "max_payment_days": 1,
    "protest_settings": {
      "days_to_protest": 0
    },
    "bankruptcy_protest_settings": {
      "days_to_bankruptcy_protest": 0
    },
    "write_off_settings": {
      "days_to_write_off": 0
    },
    "fine_settings": {
      "fine_type": "absolute",
      "fine_amount": 10,
      "days_to_fine": 0
    },
    "interest_settings": {
      "interest_type": "workdays_daily_amount",
      "interest_amount": 10,
      "days_to_interest": 0
    },
    "qr_code_settings": {
      "pix_key": "248ebea3-9bdd-44b3-a8b9-7f2bd34cd7bf",
      "qr_code_on_discharge_enabled": false
    },
    "cnab_settings": {
      "default_bank": "qi_scd",
      "preferred_layout": "400"
    }
  }
}

Response Body Params

Field	Type	Description	Characters
`requester_profile_key` *	uuidv4	Unique wallet identification key in uuid v4 format	36
`requester_profile_code` *	string	Unique wallet identification code	19
`request_control_key` *	uuidv4	Unique request identification key used by the client in uuid v4 format	36
`account_key` *	uuidv4	Unique account identification key in uuid v4 format	36
`requester_profile_status` *	string	Wallet status	requester_profile_status enumerators
`configuration_data` *	object	Default wallet configurations	configuration_data object

profile_status enumerators

Enumerator	Description
pending	Wallet accepted and pending confirmation
opened	Wallet opened

Error Response

STATUS

4xx

Response Body: Error

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

HTTP Status `status`	QI Code `code`	Title `title`	Description (eng) `description`	Description (pt-br) `translation`
400	QIT000001	Bad Request	Schema Error	Schema Inválido
404	BKS000001	Not Found	Person not found with key: person_key`	Pessoa não encontrada com a chave: person_key`
404	BKS000004	Not Found	Pix key not found: `{pix_key}`	Chave pix não encontrada: `{pix_key}`
403	BKS000005	Forbidden	User is not allowed to do this action	Usuário não tem autorização para fazer essa ação
404	BKS000006	Not Found	The source account key was not found.	A chave da conta de origem não foi encontrada.
400	BKS000007	Bad Request	It was not possible to consult the source account at this time. Please try again in a few minutes.	Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos.
400	BKS000008	Bad Request	The source account is closed.	A conta de origem está fechada.
400	BKS000009	Bad Request	The source account is blocked.	A conta de origem está bloqueada.
403	BKS000010	Forbidden	The pix key owner does not match the account owner.	O proprietário da chave pix não corresponde ao proprietário da conta.
409	BKS000014	Conflict	Request control key already sent or duplicated sent: `{request_control_key}`	Chave de controle da requisição já utilizada ou enviada duplicada: `{request_control_key}`
400	BKS000047	Bad Request	It was not possible to consult the sent pix key at this time. Please try again in a few minutes.	Não foi possível consultar a chave pix enviada no momento. Por favor, tente novamente em alguns minutos.

Request​

Path parameters​

Request Body Params​

write_off_settings object​

protest_settings object​

bankruptcy_protest_settings object​

fine_settings object​

fine_type enumerators​

interest_settings object​

interest_type enumerators​

qr_code_settings object​

cnab_settings object​

default_bank enumerators​

preferred_layout enumerators​

Response​

Response Body Params​

profile_status enumerators​

Error Response​