A custom field is an attribute you can create and apply to your objects. Its main purpose is to create a custom categorisation of your objects, as well as attaching relevant business data to them.
Attribute | Description |
---|---|
id string | The ID of the custom field. |
object string | Always custom_field . |
key string | The key of the custom field, which is a unique and readable identifier, as opposed to its ID which is only unique. |
name string | The name of the custom field, which is an understandable description of its purpose. |
object_types array | The types of object this custom field can be applied to. Can be a combination of payment_order , transaction and counterparty_account . |
type integer | The type of the custom field. Can be either select or text . |
values array | List of values the custom field can take. Only applicable to custom fields with select type. |
created_at datetime | The UTC timestamp of the creation of the custom field. |