Brex: Team schemas
62 Brex schemas with complete fields and constraints.
← Team operations · All schemas
Create card — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The `spend_controls` field is required when `limit_type` = `CARD`. The `shipping_address` field is required for physical cards, and the first 2 lines of the address must be under 60 characters long. |
card_attribute_preferences | JSON | Optional | |
card_attribute_preferences (anyOf 1) | JSON | Alternative | |
card_attribute_preferences (anyOf 1) (allOf 1) | Model | All variants apply | Expand Create card — request body — body card attribute preferences three domain secure enabled preference three domain secure enabled preference |
card_attribute_preferences (anyOf 2) | null | Alternative | |
card_name | string | Required within parent | Minimum length: 1 |
card_type | string | Required within parent | One of: VIRTUAL, PHYSICAL |
limit_type | string | Required within parent | `limit_type = CARD` for vendor cards. Vendor cards must have a `card_type` of `VIRTUAL` and do not rely on the user specific limit. For corporate cards, `limit_type = USER`. Learn more about different card types [here](https://support.brex.com/what-are-the-different-types-of-cards-i-can-get/). One of: CARD, USER |
mailing_address | JSON | Optional | |
mailing_address (anyOf 1) | JSON | Alternative | |
mailing_address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get card — response body — billing address |
mailing_address (anyOf 2) | null | Alternative | |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | |
metadata (anyOf 2) | null | Alternative | |
owner | Model | Required within parent | Expand Create card — request body — body owner |
spend_controls | JSON | Optional | |
spend_controls (anyOf 1) | JSON | Alternative | |
spend_controls (anyOf 1) (allOf 1) | Model | All variants apply | Expand Create card — request body — body / spend_controls / spend_duration: MONTHLY, QUARTERLY, YEARLY, ONE TIME spend duration: MONTHLY, QUARTERLY, YEARLY, ONE TIME |
spend_controls (anyOf 2) | null | Alternative |
Referenced models: Get card — response body — billing address, Create card — request body — body card attribute preferences three domain secure enabled preference three domain secure enabled preference, Create card — request body — body owner, Create card — request body — body / spend_controls / spend_duration: MONTHLY, QUARTERLY, YEARLY, ONE TIME spend duration: MONTHLY, QUARTERLY, YEARLY, ONE TIME
Create card — request body — body / owner / type: USER
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).type | string | Required within parent | One of: USER |
$ (allOf 2).user_id | string | Required within parent |
Create card — request body — body / spend_controls / spend_duration: MONTHLY, QUARTERLY, YEARLY, ONE TIME spend duration: MONTHLY, QUARTERLY, YEARLY, ONE TIME
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | When `limit_type = CARD`, `spend_controls` must be set. When `limit type = USER`, `spend_controls` must be `null`. |
allowed_merchant_details | JSON | Optional | |
allowed_merchant_details (anyOf 1) | array | Alternative | List of merchants where card transactions are allowed. Cannot be used together with blocked_merchant_details. Maximum 50 merchant details. Maximum items: 50 |
allowed_merchant_details (anyOf 1)[] | Model | Each item | Expand Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details array item |
allowed_merchant_details (anyOf 2) | null | Alternative | |
blocked_merchant_details | JSON | Optional | |
blocked_merchant_details (anyOf 1) | array | Alternative | List of merchants where card transactions are blocked. Cannot be used together with allowed_merchant_details. Maximum 50 merchant details. Maximum items: 50 |
blocked_merchant_details (anyOf 1)[] | Model | Each item | Expand Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details array item |
blocked_merchant_details (anyOf 2) | null | Alternative | |
lock_after_date | JSON | Optional | |
lock_after_date (anyOf 1) | string | Alternative | Format: date |
lock_after_date (anyOf 2) | null | Alternative | |
parent_budget_id | JSON | Optional | |
parent_budget_id (anyOf 1) | string | Alternative | If using the Empower platform, a new `budget` will be created for this card. You can specify a `parent_budget` that your new `budget` will be nested under. If `parent_budget_id` is null, we will nest the new budget under the top-level account `budget`. |
parent_budget_id (anyOf 2) | null | Alternative | |
policy_id | JSON | Optional | |
policy_id (anyOf 1) | string | Alternative | |
policy_id (anyOf 2) | null | Alternative | |
reason | JSON | Optional | |
reason (anyOf 1) | string | Alternative | |
reason (anyOf 2) | null | Alternative | |
spend_duration | string | Required within parent | Spend limit refresh frequency - MONTHLY: The spend limit refreshes every month - QUARTERLY: The spend limit refreshes every quarter - YEARLY: The spend limit refreshes every year - ONE_TIME: The limit does not refresh One of: MONTHLY, QUARTERLY, YEARLY, ONE_TIME |
spend_limit | Model | Required within parent | Expand Create transfer — request body — body amount |
Referenced models: Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details array item, Create transfer — request body — body amount
Create card — request body — body card attribute preferences three domain secure enabled preference three domain secure enabled preference
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
three_domain_secure_enabled_preference | JSON | Optional | |
three_domain_secure_enabled_preference (anyOf 1) | JSON | Alternative | |
three_domain_secure_enabled_preference (anyOf 1) (allOf 1) | string | All variants apply | Whether to enable 3-D secure protocol on this card. One of: THREE_DOMAIN_SECURE_ENABLED, THREE_DOMAIN_SECURE_DISABLED |
three_domain_secure_enabled_preference (anyOf 2) | null | Alternative |
Create card — request body — body owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | discriminator: {"mapping": {"USER": "#/components/schemas/team__UserOwner"}, "propertyName": "type"} |
$ (oneOf 1) | Model | Alternative | Expand Create card — request body — body / owner / type: USER |
Referenced models: Create card — request body — body / owner / type: USER
Create department — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the department |
description (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name of the department Minimum length: 1 |
Create location — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the location |
description (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name of the location Minimum length: 1 |
Create secure email to send card number — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expiry_days | JSON | Optional | |
expiry_days (anyOf 1) | integer | Alternative | Link expiry in number of days. Defaults to 30 Format: int32 Maximum: 30 |
expiry_days (anyOf 2) | null | Alternative | |
message | JSON | Optional | |
message (anyOf 1) | string | Alternative | Message to send with the card details |
message (anyOf 2) | null | Alternative | |
recipient_email | string | Required within parent | Email address to send card details to |
sender_name | string | Required within parent | Sender name. Shows up in the subject of the email |
Create title — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | Name of the title Minimum length: 1 |
Create user — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cost_center_id | JSON | Optional | |
cost_center_id (anyOf 1) | string | Alternative | |
cost_center_id (anyOf 2) | null | Alternative | |
department_id | JSON | Optional | |
department_id (anyOf 1) | string | Alternative | |
department_id (anyOf 2) | null | Alternative | |
email | string | Required within parent | Format: email |
first_name | string | Required within parent | Minimum length: 1 |
last_name | string | Required within parent | Minimum length: 1 |
legal_entity_id | JSON | Optional | |
legal_entity_id (anyOf 1) | string | Alternative | The legal entity to assign the user to. Defaults to the account's default legal entity. |
legal_entity_id (anyOf 2) | null | Alternative | |
location_id | JSON | Optional | |
location_id (anyOf 1) | string | Alternative | |
location_id (anyOf 2) | null | Alternative | |
manager_id | JSON | Optional | |
manager_id (anyOf 1) | string | Alternative | |
manager_id (anyOf 2) | null | Alternative | |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | The metadata or customized attributes of the user. Maximum number of entries: 100 Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | |
metadata (anyOf 2) | null | Alternative | |
title_id | JSON | Optional | |
title_id (anyOf 1) | string | Alternative | |
title_id (anyOf 2) | null | Alternative |
Get card number — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Card number, CVV, and expiration date of a card. |
cvv | string | Required within parent | |
expiration_date | Model | Required within parent | Expand Get card — response body — expiration date |
holder_name | string | Required within parent | |
id | string | Required within parent | |
number | string | Required within parent |
Referenced models: Get card — response body — expiration date
Get card — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Only cards with limit_type = CARD have spend_controls |
billing_address | Model | Required within parent | Expand Get card — response body — billing address |
budget_id | JSON | Optional | |
budget_id (anyOf 1) | string | Alternative | |
budget_id (anyOf 2) | null | Alternative | |
card_name | JSON | Optional | |
card_name (anyOf 1) | string | Alternative | |
card_name (anyOf 2) | null | Alternative | |
card_type | JSON | Optional | |
card_type (anyOf 1) | JSON | Alternative | |
card_type (anyOf 1) (allOf 1) | string | All variants apply | Known values: VIRTUAL, PHYSICAL |
card_type (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | The timestamp when the card was created |
expiration_date | Model | Required within parent | Expand Get card — response body — expiration date |
has_been_transferred | boolean | Optional | Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions \ at online vendors where this card was previously used before the transfer. |
id | string | Required within parent | |
last_four | string | Required within parent | |
limit_type | string | Required within parent | `limit_type = CARD` for vendor cards. Vendor cards must have a `card_type` of `VIRTUAL` and do not rely on the user specific limit. For corporate cards, `limit_type = USER`. Learn more about different card types [here](https://support.brex.com/what-are-the-different-types-of-cards-i-can-get/). Known values: CARD, USER |
mailing_address | JSON | Optional | |
mailing_address (anyOf 1) | JSON | Alternative | |
mailing_address (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get card — response body — billing address |
mailing_address (anyOf 2) | null | Alternative | |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | |
metadata (anyOf 2) | null | Alternative | |
owner | Model | Required within parent | Expand Get card — response body — owner |
partner | JSON | Optional | |
partner (anyOf 1) | string | Alternative | The partner that manages this card, if any. |
partner (anyOf 2) | null | Alternative | |
spend_controls | JSON | Optional | |
spend_controls (anyOf 1) | JSON | Alternative | |
spend_controls (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit |
spend_controls (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | JSON | Alternative | |
status (anyOf 1) (allOf 1) | string | All variants apply | Known values: ACTIVE, SHIPPED, LOCKED, TERMINATED |
status (anyOf 2) | null | Alternative |
Referenced models: Get card — response body — billing address, Get card — response body — expiration date, Get card — response body — owner, Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit
Get card — response body — billing address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed). |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City, district, suburb, town, or village. |
city (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Two-letter country code (ISO 3166-1 alpha-2). |
country (anyOf 2) | null | Alternative | |
line1 | JSON | Optional | |
line1 (anyOf 1) | string | Alternative | Address line 1, no PO Box. |
line1 (anyOf 2) | null | Alternative | |
line2 | JSON | Optional | |
line2 (anyOf 1) | string | Alternative | Address line 2 (e.g., apartment, suite, unit, or building). |
line2 (anyOf 2) | null | Alternative | |
phone_number | JSON | Optional | |
phone_number (anyOf 1) | string | Alternative | Phone number. |
phone_number (anyOf 2) | null | Alternative | |
postal_code | JSON | Optional | |
postal_code (anyOf 1) | string | Alternative | ZIP or postal code. |
postal_code (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. |
state (anyOf 2) | null | Alternative |
Get card — response body — expiration date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Card expiration year and month. Cards expire on the last day of the expiration month. The expiration date is in UTC for cards starting with 555671, 428803 and 485932. And the expiration date is in PST for cards starting with 511572. |
month | JSON | Required within parent | |
month (anyOf 1) | integer | Alternative | Format: int32 |
month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
year | JSON | Required within parent | |
year (anyOf 1) | integer | Alternative | Format: int32 |
year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get card — response body — owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | discriminator: {"mapping": {"USER": "#/components/schemas/team__UserOwner"}, "propertyName": "type"} |
$ (anyOf 1) | Model | Alternative | Expand Get card — response body — owner / type: USER |
Referenced models: Get card — response body — owner / type: USER
Get card — response body — owner / type: USER
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2).type | string | Required within parent | Known values: USER |
$ (allOf 2).user_id | string | Required within parent |
Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_merchant_details | JSON | Optional | |
allowed_merchant_details (anyOf 1) | array | Alternative | List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured. |
allowed_merchant_details (anyOf 1)[] | Model | Each item | Expand Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details array item |
allowed_merchant_details (anyOf 2) | null | Alternative | |
blocked_merchant_details | JSON | Optional | |
blocked_merchant_details (anyOf 1) | array | Alternative | List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured. |
blocked_merchant_details (anyOf 1)[] | Model | Each item | Expand Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details array item |
blocked_merchant_details (anyOf 2) | null | Alternative | |
lock_after_date | JSON | Optional | |
lock_after_date (anyOf 1) | string | Alternative | The `lock_after_date` is in UTC. Format: date |
lock_after_date (anyOf 2) | null | Alternative | |
reason | JSON | Optional | |
reason (anyOf 1) | string | Alternative | |
reason (anyOf 2) | null | Alternative | |
spend_available | JSON | Optional | |
spend_available (anyOf 1) | JSON | Alternative | |
spend_available (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
spend_available (anyOf 2) | null | Alternative | |
spend_duration | JSON | Optional | |
spend_duration (anyOf 1) | JSON | Alternative | |
spend_duration (anyOf 1) (allOf 1) | string | All variants apply | Spend limit refresh frequency - MONTHLY: The spend limit refreshes every month - QUARTERLY: The spend limit refreshes every quarter - YEARLY: The spend limit refreshes every year - ONE_TIME: The limit does not refresh Known values: MONTHLY, QUARTERLY, YEARLY, ONE_TIME |
spend_duration (anyOf 2) | null | Alternative | |
spend_limit | JSON | Optional | |
spend_limit (anyOf 1) | JSON | Alternative | |
spend_limit (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
spend_limit (anyOf 2) | null | Alternative |
Referenced models: Get transfer — response body — amount, Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details array item
Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Merchant details used for restricting or blocking transactions. |
name | string | Required within parent | The name of the merchant. |
Get company — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountType | string | Required within parent | Known values: BREX_CLASSIC, BREX_EMPOWER |
id | string | Required within parent | |
legal_name | string | Required within parent | |
mailing_address | Model | Required within parent | Expand Get card — response body — billing address |
Referenced models: Get card — response body — billing address
Get cost center — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
name | string | Required within parent | Name of the cost center |
Get department — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the department |
description (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
name | string | Required within parent | Name of the department |
Get legal entity — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Brex legal entity. |
billingAddress | JSON | Required within parent | |
billingAddress (allOf 1) | Model | All variants apply | Expand Get card — response body — billing address |
billingAddress (allOf 2) | JSON | All variants apply | The billing address of this legal entity. Also used as billing address for cards issued to users who belong to this entity. |
createdAt | string | Required within parent | Timestamp, in UTC, when this legal entity was created. Format: date-time |
displayName | string | Required within parent | The display name of this legal entity. |
id | string | Required within parent | The ID of this legal entity. |
isDefault | boolean | Optional | Whether this is the default entity of the account. |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | The possible statuses for an entity's verification in Brex. Known values: UNSUBMITTED, UNVERIFIED, IN_PROGRESS, VERIFIED, REJECTED |
status (allOf 2) | JSON | All variants apply | The current status of this legal entity. |
Referenced models: Get card — response body — billing address
Get location — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the location |
description (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
name | string | Required within parent | Name of the location |
Get title — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
name | string | Required within parent | Name of the title |
Get user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cost_center_id | JSON | Optional | |
cost_center_id (anyOf 1) | string | Alternative | |
cost_center_id (anyOf 2) | null | Alternative | |
custom_fields | JSON | Optional | |
custom_fields (anyOf 1) | array | Alternative | A list of custom field values associated with the user. |
custom_fields (anyOf 1)[] | Model | Each item | Expand Get user — response body — custom fields array item |
custom_fields (anyOf 2) | null | Alternative | |
department_id | JSON | Optional | |
department_id (anyOf 1) | string | Alternative | |
department_id (anyOf 2) | null | Alternative | |
email | string | Required within parent | Email address of the user |
first_name | string | Required within parent | First name of the user |
id | string | Required within parent | |
last_name | string | Required within parent | Last name of the user |
legal_entity_id | JSON | Optional | |
legal_entity_id (anyOf 1) | string | Alternative | |
legal_entity_id (anyOf 2) | null | Alternative | |
location_id | JSON | Optional | |
location_id (anyOf 1) | string | Alternative | |
location_id (anyOf 2) | null | Alternative | |
manager_id | JSON | Optional | |
manager_id (anyOf 1) | string | Alternative | The user id of the manager of this user |
manager_id (anyOf 2) | null | Alternative | |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | The metadata or customized attributes of the user. Maximum number of entries: 100 Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | |
metadata (anyOf 2) | null | Alternative | |
remote_display_id | JSON | Optional | |
remote_display_id (anyOf 1) | string | Alternative | Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz |
remote_display_id (anyOf 2) | null | Alternative | |
role_name | JSON | Optional | |
role_name (anyOf 1) | string | Alternative | The user's role, as shown in the Brex dashboard. |
role_name (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | JSON | Alternative | |
status (anyOf 1) (allOf 1) | string | All variants apply | Status of the user Known values: INVITED, ACTIVE, DISABLED, PENDING_ACTIVATION, INACTIVE, ARCHIVED |
status (anyOf 2) | null | Alternative | |
title_id | JSON | Optional | |
title_id (anyOf 1) | string | Alternative | |
title_id (anyOf 2) | null | Alternative |
Referenced models: Get user — response body — custom fields array item
Get user — response body — custom fields array item
Referenced models: Get user — response body — custom fields array item value The value of the custom field Boolean list value, Get user — response body — custom fields array item value The value of the custom field Boolean value, Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date list value, Get user — response body — custom fields array item value The value of the custom field Date value, Get user — response body — custom fields array item value The value of the custom field Decimal list value, Get user — response body — custom fields array item value The value of the custom field Decimal value, Get user — response body — custom fields array item value The value of the custom field Enum list value, Get user — response body — custom fields array item value The value of the custom field Enum value, Get user — response body — custom fields array item value The value of the custom field Money list value, Get user — response body — custom fields array item value The value of the custom field Money value, Get user — response body — custom fields array item value The value of the custom field Option string list value, Get user — response body — custom fields array item value The value of the custom field Option string value, Get user — response body — custom fields array item value The value of the custom field String list value, Get user — response body — custom fields array item value The value of the custom field String value, Get user — response body — custom fields array item value The value of the custom field Timestamp list value, Get user — response body — custom fields array item value The value of the custom field Timestamp value
Get user — response body — custom fields array item value Base class for custom field values
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Base class for custom field values |
data_type | JSON | Required within parent | |
data_type (allOf 1) | string | All variants apply | The type of the custom field data. Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING |
data_type (allOf 2) | JSON | All variants apply | The type of the custom field data. |
value_type | JSON | Required within parent | |
value_type (allOf 1) | string | All variants apply | The type of the custom field value. Known values: SINGLE_VALUE, LIST |
value_type (allOf 2) | JSON | All variants apply | The type of the custom field value. |
Get user — response body — custom fields array item value The value of the custom field Boolean list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Boolean list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | boolean | Each item | The data of the custom field. |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: BOOLEAN |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Boolean value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Boolean value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | boolean | Alternative | The data of the custom field. |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: BOOLEAN |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Date list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Date list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | string | Each item | The data of the custom field. Format: date |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: DATE |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Multiple value wrapper for custom fields |
value_type | JSON | Required within parent | |
value_type (allOf 1) | string | All variants apply | The type of the custom field value. Known values: SINGLE_VALUE, LIST |
value_type (allOf 2) | JSON | All variants apply | The type of the custom field value. |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Date value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Date value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | string | Alternative | The data of the custom field. Format: date |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: DATE |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Single value wrapper for custom fields |
value_type | JSON | Required within parent | |
value_type (allOf 1) | string | All variants apply | The type of the custom field value. Known values: SINGLE_VALUE, LIST |
value_type (allOf 2) | JSON | All variants apply | The type of the custom field value. |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Decimal list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Decimal list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | JSON | Each item | |
data (anyOf 1)[] (anyOf 1) | number | Alternative | The data of the custom field. |
data (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: DECIMAL |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Decimal value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Decimal value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | JSON | Alternative | |
data (anyOf 1) (anyOf 1) | number | Alternative | The data of the custom field. |
data (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: DECIMAL |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Enum list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Enum list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | string | Each item | The data of the custom field. Format: enum |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: ENUM |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Enum value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Enum value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | string | Alternative | The data of the custom field. Format: enum |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: ENUM |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Money list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Money list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | Model | Each item | Expand Get transfer — response body — amount |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: MONEY |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get transfer — response body — amount, Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Money value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Money value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | JSON | Alternative | |
data (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get transfer — response body — amount |
data (anyOf 1) (allOf 2) | JSON | All variants apply | The data of the custom field. |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: MONEY |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get transfer — response body — amount, Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Option string list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Option string list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | Model | Each item | Expand Get user — response body — custom fields array item value The value of the custom field Option string list value data array item |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: OPTION_STRING |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Option string list value data array item
Get user — response body — custom fields array item value The value of the custom field Option string list value data array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Option string fields have a label and a identifier. |
option_id | JSON | Optional | |
option_id (anyOf 1) | string | Alternative | The identifier when custom field data is of type option string. |
option_id (anyOf 2) | null | Alternative | |
option_label | JSON | Optional | |
option_label (anyOf 1) | string | Alternative | The label when custom field data is of type option string. |
option_label (anyOf 2) | null | Alternative |
Get user — response body — custom fields array item value The value of the custom field Option string value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Option string value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | JSON | Alternative | |
data (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Option string list value data array item |
data (anyOf 1) (allOf 2) | JSON | All variants apply | The data of the custom field. |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: OPTION_STRING |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Option string list value data array item
Get user — response body — custom fields array item value The value of the custom field String list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | String list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | string | Each item | The data of the custom field. |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: STRING |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field String value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | String value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | string | Alternative | The data of the custom field. |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: STRING |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Timestamp list value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timestamp list value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | array | Alternative | |
data (anyOf 1)[] | string | Each item | The data of the custom field. Format: date-time |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: TIMESTAMP |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date list value Base class for custom field values
Get user — response body — custom fields array item value The value of the custom field Timestamp value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timestamp value for a custom field |
data | JSON | Optional | |
data (anyOf 1) | string | Alternative | The data of the custom field. Format: date-time |
data (anyOf 2) | null | Alternative | |
data_type | string | Required within parent | The type of the custom field data. Known values: TIMESTAMP |
$ (allOf 1) | Model | All variants apply | Expand Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values |
$ (allOf 2) | Model | All variants apply | Expand Get user — response body — custom fields array item value Base class for custom field values |
Referenced models: Get user — response body — custom fields array item value Base class for custom field values, Get user — response body — custom fields array item value The value of the custom field Date value Base class for custom field values
List cards — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get card — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get card — response body
List cost centers — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get cost center — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get cost center — response body
List departments — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get department — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get department — response body
List legal entities — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get legal entity — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get legal entity — response body
List locations — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get location — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get location — response body
List roles — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand List roles — response body — items item |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: List roles — response body — items item
List roles — response body — items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the role |
description (anyOf 2) | null | Alternative | |
display_name | string | Required within parent | Display name of the role |
id | string | Required within parent | The role ID |
is_custom | boolean | Required within parent | Whether this is a custom role |
List titles — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get title — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get title — response body
List users — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get user — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get user — response body
Lock card — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parameters for locking a card. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description for locking a card |
description (anyOf 2) | null | Alternative | |
reason | string | Required within parent | Reason for card termination. One of: CARD_DAMAGED, CARD_LOST, CARD_NOT_RECEIVED, DO_NOT_NEED_PHYSICAL_CARD, DO_NOT_NEED_VIRTUAL_CARD, FRAUD, OTHER |
Terminate card — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parameters for terminating a card. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description for terminating a card |
description (anyOf 2) | null | Alternative | |
reason | string | Required within parent | Reason for card termination. One of: CARD_DAMAGED, CARD_LOST, CARD_NOT_RECEIVED, DO_NOT_NEED_PHYSICAL_CARD, DO_NOT_NEED_VIRTUAL_CARD, FRAUD, OTHER |
Update card — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters. Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | |
metadata (anyOf 2) | null | Alternative | |
spend_controls | JSON | Optional | |
spend_controls (anyOf 1) | JSON | Alternative | |
spend_controls (anyOf 1) (allOf 1) | Model | All variants apply | Expand Update card — request body — body spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend duration, spend limit |
spend_controls (anyOf 2) | null | Alternative |
Update card — request body — body spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend duration, spend limit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_merchant_details | JSON | Optional | |
allowed_merchant_details (anyOf 1) | array | Alternative | List of merchants where card transactions are allowed. Cannot be used together with blocked_merchant_details. Maximum 50 merchant details. Maximum items: 50 |
allowed_merchant_details (anyOf 1)[] | Model | Each item | Expand Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details array item |
allowed_merchant_details (anyOf 2) | null | Alternative | |
blocked_merchant_details | JSON | Optional | |
blocked_merchant_details (anyOf 1) | array | Alternative | List of merchants where card transactions are blocked. Cannot be used together with allowed_merchant_details. Maximum 50 merchant details. Maximum items: 50 |
blocked_merchant_details (anyOf 1)[] | Model | Each item | Expand Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details array item |
blocked_merchant_details (anyOf 2) | null | Alternative | |
lock_after_date | JSON | Optional | |
lock_after_date (anyOf 1) | string | Alternative | Format: date |
lock_after_date (anyOf 2) | null | Alternative | |
reason | JSON | Optional | |
reason (anyOf 1) | string | Alternative | |
reason (anyOf 2) | null | Alternative | |
spend_duration | JSON | Optional | |
spend_duration (anyOf 1) | JSON | Alternative | |
spend_duration (anyOf 1) (allOf 1) | string | All variants apply | Spend limit refresh frequency - MONTHLY: The spend limit refreshes every month - QUARTERLY: The spend limit refreshes every quarter - YEARLY: The spend limit refreshes every year - ONE_TIME: The limit does not refresh One of: MONTHLY, QUARTERLY, YEARLY, ONE_TIME |
spend_duration (anyOf 2) | null | Alternative | |
spend_limit | JSON | Optional | |
spend_limit (anyOf 1) | JSON | Alternative | |
spend_limit (anyOf 1) (allOf 1) | Model | All variants apply | Expand Create transfer — request body — body amount |
spend_limit (anyOf 2) | null | Alternative |
Referenced models: Get card — response body — spend controls allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details, blocked merchant details, lock after date, reason, spend available, spend duration, spend limit allowed merchant details array item, Create transfer — request body — body amount
Update department — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the department. Pass null or an empty string to clear it. Maximum length: 255 |
description (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Name of the department. Cannot be blank when supplied. Maximum length: 255 Minimum length: 1 |
name (anyOf 2) | null | Alternative |
Update location — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the location. Pass null or an empty string to clear it. |
description (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Name of the location. Cannot be blank when supplied. Minimum length: 1 |
name (anyOf 2) | null | Alternative |
Update title — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | Name of the title. Cannot be blank or null when supplied. Maximum length: 255 Minimum length: 1 |