Skip to content

Brex: Team schemas

62 Brex schemas with complete fields and constraints.

← Team operations · All schemas

Create card — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
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_preferencesJSONOptional
card_attribute_preferences (anyOf 1)JSONAlternative
card_attribute_preferences (anyOf 1) (allOf 1)ModelAll variants applyExpand Create card — request body — body card attribute preferences three domain secure enabled preference three domain secure enabled preference
card_attribute_preferences (anyOf 2)nullAlternative
card_namestringRequired within parentMinimum length: 1
card_typestringRequired within parentOne of: VIRTUAL, PHYSICAL
limit_typestringRequired 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_addressJSONOptional
mailing_address (anyOf 1)JSONAlternative
mailing_address (anyOf 1) (allOf 1)ModelAll variants applyExpand Get card — response body — billing address
mailing_address (anyOf 2)nullAlternative
metadataJSONOptional
metadata (anyOf 1)objectAlternative
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).*stringAdditional keys
metadata (anyOf 2)nullAlternative
ownerModelRequired within parentExpand Create card — request body — body owner
spend_controlsJSONOptional
spend_controls (anyOf 1)JSONAlternative
spend_controls (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants apply
$ (allOf 2)JSONAll variants apply
$ (allOf 2).typestringRequired within parentOne of: USER
$ (allOf 2).user_idstringRequired within parent

Create card — request body — body / spend_controls / spend_duration: MONTHLY, QUARTERLY, YEARLY, ONE TIME spend duration: MONTHLY, QUARTERLY, YEARLY, ONE TIME

FieldTypePresenceDescription and constraints
$objectRoot
When `limit_type = CARD`, `spend_controls` must be set. When `limit type = USER`, `spend_controls` must be `null`.
allowed_merchant_detailsJSONOptional
allowed_merchant_details (anyOf 1)arrayAlternative
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)[]ModelEach itemExpand 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)nullAlternative
blocked_merchant_detailsJSONOptional
blocked_merchant_details (anyOf 1)arrayAlternative
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)[]ModelEach itemExpand 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)nullAlternative
lock_after_dateJSONOptional
lock_after_date (anyOf 1)stringAlternativeFormat: date
lock_after_date (anyOf 2)nullAlternative
parent_budget_idJSONOptional
parent_budget_id (anyOf 1)stringAlternative
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)nullAlternative
policy_idJSONOptional
policy_id (anyOf 1)stringAlternative
policy_id (anyOf 2)nullAlternative
reasonJSONOptional
reason (anyOf 1)stringAlternative
reason (anyOf 2)nullAlternative
spend_durationstringRequired 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_limitModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
three_domain_secure_enabled_preferenceJSONOptional
three_domain_secure_enabled_preference (anyOf 1)JSONAlternative
three_domain_secure_enabled_preference (anyOf 1) (allOf 1)stringAll 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)nullAlternative

Create card — request body — body owner

FieldTypePresenceDescription and constraints
$objectRootdiscriminator: {"mapping": {"USER": "#/components/schemas/team__UserOwner"}, "propertyName": "type"}
$ (oneOf 1)ModelAlternativeExpand Create card — request body — body / owner / type: USER

Referenced models: Create card — request body — body / owner / type: USER

Create department — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the department
description (anyOf 2)nullAlternative
namestringRequired within parentName of the department
Minimum length: 1

Create location — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the location
description (anyOf 2)nullAlternative
namestringRequired within parentName of the location
Minimum length: 1

Create secure email to send card number — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
expiry_daysJSONOptional
expiry_days (anyOf 1)integerAlternativeLink expiry in number of days. Defaults to 30
Format: int32
Maximum: 30
expiry_days (anyOf 2)nullAlternative
messageJSONOptional
message (anyOf 1)stringAlternativeMessage to send with the card details
message (anyOf 2)nullAlternative
recipient_emailstringRequired within parentEmail address to send card details to
sender_namestringRequired within parentSender name. Shows up in the subject of the email

Create title — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentName of the title
Minimum length: 1

Create user — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
cost_center_idJSONOptional
cost_center_id (anyOf 1)stringAlternative
cost_center_id (anyOf 2)nullAlternative
department_idJSONOptional
department_id (anyOf 1)stringAlternative
department_id (anyOf 2)nullAlternative
emailstringRequired within parentFormat: email
first_namestringRequired within parentMinimum length: 1
last_namestringRequired within parentMinimum length: 1
legal_entity_idJSONOptional
legal_entity_id (anyOf 1)stringAlternativeThe legal entity to assign the user to. Defaults to the account's default legal entity.
legal_entity_id (anyOf 2)nullAlternative
location_idJSONOptional
location_id (anyOf 1)stringAlternative
location_id (anyOf 2)nullAlternative
manager_idJSONOptional
manager_id (anyOf 1)stringAlternative
manager_id (anyOf 2)nullAlternative
metadataJSONOptional
metadata (anyOf 1)objectAlternativeThe metadata or customized attributes of the user. Maximum number of entries: 100
Additional keys: see wildcard field
metadata (anyOf 1).*stringAdditional keys
metadata (anyOf 2)nullAlternative
title_idJSONOptional
title_id (anyOf 1)stringAlternative
title_id (anyOf 2)nullAlternative

Get card number — response body

FieldTypePresenceDescription and constraints
$objectRoot
Card number, CVV, and expiration date of a card.
cvvstringRequired within parent
expiration_dateModelRequired within parentExpand Get card — response body — expiration date
holder_namestringRequired within parent
idstringRequired within parent
numberstringRequired within parent

Referenced models: Get card — response body — expiration date

Get card — response body

FieldTypePresenceDescription and constraints
$objectRoot
Only cards with limit_type = CARD have spend_controls
billing_addressModelRequired within parentExpand Get card — response body — billing address
budget_idJSONOptional
budget_id (anyOf 1)stringAlternative
budget_id (anyOf 2)nullAlternative
card_nameJSONOptional
card_name (anyOf 1)stringAlternative
card_name (anyOf 2)nullAlternative
card_typeJSONOptional
card_type (anyOf 1)JSONAlternative
card_type (anyOf 1) (allOf 1)stringAll variants applyKnown values: VIRTUAL, PHYSICAL
card_type (anyOf 2)nullAlternative
created_atstringRequired within parentThe timestamp when the card was created
expiration_dateModelRequired within parentExpand Get card — response body — expiration date
has_been_transferredbooleanOptional
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.
idstringRequired within parent
last_fourstringRequired within parent
limit_typestringRequired 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_addressJSONOptional
mailing_address (anyOf 1)JSONAlternative
mailing_address (anyOf 1) (allOf 1)ModelAll variants applyExpand Get card — response body — billing address
mailing_address (anyOf 2)nullAlternative
metadataJSONOptional
metadata (anyOf 1)objectAlternative
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).*stringAdditional keys
metadata (anyOf 2)nullAlternative
ownerModelRequired within parentExpand Get card — response body — owner
partnerJSONOptional
partner (anyOf 1)stringAlternative
The partner that manages this card, if any.
partner (anyOf 2)nullAlternative
spend_controlsJSONOptional
spend_controls (anyOf 1)JSONAlternative
spend_controls (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative
statusJSONOptional
status (anyOf 1)JSONAlternative
status (anyOf 1) (allOf 1)stringAll variants applyKnown values: ACTIVE, SHIPPED, LOCKED, TERMINATED
status (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootCompany business address (must be in the US; no PO box or virtual/forwarding addresses allowed).
cityJSONOptional
city (anyOf 1)stringAlternativeCity, district, suburb, town, or village.
city (anyOf 2)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternativeTwo-letter country code (ISO 3166-1 alpha-2).
country (anyOf 2)nullAlternative
line1JSONOptional
line1 (anyOf 1)stringAlternativeAddress line 1, no PO Box.
line1 (anyOf 2)nullAlternative
line2JSONOptional
line2 (anyOf 1)stringAlternativeAddress line 2 (e.g., apartment, suite, unit, or building).
line2 (anyOf 2)nullAlternative
phone_numberJSONOptional
phone_number (anyOf 1)stringAlternativePhone number.
phone_number (anyOf 2)nullAlternative
postal_codeJSONOptional
postal_code (anyOf 1)stringAlternativeZIP or postal code.
postal_code (anyOf 2)nullAlternative
stateJSONOptional
state (anyOf 1)stringAlternativeFor US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
state (anyOf 2)nullAlternative

Get card — response body — expiration date

FieldTypePresenceDescription and constraints
$objectRoot
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.
monthJSONRequired within parent
month (anyOf 1)integerAlternativeFormat: int32
month (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
yearJSONRequired within parent
year (anyOf 1)integerAlternativeFormat: int32
year (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get card — response body — owner

FieldTypePresenceDescription and constraints
$objectRootdiscriminator: {"mapping": {"USER": "#/components/schemas/team__UserOwner"}, "propertyName": "type"}
$ (anyOf 1)ModelAlternativeExpand Get card — response body — owner / type: USER

Referenced models: Get card — response body — owner / type: USER

Get card — response body — owner / type: USER

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)objectAll variants apply
$ (allOf 2)JSONAll variants apply
$ (allOf 2).typestringRequired within parentKnown values: USER
$ (allOf 2).user_idstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
allowed_merchant_detailsJSONOptional
allowed_merchant_details (anyOf 1)arrayAlternative
List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured.
allowed_merchant_details (anyOf 1)[]ModelEach itemExpand 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)nullAlternative
blocked_merchant_detailsJSONOptional
blocked_merchant_details (anyOf 1)arrayAlternative
List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured.
blocked_merchant_details (anyOf 1)[]ModelEach itemExpand 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)nullAlternative
lock_after_dateJSONOptional
lock_after_date (anyOf 1)stringAlternativeThe `lock_after_date` is in UTC.
Format: date
lock_after_date (anyOf 2)nullAlternative
reasonJSONOptional
reason (anyOf 1)stringAlternative
reason (anyOf 2)nullAlternative
spend_availableJSONOptional
spend_available (anyOf 1)JSONAlternative
spend_available (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
spend_available (anyOf 2)nullAlternative
spend_durationJSONOptional
spend_duration (anyOf 1)JSONAlternative
spend_duration (anyOf 1) (allOf 1)stringAll 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)nullAlternative
spend_limitJSONOptional
spend_limit (anyOf 1)JSONAlternative
spend_limit (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
spend_limit (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
Merchant details used for restricting or blocking transactions.
namestringRequired within parentThe name of the merchant.

Get company — response body

FieldTypePresenceDescription and constraints
$objectRoot
accountTypestringRequired within parentKnown values: BREX_CLASSIC, BREX_EMPOWER
idstringRequired within parent
legal_namestringRequired within parent
mailing_addressModelRequired within parentExpand Get card — response body — billing address

Referenced models: Get card — response body — billing address

Get cost center — response body

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
namestringRequired within parentName of the cost center

Get department — response body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the department
description (anyOf 2)nullAlternative
idstringRequired within parent
namestringRequired within parentName of the department

Get legal entity — response body

FieldTypePresenceDescription and constraints
$objectRoot
A Brex legal entity.
billingAddressJSONRequired within parent
billingAddress (allOf 1)ModelAll variants applyExpand Get card — response body — billing address
billingAddress (allOf 2)JSONAll variants apply
The billing address of this legal entity. Also used as billing address for cards issued to users who belong to this entity.
createdAtstringRequired within parent
Timestamp, in UTC, when this legal entity was created.

Format: date-time
displayNamestringRequired within parent
The display name of this legal entity.
idstringRequired within parent
The ID of this legal entity.
isDefaultbooleanOptional
Whether this is the default entity of the account.
statusJSONRequired within parent
status (allOf 1)stringAll variants apply
The possible statuses for an entity's verification in Brex.

Known values: UNSUBMITTED, UNVERIFIED, IN_PROGRESS, VERIFIED, REJECTED
status (allOf 2)JSONAll variants apply
The current status of this legal entity.

Referenced models: Get card — response body — billing address

Get location — response body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the location
description (anyOf 2)nullAlternative
idstringRequired within parent
namestringRequired within parentName of the location

Get title — response body

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
namestringRequired within parentName of the title

Get user — response body

FieldTypePresenceDescription and constraints
$objectRoot
cost_center_idJSONOptional
cost_center_id (anyOf 1)stringAlternative
cost_center_id (anyOf 2)nullAlternative
custom_fieldsJSONOptional
custom_fields (anyOf 1)arrayAlternativeA list of custom field values associated with the user.
custom_fields (anyOf 1)[]ModelEach itemExpand Get user — response body — custom fields array item
custom_fields (anyOf 2)nullAlternative
department_idJSONOptional
department_id (anyOf 1)stringAlternative
department_id (anyOf 2)nullAlternative
emailstringRequired within parentEmail address of the user
first_namestringRequired within parentFirst name of the user
idstringRequired within parent
last_namestringRequired within parentLast name of the user
legal_entity_idJSONOptional
legal_entity_id (anyOf 1)stringAlternative
legal_entity_id (anyOf 2)nullAlternative
location_idJSONOptional
location_id (anyOf 1)stringAlternative
location_id (anyOf 2)nullAlternative
manager_idJSONOptional
manager_id (anyOf 1)stringAlternativeThe user id of the manager of this user
manager_id (anyOf 2)nullAlternative
metadataJSONOptional
metadata (anyOf 1)objectAlternativeThe metadata or customized attributes of the user. Maximum number of entries: 100
Additional keys: see wildcard field
metadata (anyOf 1).*stringAdditional keys
metadata (anyOf 2)nullAlternative
remote_display_idJSONOptional
remote_display_id (anyOf 1)stringAlternativeIdentifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz
remote_display_id (anyOf 2)nullAlternative
role_nameJSONOptional
role_name (anyOf 1)stringAlternativeThe user's role, as shown in the Brex dashboard.
role_name (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)JSONAlternative
status (anyOf 1) (allOf 1)stringAll variants applyStatus of the user
Known values: INVITED, ACTIVE, DISABLED, PENDING_ACTIVATION, INACTIVE, ARCHIVED
status (anyOf 2)nullAlternative
title_idJSONOptional
title_id (anyOf 1)stringAlternative
title_id (anyOf 2)nullAlternative

Referenced models: Get user — response body — custom fields array item

Get user — response body — custom fields array item

FieldTypePresenceDescription and constraints
$objectRoot
display_nameJSONOptional
display_name (anyOf 1)stringAlternativeThe display name of the custom field.
display_name (anyOf 2)nullAlternative
keystringRequired within parentThe key of the custom field.
valueJSONRequired within parent
value (allOf 1)ModelAll variants applyExpand Get user — response body — custom fields array item value Base class for custom field values
value (allOf 2)JSONAll variants applyThe value of the custom field.
value (allOf 2) (anyOf 1)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field String value
value (allOf 2) (anyOf 2)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Decimal value
value (allOf 2) (anyOf 3)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Boolean value
value (allOf 2) (anyOf 4)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Enum value
value (allOf 2) (anyOf 5)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Timestamp value
value (allOf 2) (anyOf 6)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Date value
value (allOf 2) (anyOf 7)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Money value
value (allOf 2) (anyOf 8)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Option string value
value (allOf 2) (anyOf 9)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field String list value
value (allOf 2) (anyOf 10)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Decimal list value
value (allOf 2) (anyOf 11)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Boolean list value
value (allOf 2) (anyOf 12)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Enum list value
value (allOf 2) (anyOf 13)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Timestamp list value
value (allOf 2) (anyOf 14)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Date list value
value (allOf 2) (anyOf 15)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Money list value
value (allOf 2) (anyOf 16)ModelAlternativeExpand Get user — response body — custom fields array item value The value of the custom field Option string list value

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

FieldTypePresenceDescription and constraints
$objectRootBase class for custom field values
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
value_typeJSONRequired within parent
value_type (allOf 1)stringAll variants applyThe type of the custom field value.
Known values: SINGLE_VALUE, LIST
value_type (allOf 2)JSONAll variants applyThe type of the custom field value.

Get user — response body — custom fields array item value The value of the custom field Boolean list value

FieldTypePresenceDescription and constraints
$objectRootBoolean list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]booleanEach itemThe data of the custom field.
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: BOOLEAN
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootBoolean value for a custom field
dataJSONOptional
data (anyOf 1)booleanAlternativeThe data of the custom field.
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: BOOLEAN
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootDate list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]stringEach itemThe data of the custom field.
Format: date
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: DATE
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootMultiple value wrapper for custom fields
value_typeJSONRequired within parent
value_type (allOf 1)stringAll variants applyThe type of the custom field value.
Known values: SINGLE_VALUE, LIST
value_type (allOf 2)JSONAll variants applyThe type of the custom field value.
$ (allOf 1)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootDate value for a custom field
dataJSONOptional
data (anyOf 1)stringAlternativeThe data of the custom field.
Format: date
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: DATE
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootSingle value wrapper for custom fields
value_typeJSONRequired within parent
value_type (allOf 1)stringAll variants applyThe type of the custom field value.
Known values: SINGLE_VALUE, LIST
value_type (allOf 2)JSONAll variants applyThe type of the custom field value.
$ (allOf 1)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootDecimal list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]JSONEach item
data (anyOf 1)[] (anyOf 1)numberAlternativeThe data of the custom field.
data (anyOf 1)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: DECIMAL
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootDecimal value for a custom field
dataJSONOptional
data (anyOf 1)JSONAlternative
data (anyOf 1) (anyOf 1)numberAlternativeThe data of the custom field.
data (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: DECIMAL
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootEnum list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]stringEach itemThe data of the custom field.
Format: enum
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: ENUM
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootEnum value for a custom field
dataJSONOptional
data (anyOf 1)stringAlternativeThe data of the custom field.
Format: enum
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: ENUM
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootMoney list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]ModelEach itemExpand Get transfer — response body — amount
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: MONEY
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootMoney value for a custom field
dataJSONOptional
data (anyOf 1)JSONAlternative
data (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
data (anyOf 1) (allOf 2)JSONAll variants applyThe data of the custom field.
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: MONEY
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootOption string list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]ModelEach itemExpand 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)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: OPTION_STRING
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootOption string fields have a label and a identifier.
option_idJSONOptional
option_id (anyOf 1)stringAlternativeThe identifier when custom field data is of type option string.
option_id (anyOf 2)nullAlternative
option_labelJSONOptional
option_label (anyOf 1)stringAlternativeThe label when custom field data is of type option string.
option_label (anyOf 2)nullAlternative

Get user — response body — custom fields array item value The value of the custom field Option string value

FieldTypePresenceDescription and constraints
$objectRootOption string value for a custom field
dataJSONOptional
data (anyOf 1)JSONAlternative
data (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)JSONAll variants applyThe data of the custom field.
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: OPTION_STRING
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootString list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]stringEach itemThe data of the custom field.
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: STRING
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootString value for a custom field
dataJSONOptional
data (anyOf 1)stringAlternativeThe data of the custom field.
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: STRING
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootTimestamp list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]stringEach itemThe data of the custom field.
Format: date-time
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: TIMESTAMP
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRootTimestamp value for a custom field
dataJSONOptional
data (anyOf 1)stringAlternativeThe data of the custom field.
Format: date-time
data (anyOf 2)nullAlternative
data_typestringRequired within parentThe type of the custom field data.
Known values: TIMESTAMP
$ (allOf 1)ModelAll variants applyExpand 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)ModelAll variants applyExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get card — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get card — response body

List cost centers — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get cost center — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get cost center — response body

List departments — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get department — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get department — response body

List legal entities — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get legal entity — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get legal entity — response body

List locations — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get location — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get location — response body

List roles — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand List roles — response body — items item
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: List roles — response body — items item

List roles — response body — items item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the role
description (anyOf 2)nullAlternative
display_namestringRequired within parentDisplay name of the role
idstringRequired within parentThe role ID
is_custombooleanRequired within parentWhether this is a custom role

List titles — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get title — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get title — response body

List users — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get user — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get user — response body

Lock card — request body — body

FieldTypePresenceDescription and constraints
$objectRootParameters for locking a card.
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription for locking a card
description (anyOf 2)nullAlternative
reasonstringRequired 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

FieldTypePresenceDescription and constraints
$objectRootParameters for terminating a card.
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription for terminating a card
description (anyOf 2)nullAlternative
reasonstringRequired 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

FieldTypePresenceDescription and constraints
$objectRoot
metadataJSONOptional
metadata (anyOf 1)objectAlternative
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).*stringAdditional keys
metadata (anyOf 2)nullAlternative
spend_controlsJSONOptional
spend_controls (anyOf 1)JSONAlternative
spend_controls (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)nullAlternative

Referenced models: 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

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

FieldTypePresenceDescription and constraints
$objectRoot
allowed_merchant_detailsJSONOptional
allowed_merchant_details (anyOf 1)arrayAlternative
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)[]ModelEach itemExpand 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)nullAlternative
blocked_merchant_detailsJSONOptional
blocked_merchant_details (anyOf 1)arrayAlternative
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)[]ModelEach itemExpand 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)nullAlternative
lock_after_dateJSONOptional
lock_after_date (anyOf 1)stringAlternativeFormat: date
lock_after_date (anyOf 2)nullAlternative
reasonJSONOptional
reason (anyOf 1)stringAlternative
reason (anyOf 2)nullAlternative
spend_durationJSONOptional
spend_duration (anyOf 1)JSONAlternative
spend_duration (anyOf 1) (allOf 1)stringAll 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)nullAlternative
spend_limitJSONOptional
spend_limit (anyOf 1)JSONAlternative
spend_limit (anyOf 1) (allOf 1)ModelAll variants applyExpand Create transfer — request body — body amount
spend_limit (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the department. Pass null or an empty string to clear it.
Maximum length: 255
description (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeName of the department. Cannot be blank when supplied.
Maximum length: 255
Minimum length: 1
name (anyOf 2)nullAlternative

Update location — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the location. Pass null or an empty string to clear it.
description (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeName of the location. Cannot be blank when supplied.
Minimum length: 1
name (anyOf 2)nullAlternative

Update title — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentName of the title. Cannot be blank or null when supplied.
Maximum length: 255
Minimum length: 1

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.