Attributes
id string(36)
Unique identifier for the object.
type string(16)
The type of bank account. Can be CHECKING or SAVINGS.
code string(36)
Unique identifier for the object in your system.
holderName string(128)
The name of the person or business that owns the bank account.
holderTaxId string(14)
The tax ID of the account holder (CPF for individual account holders or CNPJ for businesses account holders).
holderType enum
The type of entity that holds the account. Can be INDIVIDUAL or COMPANY.
branchNumber string(16)
**
accountNumber string(32)
**
bankId string(36)
The ISPB code of the bank associated with the account.
status enum
The status of the bank account. Can be ACTIVE or DELETED.
| Status | Description |
|---|---|
ACTIVE | Indicates that the bank account is active. |
DELETED | Indicates that the bank account is deleted. |
createdAt datetime
Time at which the object was created.
updatedAt datetime
Time at which the object was updated.
deletedAt datetime
Time at which the object was deleted.
metadata Metadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Example
{
"id": "a8a9c988-c2ba-44b9-af2d-ee6fcc00e269",
"code": "ade39877-cb26-42bc-b151-8e6eef84284d",
"type": "CHECKING",
"holderName": "Bruce Wayne",
"holderTaxId": "37515868066",
"holderType": "INDIVIDUAL",
"branchNumber": "0001",
"accountNumber": "11111-1",
"bankId": "60701190",
"status": "ACTIVE",
"createdAt": "2022-06-06T11:48:21Z",
"updatedAt": null,
"deletedAt": null,
"metadata": {
"CUSTOM_FIELD_NAME": "CUSTOM_FIELD_VALUE"
}
}