Deel: Payouts schemas
53 Deel schemas with complete fields and constraints.
← Payouts operations · All schemas
Add Edit Bank Details — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Add Edit Bank Details — 200 response body — data |
Referenced models: Add Edit Bank Details — 200 response body — data
Add Edit Bank Details — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Creation timestamp |
data | Model | Optional | Expand Add Edit Bank Details — 200 response body — data data |
funds_distribution | JSON | Optional | |
funds_distribution (anyOf 1) | number | Alternative | Funds distribution percentage Format: double |
funds_distribution (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Optional | Unique identifier for the bank details |
is_active_version | boolean | Optional | Indicates if this is the active version |
status | string | Optional | Status of the bank details |
updated_at | string | Optional | Last update timestamp |
version | string | Optional | Version identifier |
Referenced models: Add Edit Bank Details — 200 response body — data data
Add Edit Bank Details — 200 response body — data data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_line1 | string | Optional | Address line 1 |
bank_country_code | string | Optional | Country code of the bank |
bank_name | string | Optional | Name of the bank |
city | string | Optional | Name of the city |
country_code | string | Optional | Country code |
full_name | string | Optional | Full name of the account holder |
iban | string | Optional | International Bank Account Number |
original_name | string | Optional | Original name of the account holder |
postal | string | Optional | Postal code |
province_state | string | Optional | Province or state |
swift_bic | string | Optional | SWIFT/BIC code |
Add Edit Bank Details — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request data |
id | string | Optional | Unique identifier for the bank details |
payload | Model | Optional | Expand Add Edit Bank Details — request body — body data payload Payload containing bank details |
Referenced models: Add Edit Bank Details — request body — body data payload
Add Edit Bank Details — request body — body data payload
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payload containing bank details |
address_line1 | string | Optional | Address line 1 |
bank_country_code | string | Optional | Country code of the bank |
bank_name | string | Optional | Name of the bank |
city | string | Optional | Name of the city |
country_code | string | Optional | Country code |
full_name | string | Optional | Full name of the account holder |
iban | string | Optional | International Bank Account Number |
original_name | string | Optional | Original name of the account holder |
postal | string | Optional | Postal code |
province_state | string | Optional | Province or state |
swift_bic | string | Optional | SWIFT/BIC code |
Create a bank transfer method — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create a bank transfer method — 201 response body — data |
Referenced models: Create a bank transfer method — 201 response body — data
Create a bank transfer method — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Unique identifier for the bank transfer method |
status | string | Optional | Status of the bank transfer method Known values: pending, verifying, failed, approved |
Create a bank transfer method — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Required within parent | Expand Create a bank transfer method — request body — body data address |
is_default | boolean | Optional | Specifies if the method is the default payout method - if true, autowithdrawal will be enabled for the contractor using this method |
method_name | string | Optional | Name for method |
payload | object | Required within parent | Dynamic properties based on selected option. For example, if `selectedOption` is `swift_code`, payload may include `swiftCode`, `accountHolderName`, and `accountNumber`. Additional keys: see wildcard field |
payload.* | JSON | Additional keys | Any type |
payment_method | string | Required within parent | Specifies the type of payment method One of: bank_transfer |
selectedOption | string | Optional | Specifies the type of bank transfer method. Maps from requirements type field |
Referenced models: Create a bank transfer method — request body — body data address
Create a bank transfer method — request body — body data address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | string | Required within parent | City name |
country | string | Required within parent | Country code Pattern: ^[A-Z]{2}$ |
first_line | string | Required within parent | First line of the address |
post_code | string | Required within parent | Post code |
state | string | Optional | State code |
Delete Bank Details — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Empty response body |
Fetch all payout methods — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of payout methods associated with the account. |
data[] | Model | Each item | Expand Fetch all payout methods — 200 response body — data item |
Referenced models: Fetch all payout methods — 200 response body — data item
Fetch all payout methods — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | Address associated with the payout method, when available. |
address (anyOf 1) | Model | Alternative | Expand Fetch all payout methods — 200 response body — data item address city, country, first line, post code, state |
address (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Timestamp when the payout method was created. Format: date-time |
id | string | Required within parent | Unique identifier of the payout method (method chain ID). Format: uuid |
is_default | boolean | Required within parent | Specifies if the method is the default payout method - if true, autowithdrawal will be enabled for the contractor using this method |
method_name | JSON | Optional | |
method_name (anyOf 1) | string | Alternative | Name for the method. |
method_name (anyOf 2) | null | Alternative | Name for the method. |
payload | object | Required within parent | Dynamic properties based on selected option. For example, if `selected_option` is `SWIFT CODE`, payload may include `swiftCode`, `accountHolderName`, and `accountNumber`. Additional keys: see wildcard field |
payload.* | JSON | Additional keys | Any type |
payment_method | string | Required within parent | Type of payout method. |
selected_option | string | Required within parent | Specifies the type of bank transfer method. Maps from the requirements type field. |
status | string | Required within parent | Current status of the payout method (e.g. PENDING, VERIFYING, APPROVED, FAILED). |
updated_at | string | Required within parent | Timestamp when the payout method was last updated. Format: date-time |
version | string | Required within parent | Unique identifier of the specific version of the payout method. Format: uuid |
Referenced models: Fetch all payout methods — 200 response body — data item address city, country, first line, post code, state
Fetch all payout methods — 200 response body — data item address city, country, first line, post code, state
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Address associated with the payout method, when available. |
city | string | Optional | City name |
country | string | Optional | Country code |
first_line | string | Optional | First line of the address |
post_code | string | Optional | Post code |
state | string | Optional | State code |
Get Bank Details — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Add Edit Bank Details — 200 response body — data |
Referenced models: Add Edit Bank Details — 200 response body — data
Get bank transfer requirements — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item |
Referenced models: Get bank transfer requirements — 200 response body — data item
Get bank transfer requirements — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fields | array | Required within parent | Each field key is input field for the bank transfer method creation payload. |
fields[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item fields item |
intermediary | array | Optional | Each field is input for the bank transfer method creation payload intermediary object |
intermediary[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item intermediary item |
title | string | Required within parent | Title of the bank transfer method |
total_fee | string | Required within parent | Fee preview for amount provided in query parameter |
type | string | Required within parent | Type of bank transfer, such as local, swift, iban. Maps to selected_option in method creation data. |
Referenced models: Get bank transfer requirements — 200 response body — data item fields item, Get bank transfer requirements — 200 response body — data item intermediary item
Get bank transfer requirements — 200 response body — data item fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
group | array | Required within parent | List of input field definitions within this group. |
group[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item fields item group item |
name | string | Required within parent | User-facing label for the field group. |
Referenced models: Get bank transfer requirements — 200 response body — data item fields item group item
Get bank transfer requirements — 200 response body — data item fields item group item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_format | JSON | Optional | |
display_format (anyOf 1) | string | Alternative | Optional display format hint for the field |
display_format (anyOf 2) | null | Alternative | Optional display format hint for the field |
example | string | Optional | Example value for the field |
key | string | Required within parent | The key of the field in the method creation payload |
max_length | JSON | Optional | |
max_length (anyOf 1) | JSON | Alternative | |
max_length (anyOf 1) (anyOf 1) | integer | Alternative | The maximum length of the field |
max_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_length (anyOf 2) | null | Alternative | The maximum length of the field |
min_length | JSON | Optional | |
min_length (anyOf 1) | JSON | Alternative | |
min_length (anyOf 1) (anyOf 1) | integer | Alternative | The minimum length of the field |
min_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_length (anyOf 2) | null | Alternative | The minimum length of the field |
name | string | Required within parent | User facing name of property |
refresh_requirements_on_change | boolean | Optional | Whether to refresh the requirements when the field value changes with field key as query parameter |
required | boolean | Required within parent | Whether the field is required |
type | string | Required within parent | The type of the field, such as text, radio, select, or date_local. Known values: text, radio, select, date_local |
validation_regexp | JSON | Optional | |
validation_regexp (anyOf 1) | string | Alternative | The regular expression to validate the field |
validation_regexp (anyOf 2) | null | Alternative | The regular expression to validate the field |
values_allowed | JSON | Optional | |
values_allowed (anyOf 1) | array | Alternative | An array of allowed values with corresponding key and name. |
values_allowed (anyOf 1)[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item fields item group item values allowed null item |
values_allowed (anyOf 2) | null | Alternative | An array of allowed values with corresponding key and name. |
values_allowed (anyOf 2)[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item fields item group item values allowed null item |
Referenced models: Get bank transfer requirements — 200 response body — data item fields item group item values allowed null item
Get bank transfer requirements — 200 response body — data item fields item group item values allowed null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
key | string | Required within parent | The country code (e.g., AL for Albania). |
name | string | Required within parent | The full name of the country (e.g., Albania). |
Get bank transfer requirements — 200 response body — data item intermediary item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
group | array | Required within parent | List of input field definitions for the intermediary bank. |
group[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item intermediary item group item |
name | string | Required within parent | User facing name of the intermediary object |
Referenced models: Get bank transfer requirements — 200 response body — data item intermediary item group item
Get bank transfer requirements — 200 response body — data item intermediary item group item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
example | string | Optional | Example value for the field |
key | string | Required within parent | The key of the intermediary field in the method creation payload. |
max_length | JSON | Optional | |
max_length (anyOf 1) | JSON | Alternative | |
max_length (anyOf 1) (anyOf 1) | integer | Alternative | The maximum length of the field |
max_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_length (anyOf 2) | null | Alternative | The maximum length of the field |
min_length | JSON | Optional | |
min_length (anyOf 1) | JSON | Alternative | |
min_length (anyOf 1) (anyOf 1) | integer | Alternative | The minimum length of the field |
min_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_length (anyOf 2) | null | Alternative | The minimum length of the field |
name | string | Required within parent | User facing name of the intermediary object |
required | boolean | Required within parent | Whether the field is required |
type | string | Required within parent | The type of the field, such as text, radio, select, or date_local. |
validation_regexp | JSON | Optional | |
validation_regexp (anyOf 1) | string | Alternative | The regular expression to validate the field |
validation_regexp (anyOf 2) | null | Alternative | The regular expression to validate the field |
values_allowed | JSON | Optional | |
values_allowed (anyOf 1) | array | Alternative | An array of allowed values with corresponding key and name. |
values_allowed (anyOf 1)[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item fields item group item values allowed null item |
values_allowed (anyOf 2) | null | Alternative | An array of allowed values with corresponding key and name. |
values_allowed (anyOf 2)[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item fields item group item values allowed null item |
Referenced models: Get bank transfer requirements — 200 response body — data item fields item group item values allowed null item
Get bank transfer supported routes for contractor — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | object | Required within parent | A mapping of country codes to arrays of supported currency codes Additional keys: see wildcard field |
data.* | array | Additional keys | |
data.*[] | string | Each item |
Get dynamic bank transfer requirements — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Get dynamic bank transfer requirements — 200 response body — data Response data |
Referenced models: Get dynamic bank transfer requirements — 200 response body — data
Get dynamic bank transfer requirements — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response data |
is_final | boolean | Optional | Indicates if the requirements are final |
requirements_id | JSON | Optional | |
requirements_id (anyOf 1) | number | Alternative | ID of the requirements Format: double |
requirements_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
steps | array | Optional | Steps to fulfill the requirements |
steps[] | Model | Each item | Expand Get dynamic bank transfer requirements — 200 response body — data steps item |
Referenced models: Get dynamic bank transfer requirements — 200 response body — data steps item
Get dynamic bank transfer requirements — 200 response body — data steps item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
banner | JSON | Optional | Banner information (present when there is additional guidance to show; null otherwise). |
banner (anyOf 1) | Model | Alternative | Expand Get dynamic bank transfer requirements — 200 response body — data steps item banner additional data, banner type, placement |
banner (anyOf 2) | null | Alternative | |
categories | array | Optional | Categories of the steps |
categories[] | Model | Each item | Expand Get dynamic bank transfer requirements — 200 response body — data steps item categories item |
header | string | Optional | Step header |
name | string | Optional | Step name |
right_side_placeholder | string | Optional | Right side placeholder |
Referenced models: Get dynamic bank transfer requirements — 200 response body — data steps item banner additional data, banner type, placement, Get dynamic bank transfer requirements — 200 response body — data steps item categories item
Get dynamic bank transfer requirements — 200 response body — data steps item banner additional data, banner type, placement
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Banner information (present when there is additional guidance to show; null otherwise). |
additional_data | Model | Optional | Expand Get dynamic bank transfer requirements — 200 response body — data steps item banner additional data, banner type, placement additional data Additional banner-specific data |
banner_type | string | Optional | Banner type |
placement | string | Optional | Where the banner should be displayed |
Referenced models: Get dynamic bank transfer requirements — 200 response body — data steps item banner additional data, banner type, placement additional data
Get dynamic bank transfer requirements — 200 response body — data steps item banner additional data, banner type, placement additional data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional banner-specific data |
Get dynamic bank transfer requirements — 200 response body — data steps item categories item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
alert | Model | Optional | Expand Get dynamic bank transfer requirements — 200 response body — data steps item categories item alert Alert information |
banner | JSON | Optional | Banner information (present when there is additional guidance to show; null otherwise). |
banner (anyOf 1) | Model | Alternative | Expand Get dynamic bank transfer requirements — 200 response body — data steps item banner additional data, banner type, placement |
banner (anyOf 2) | null | Alternative | |
fields | array | Optional | Fields in the category |
fields[] | Model | Each item | Expand Get dynamic bank transfer requirements — 200 response body — data steps item categories item fields item |
header | string | Optional | Category header |
name | string | Optional | Category name |
priority | JSON | Optional | |
priority (anyOf 1) | number | Alternative | Category priority Format: double |
priority (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get dynamic bank transfer requirements — 200 response body — data steps item banner additional data, banner type, placement, Get dynamic bank transfer requirements — 200 response body — data steps item categories item alert, Get dynamic bank transfer requirements — 200 response body — data steps item categories item fields item
Get dynamic bank transfer requirements — 200 response body — data steps item categories item alert
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Alert information |
message | string | Optional | Alert message |
title | string | Optional | Alert title |
type | string | Optional | Alert type |
Get dynamic bank transfer requirements — 200 response body — data steps item categories item fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category | string | Optional | Field category |
disabled | boolean | Optional | Indicates if the field is disabled |
example | JSON | Optional | |
example (anyOf 1) | string | Alternative | Example value |
example (anyOf 2) | null | Alternative | Example value |
id | JSON | Optional | |
id (anyOf 1) | number | Alternative | Field ID Format: double |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
key | string | Optional | Field key |
max_length | string | Optional | Maximum length of the field |
min_length | string | Optional | Minimum length of the field |
name | string | Optional | Field name |
required | boolean | Optional | Indicates if the field is required |
sensitive | boolean | Optional | Indicates if the field is sensitive |
tooltip | JSON | Optional | |
tooltip (anyOf 1) | string | Alternative | Tooltip information |
tooltip (anyOf 2) | null | Alternative | Tooltip information |
type | string | Optional | Field type |
validation_regex_flags | JSON | Optional | |
validation_regex_flags (anyOf 1) | string | Alternative | Validation regex flags |
validation_regex_flags (anyOf 2) | null | Alternative | Validation regex flags |
validation_regexp | JSON | Optional | |
validation_regexp (anyOf 1) | string | Alternative | Validation regex pattern |
validation_regexp (anyOf 2) | null | Alternative | Validation regex pattern |
values_allowed | JSON | Optional | |
values_allowed (anyOf 1) | array | Alternative | Allowed values for the field (present for select-type fields; null otherwise). |
values_allowed (anyOf 1)[] | Model | Each item | Expand Get dynamic bank transfer requirements — 200 response body — data steps item categories item fields item values allowed null item |
values_allowed (anyOf 2) | null | Alternative | Allowed values for the field (present for select-type fields; null otherwise). |
values_allowed (anyOf 2)[] | Model | Each item | Expand Get dynamic bank transfer requirements — 200 response body — data steps item categories item fields item values allowed null item |
Referenced models: Get dynamic bank transfer requirements — 200 response body — data steps item categories item fields item values allowed null item
Get dynamic bank transfer requirements — 200 response body — data steps item categories item fields item values allowed null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
key | string | Required within parent | Machine-readable option key. |
name | string | Required within parent | Human-readable option label. |
Get dynamic bank transfer requirements — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request data |
current_state | Model | Optional | Expand Get dynamic bank transfer requirements — request body — body data current state Current state of the bank details |
Referenced models: Get dynamic bank transfer requirements — request body — body data current state
Get dynamic bank transfer requirements — request body — body data current state
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Current state of the bank details |
bank_country_code | string | Optional | Country code of the bank |
currency_code | string | Optional | Currency code |
payment_type | string | Optional | Type of payment |
Get static employee bank transfer requirements — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | The preferred transfer type for the country and currency, as a list of at most one item. Empty when no route supports them. |
data[] | Model | Each item | Expand Get static employee bank transfer requirements — 200 response body — data item |
Referenced models: Get static employee bank transfer requirements — 200 response body — data item
Get static employee bank transfer requirements — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fields | array | Required within parent | Groups of input fields to collect for this transfer type. |
fields[] | Model | Each item | Expand Get static employee bank transfer requirements — 200 response body — data item fields item |
intermediary | array | Optional | Groups of intermediary bank fields to collect for this transfer type, when applicable. |
intermediary[] | Model | Each item | Expand Get static employee bank transfer requirements — 200 response body — data item fields item |
title | string | Required within parent | User-facing title of the transfer type. |
type | string | Required within parent | Transfer type identifier, for example `bts`, `iban` or `swift_code`. |
Referenced models: Get static employee bank transfer requirements — 200 response body — data item fields item
Get static employee bank transfer requirements — 200 response body — data item fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
group | array | Required within parent | Input fields within this group. |
group[] | Model | Each item | Expand Get static employee bank transfer requirements — 200 response body — data item fields item group item |
name | string | Required within parent | User-facing label for the field group. |
Referenced models: Get static employee bank transfer requirements — 200 response body — data item fields item group item
Get static employee bank transfer requirements — 200 response body — data item fields item group item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_format | JSON | Optional | |
display_format (anyOf 1) | string | Alternative | Optional display format hint for the field. |
display_format (anyOf 2) | null | Alternative | Optional display format hint for the field. |
example | JSON | Optional | |
example (anyOf 1) | string | Alternative | Example value for the field. |
example (anyOf 2) | null | Alternative | Example value for the field. |
is_required | boolean | Required within parent | Whether the field is required. |
key | string | Required within parent | Identifier of the input field. Dotted keys (for example `intermediary.bic`) denote nested properties. |
max_length | JSON | Optional | |
max_length (anyOf 1) | JSON | Alternative | |
max_length (anyOf 1) (anyOf 1) | integer | Alternative | Maximum length of the field value. |
max_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_length (anyOf 2) | null | Alternative | Maximum length of the field value. |
min_length | JSON | Optional | |
min_length (anyOf 1) | JSON | Alternative | |
min_length (anyOf 1) (anyOf 1) | integer | Alternative | Minimum length of the field value. |
min_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_length (anyOf 2) | null | Alternative | Minimum length of the field value. |
name | string | Required within parent | User-facing name of the field. |
should_refresh_requirements_on_change | boolean | Optional | Whether the requirements can change depending on this field's value. This lookup does not re-evaluate requirements; when `true`, use `POST /payouts/employees/methods/bank_transfers/requirements`. |
type | string | Optional | Input type of the field, for example `text`, `select`, `country`, `number` or `date_local`. |
validation_regexp | JSON | Optional | |
validation_regexp (anyOf 1) | string | Alternative | Regular expression the field value must match. |
validation_regexp (anyOf 2) | null | Alternative | Regular expression the field value must match. |
values_allowed | JSON | Optional | |
values_allowed (anyOf 1) | array | Alternative | Allowed values for select-type fields; null otherwise. |
values_allowed (anyOf 1)[] | Model | Each item | Expand Get static employee bank transfer requirements — 200 response body — data item fields item group item values allowed null item |
values_allowed (anyOf 2) | null | Alternative | Allowed values for select-type fields; null otherwise. |
values_allowed (anyOf 2)[] | Model | Each item | Expand Get static employee bank transfer requirements — 200 response body — data item fields item group item values allowed null item |
Referenced models: Get static employee bank transfer requirements — 200 response body — data item fields item group item values allowed null item
Get static employee bank transfer requirements — 200 response body — data item fields item group item values allowed null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
key | string | Required within parent | Value to submit for this option (for example, a country code such as `AL`). |
name | string | Required within parent | User-facing label for this option. |
Get the auto-withdrawal setting — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Get the auto-withdrawal setting — 200 response body — data |
Referenced models: Get the auto-withdrawal setting — 200 response body — data
Get the auto-withdrawal setting — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_auto_withdraw_enabled | boolean | Optional | Whether auto withdrawal is enabled |
method_id | JSON | Optional | |
method_id (anyOf 1) | string | Alternative | The ID of the withdrawal method to be used for auto withdrawal Format: uuid |
method_id (anyOf 2) | null | Alternative | The ID of the withdrawal method to be used for auto withdrawal Format: uuid |
List Contractor Balances — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand List Contractor Balances — 200 response body — data |
Referenced models: List Contractor Balances — 200 response body — data
List Contractor Balances — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
balances | array | Optional | |
balances[] | Model | Each item | Expand List Contractor Balances — 200 response body — data balances item |
balances_total | Model | Optional | Expand List Contractor Balances — 200 response body — data balances total |
Referenced models: List Contractor Balances — 200 response body — data balances item, List Contractor Balances — 200 response body — data balances total
List Contractor Balances — 200 response body — data balances item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Optional | amount of that currency in the contractor balance |
currency | string | Optional | currency of that amount |
List Contractor Balances — 200 response body — data balances total
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Optional | total amount of all currencies in the contractor balance |
currency | string | Optional | currency of the total amount |
Request to withdraw funds — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Request to withdraw funds — 201 response body — data |
Referenced models: Request to withdraw funds — 201 response body — data
Request to withdraw funds — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | number | Alternative | Amount of the transaction Format: double |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created_at | string | Optional | Timestamp of the transaction creation Format: date-time |
currency | string | Optional | Currency of the transaction |
id | string | Optional | ID of the created transaction Format: uuid |
updated_at | string | Optional | Timestamp of the transaction update Format: date-time |
Request to withdraw funds — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | number | Required within parent | Amount to withdraw (must be positive) Format: double |
currency | string | Required within parent | Currency code for the withdrawal amount |
withdrawal_method_id | string | Required within parent | Id of the withdrawal method to use Format: uuid |
Update a bank transfer method — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update a bank transfer method — 200 response body — data |
Referenced models: Update a bank transfer method — 200 response body — data
Update a bank transfer method — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Unique identifier for the bank transfer method |
status | string | Optional | Status of the method Known values: PENDING, VERIFYING, FAILED, APPROVED |
version | string | Optional | Version identifier for the bank transfer method |
Update auto withdraw setting for contractor — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_auto_withdraw_enabled | boolean | Required within parent | Sets auto withdraw to enabled or disabled for contractor |
Update the auto-withdrawal setting — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Update the auto-withdrawal setting — 200 response body — data |
Referenced models: Update the auto-withdrawal setting — 200 response body — data
Update the auto-withdrawal setting — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_auto_withdraw_enabled | boolean | Optional | Whether auto withdrawal is enabled |
method_id | string | Optional | The ID of the withdrawal method to be used for auto withdrawal Format: uuid |
Update the auto-withdrawal setting — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_auto_withdraw_enabled | boolean | Optional | Whether auto withdrawal should be enabled |
method_id | string | Optional | The ID of the withdrawal method to be used for auto withdrawal Format: uuid |