Assignor Accounts
When registering an assignor, it is mandatory to provide at least one assignment disbursement account for the assignor. During the assignment approval stage by the manager, it is possible to indicate any of the registered accounts for the assignor to receive the disbursement. It is worth noting that if the operation proposer between assignor and fund is a consultant, account maintenance will be the responsibility of the consultancy instead of the manager.
Unlike registration data such as representatives, addresses, and other data, no new analysis will be created when making changes to the assignor's accounts, so the change takes effect immediately. For a disbursement account, the account holder must obligatorily be the assignor, including account ownership, and the account owner's document number is already assumed to be the assignor's.
Be very careful when filling in account data. If the account is invalid, the assignment payment will not occur, and the entire operation will be canceled.
Adding Alternative Account
Request
{
"account_number": "8473124",
"account_digit": "8",
"account_branch": "0001",
"account_type": "checking_account",
"financial_institution_code": "329",
"default_account": false
}
Account Object
| Field | Type | Description | Characters |
|---|---|---|---|
account_number * | string | Account number. | 3-20 |
account_digit * | string | Account digit. | 1 |
account_branch * | string | Account branch. | 4 |
account_type * | string | Account type. | - |
financial_institution_code * | string | Bank code of the account. | 3 |
default_account * | boolean | Default disbursement account. | - |
*Required fields.
Response
{
"account_key": "3c53a94a-2b81-4837-b7eb-8e025e69d81c",
"account_branch": "0001",
"account_number": "8473124",
"account_digit": "8",
"account_type": "checking_account",
"status": "active",
"financial_institution_code": "329",
"financial_institution_ispb": "32402502",
"default_account": false,
}
If the new account is sent with "default_account" true, the old default disbursement account will be made a non-default account, and from then on, the new posted account will be the default disbursement account.
Account Update
It is not possible to change account data. If desired, it is necessary to deactivate the incorrect account and create a new account with valid data.
To change the default disbursement account, simply indicate which will be the new account, and the old one will be automatically changed. It is not possible to set an account as non-default disbursement; you must always indicate the new one.
Request
{
"status": "active",
"default_account": true,
}
Account Object
| Field | Type | Description | Characters |
|---|---|---|---|
status | string | New account status. | See Account Status Enumerators. |
default_account | boolean | Default disbursement account. | - |
*Required fields (none).
Response
{
"account_key": "3c53a94a-2b81-4837-b7eb-8e025e69d81c",
"account_branch": "0001",
"account_number": "8473124",
"account_digit": "8",
"account_type": "checking_account",
"status": "active",
"financial_institution_code": "329",
"financial_institution_ispb": "32402502",
"default_account": true,
}
If the update is sent with "default_account" true, the old default disbursement account will be made a non-default account, and from then on, the new posted account will be the default disbursement account. It is not possible to deactivate a default account or set an inactive account as default.
Enumerators
Account Status
| Enumerator | Description |
|---|---|
| active | Active account available as disbursement option. |
| inactive | Inactive account unavailable for disbursement. |