Attributes
id string(36)
Unique identifier for the object.
code string(36)
Unique identifier for the object in your system.
name string(128)
The name of the recipient.
taxId string(14)
The tax ID of the recipient (CPF for individual recipients or CNPJ for businesses recipients)
type enum
The type of the recipient. Can be INDIVIDUALor COMPANY.
| Type | Description |
|---|---|
INDIVIDUAL | Represents a person. |
COMPANY | Represents a business. |
status enum
The status of the recipient. Can be ACTIVE or DELETED.
| Status | Description |
|---|---|
ACTIVE | Indicates that the recipient is active. |
DELETED | Indicates that the recipient has been 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": "80e579ff-e3a6-4573-84ff-30de777e7861",
"code": "a1fc515c-ce4a-45e0-8802-2696b2c0337a",
"name": "Bruce Wayne",
"taxId": "37515868066",
"type": "INDIVIDUAL",
"status": "ACTIVE",
"createdAt": "2022-06-08T15:02:00Z",
"updatedAt": null,
"deletedAt": null,
"metadata": {
"CUSTOM_FIELD_NAME": "CUSTOM_FIELD_VALUE"
}
}