Assignor accounts
Disbursement accounts can be sent already in the assignor registration (accounts) or added later through this page. The assignor must have at least one account for an assignment contract to be proposed. During the assignment approval stage by the manager, it is possible to indicate any of the accounts registered for the assignor to receive the disbursement.
Unlike registration data such as representatives, addresses and other data, no new analysis is created when changing the assignor's accounts, so the change takes effect immediately. For a disbursement account, the account holder must be the assignor, including the account ownership, and the account owner's document number is already assumed to be the assignor's.
Be very careful when filling in the account data. If the account is invalid, the assignment payment will not occur, and the entire operation will be canceled.
The account routes are not available on manager-api. The assignor's accounts are maintained by the consultant (consultant-api) or by the assignor itself (assignor-api). A manager that needs to add or deactivate an account must send it already in the assignor's initial registration (accounts), ask the consultant or the assignor, or contact the integration team at integracao.dtvm@qitech.com.br.
Adding an alternative account
| Profile | Host | Required permission |
|---|---|---|
| Consultant | consultant-api | Register Assignor |
| Assignor | assignor-api | Write |
Base URL for each host: Environments (Hosts).
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 becomes a non-default account, and from then on the newly posted account is the default disbursement account.
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | ASR000004 | Assignor not found for the assignor_registry_key provided. Check whether the assignor_registry_key is correct. |
| 409 | ASR000072 | An active account with the same combination of bank, branch, account and digit already exists. Do not submit duplicate accounts — check the accounts already registered for the assignor. |
| 400 | ASR000087 | Account information must contain digits only. Send account_branch, account_number, account_digit and financial_institution_code with digits only. |
| 404 | ASR000071 | Financial institution not found. Validate the financial_institution_code (bank code) provided. |
Authentication, permission and host errors: see API Errors.
Account update
It is not possible to change an account's data. If needed, deactivate the incorrect account and create a new account with valid data.
To change the default disbursement account, simply indicate the new account and the old one is changed automatically. It is not possible to set an account as non-default; you must always indicate the new one.
| Profile | Host | Required permission |
|---|---|---|
| Consultant | consultant-api | Register Assignor |
| Assignor | assignor-api | Write |
Base URL for each host: Environments (Hosts).
Request
{
"status": "active",
"default_account": true
}
Account Object
| Field | Type | Description | Characters |
|---|---|---|---|
status | string | New account status. | See Account status enumerators. |
default_account | boolean | Only accepts true: makes this the default disbursement account. | - |
Send at least one of the two 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": true
}
If the update is sent with "default_account" true, the old default disbursement account becomes a non-default account, and from then on the newly posted account is the default disbursement account. It is not possible to deactivate a default account, or to set an inactive account as default.
Errors
| Status | Code | When it happens |
|---|---|---|
| 404 | ASR000004 | Assignor not found for the assignor_registry_key provided. Check whether the assignor_registry_key is correct. |
| 404 | ASR000073 | Account not found for the account_key provided. Check whether the account_key belongs to the assignor. |
| 400 | ASR000074 | It is not possible to deactivate/unset a default account. First set another account as default (default_account=true on another account) before deactivating the current one. |
| 400 | ASR000075 | No information was sent for the update. Provide status or default_account in the request body. |
Authentication, permission and host errors: see API Errors.
Enumerators
Account Status
| Enumerator | Description |
|---|---|
| active | Active account, available as a disbursement option. |
| inactive | Inactive account, unavailable for disbursement. |