Skip to content

Deel: Payouts schemas

53 Deel schemas with complete fields and constraints.

← Payouts operations · All schemas

Add Edit Bank Details — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalCreation timestamp
dataModelOptionalExpand Add Edit Bank Details — 200 response body — data data
funds_distributionJSONOptional
funds_distribution (anyOf 1)numberAlternativeFunds distribution percentage
Format: double
funds_distribution (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringOptionalUnique identifier for the bank details
is_active_versionbooleanOptionalIndicates if this is the active version
statusstringOptionalStatus of the bank details
updated_atstringOptionalLast update timestamp
versionstringOptionalVersion identifier

Referenced models: Add Edit Bank Details — 200 response body — data data

Add Edit Bank Details — 200 response body — data data

FieldTypePresenceDescription and constraints
$objectRoot
address_line1stringOptionalAddress line 1
bank_country_codestringOptionalCountry code of the bank
bank_namestringOptionalName of the bank
citystringOptionalName of the city
country_codestringOptionalCountry code
full_namestringOptionalFull name of the account holder
ibanstringOptionalInternational Bank Account Number
original_namestringOptionalOriginal name of the account holder
postalstringOptionalPostal code
province_statestringOptionalProvince or state
swift_bicstringOptionalSWIFT/BIC code

Add Edit Bank Details — request body — body data

FieldTypePresenceDescription and constraints
$objectRootRequest data
idstringOptionalUnique identifier for the bank details
payloadModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootPayload containing bank details
address_line1stringOptionalAddress line 1
bank_country_codestringOptionalCountry code of the bank
bank_namestringOptionalName of the bank
citystringOptionalName of the city
country_codestringOptionalCountry code
full_namestringOptionalFull name of the account holder
ibanstringOptionalInternational Bank Account Number
original_namestringOptionalOriginal name of the account holder
postalstringOptionalPostal code
province_statestringOptionalProvince or state
swift_bicstringOptionalSWIFT/BIC code

Create a bank transfer method — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalUnique identifier for the bank transfer method
statusstringOptionalStatus of the bank transfer method
Known values: pending, verifying, failed, approved

Create a bank transfer method — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
addressModelRequired within parentExpand Create a bank transfer method — request body — body data address
is_defaultbooleanOptionalSpecifies if the method is the default payout method - if true, autowithdrawal will be enabled for the contractor using this method
method_namestringOptionalName for method
payloadobjectRequired within parentDynamic 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.*JSONAdditional keysAny type
payment_methodstringRequired within parentSpecifies the type of payment method
One of: bank_transfer
selectedOptionstringOptionalSpecifies 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

FieldTypePresenceDescription and constraints
$objectRoot
citystringRequired within parentCity name
countrystringRequired within parentCountry code
Pattern: ^[A-Z]{2}$
first_linestringRequired within parentFirst line of the address
post_codestringRequired within parentPost code
statestringOptionalState code

Delete Bank Details — 201 response body

FieldTypePresenceDescription and constraints
$objectRootEmpty response body

Fetch all payout methods — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of payout methods associated with the account.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptionalAddress associated with the payout method, when available.
address (anyOf 1)ModelAlternativeExpand Fetch all payout methods — 200 response body — data item address city, country, first line, post code, state
address (anyOf 2)nullAlternative
created_atstringRequired within parentTimestamp when the payout method was created.
Format: date-time
idstringRequired within parentUnique identifier of the payout method (method chain ID).
Format: uuid
is_defaultbooleanRequired within parentSpecifies if the method is the default payout method - if true, autowithdrawal will be enabled for the contractor using this method
method_nameJSONOptional
method_name (anyOf 1)stringAlternativeName for the method.
method_name (anyOf 2)nullAlternativeName for the method.
payloadobjectRequired within parentDynamic 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.*JSONAdditional keysAny type
payment_methodstringRequired within parentType of payout method.
selected_optionstringRequired within parentSpecifies the type of bank transfer method. Maps from the requirements type field.
statusstringRequired within parentCurrent status of the payout method (e.g. PENDING, VERIFYING, APPROVED, FAILED).
updated_atstringRequired within parentTimestamp when the payout method was last updated.
Format: date-time
versionstringRequired within parentUnique 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

FieldTypePresenceDescription and constraints
$objectRootAddress associated with the payout method, when available.
citystringOptionalCity name
countrystringOptionalCountry code
first_linestringOptionalFirst line of the address
post_codestringOptionalPost code
statestringOptionalState code

Get Bank Details — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
fieldsarrayRequired within parentEach field key is input field for the bank transfer method creation payload.
fields[]ModelEach itemExpand Get bank transfer requirements — 200 response body — data item fields item
intermediaryarrayOptionalEach field is input for the bank transfer method creation payload intermediary object
intermediary[]ModelEach itemExpand Get bank transfer requirements — 200 response body — data item intermediary item
titlestringRequired within parentTitle of the bank transfer method
total_feestringRequired within parentFee preview for amount provided in query parameter
typestringRequired within parentType 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

FieldTypePresenceDescription and constraints
$objectRoot
grouparrayRequired within parentList of input field definitions within this group.
group[]ModelEach itemExpand Get bank transfer requirements — 200 response body — data item fields item group item
namestringRequired within parentUser-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

FieldTypePresenceDescription and constraints
$objectRoot
display_formatJSONOptional
display_format (anyOf 1)stringAlternativeOptional display format hint for the field
display_format (anyOf 2)nullAlternativeOptional display format hint for the field
examplestringOptionalExample value for the field
keystringRequired within parentThe key of the field in the method creation payload
max_lengthJSONOptional
max_length (anyOf 1)JSONAlternative
max_length (anyOf 1) (anyOf 1)integerAlternativeThe maximum length of the field
max_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_length (anyOf 2)nullAlternativeThe maximum length of the field
min_lengthJSONOptional
min_length (anyOf 1)JSONAlternative
min_length (anyOf 1) (anyOf 1)integerAlternativeThe minimum length of the field
min_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_length (anyOf 2)nullAlternativeThe minimum length of the field
namestringRequired within parentUser facing name of property
refresh_requirements_on_changebooleanOptionalWhether to refresh the requirements when the field value changes with field key as query parameter
requiredbooleanRequired within parentWhether the field is required
typestringRequired within parentThe type of the field, such as text, radio, select, or date_local.
Known values: text, radio, select, date_local
validation_regexpJSONOptional
validation_regexp (anyOf 1)stringAlternativeThe regular expression to validate the field
validation_regexp (anyOf 2)nullAlternativeThe regular expression to validate the field
values_allowedJSONOptional
values_allowed (anyOf 1)arrayAlternativeAn array of allowed values with corresponding key and name.
values_allowed (anyOf 1)[]ModelEach itemExpand Get bank transfer requirements — 200 response body — data item fields item group item values allowed null item
values_allowed (anyOf 2)nullAlternativeAn array of allowed values with corresponding key and name.
values_allowed (anyOf 2)[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
keystringRequired within parentThe country code (e.g., AL for Albania).
namestringRequired within parentThe full name of the country (e.g., Albania).

Get bank transfer requirements — 200 response body — data item intermediary item

FieldTypePresenceDescription and constraints
$objectRoot
grouparrayRequired within parentList of input field definitions for the intermediary bank.
group[]ModelEach itemExpand Get bank transfer requirements — 200 response body — data item intermediary item group item
namestringRequired within parentUser 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

FieldTypePresenceDescription and constraints
$objectRoot
examplestringOptionalExample value for the field
keystringRequired within parentThe key of the intermediary field in the method creation payload.
max_lengthJSONOptional
max_length (anyOf 1)JSONAlternative
max_length (anyOf 1) (anyOf 1)integerAlternativeThe maximum length of the field
max_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_length (anyOf 2)nullAlternativeThe maximum length of the field
min_lengthJSONOptional
min_length (anyOf 1)JSONAlternative
min_length (anyOf 1) (anyOf 1)integerAlternativeThe minimum length of the field
min_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_length (anyOf 2)nullAlternativeThe minimum length of the field
namestringRequired within parentUser facing name of the intermediary object
requiredbooleanRequired within parentWhether the field is required
typestringRequired within parentThe type of the field, such as text, radio, select, or date_local.
validation_regexpJSONOptional
validation_regexp (anyOf 1)stringAlternativeThe regular expression to validate the field
validation_regexp (anyOf 2)nullAlternativeThe regular expression to validate the field
values_allowedJSONOptional
values_allowed (anyOf 1)arrayAlternativeAn array of allowed values with corresponding key and name.
values_allowed (anyOf 1)[]ModelEach itemExpand Get bank transfer requirements — 200 response body — data item fields item group item values allowed null item
values_allowed (anyOf 2)nullAlternativeAn array of allowed values with corresponding key and name.
values_allowed (anyOf 2)[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
dataobjectRequired within parentA mapping of country codes to arrays of supported currency codes
Additional keys: see wildcard field
data.*arrayAdditional keys
data.*[]stringEach item

Get dynamic bank transfer requirements — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootResponse data
is_finalbooleanOptionalIndicates if the requirements are final
requirements_idJSONOptional
requirements_id (anyOf 1)numberAlternativeID of the requirements
Format: double
requirements_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
stepsarrayOptionalSteps to fulfill the requirements
steps[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
bannerJSONOptionalBanner information (present when there is additional guidance to show; null otherwise).
banner (anyOf 1)ModelAlternativeExpand Get dynamic bank transfer requirements — 200 response body — data steps item banner additional data, banner type, placement
banner (anyOf 2)nullAlternative
categoriesarrayOptionalCategories of the steps
categories[]ModelEach itemExpand Get dynamic bank transfer requirements — 200 response body — data steps item categories item
headerstringOptionalStep header
namestringOptionalStep name
right_side_placeholderstringOptionalRight 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

FieldTypePresenceDescription and constraints
$objectRootBanner information (present when there is additional guidance to show; null otherwise).
additional_dataModelOptionalExpand Get dynamic bank transfer requirements — 200 response body — data steps item banner additional data, banner type, placement additional data
Additional banner-specific data
banner_typestringOptionalBanner type
placementstringOptionalWhere 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

FieldTypePresenceDescription and constraints
$objectRootAdditional banner-specific data

Get dynamic bank transfer requirements — 200 response body — data steps item categories item

FieldTypePresenceDescription and constraints
$objectRoot
alertModelOptionalExpand Get dynamic bank transfer requirements — 200 response body — data steps item categories item alert
Alert information
bannerJSONOptionalBanner information (present when there is additional guidance to show; null otherwise).
banner (anyOf 1)ModelAlternativeExpand Get dynamic bank transfer requirements — 200 response body — data steps item banner additional data, banner type, placement
banner (anyOf 2)nullAlternative
fieldsarrayOptionalFields in the category
fields[]ModelEach itemExpand Get dynamic bank transfer requirements — 200 response body — data steps item categories item fields item
headerstringOptionalCategory header
namestringOptionalCategory name
priorityJSONOptional
priority (anyOf 1)numberAlternativeCategory priority
Format: double
priority (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRootAlert information
messagestringOptionalAlert message
titlestringOptionalAlert title
typestringOptionalAlert type

Get dynamic bank transfer requirements — 200 response body — data steps item categories item fields item

FieldTypePresenceDescription and constraints
$objectRoot
categorystringOptionalField category
disabledbooleanOptionalIndicates if the field is disabled
exampleJSONOptional
example (anyOf 1)stringAlternativeExample value
example (anyOf 2)nullAlternativeExample value
idJSONOptional
id (anyOf 1)numberAlternativeField ID
Format: double
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
keystringOptionalField key
max_lengthstringOptionalMaximum length of the field
min_lengthstringOptionalMinimum length of the field
namestringOptionalField name
requiredbooleanOptionalIndicates if the field is required
sensitivebooleanOptionalIndicates if the field is sensitive
tooltipJSONOptional
tooltip (anyOf 1)stringAlternativeTooltip information
tooltip (anyOf 2)nullAlternativeTooltip information
typestringOptionalField type
validation_regex_flagsJSONOptional
validation_regex_flags (anyOf 1)stringAlternativeValidation regex flags
validation_regex_flags (anyOf 2)nullAlternativeValidation regex flags
validation_regexpJSONOptional
validation_regexp (anyOf 1)stringAlternativeValidation regex pattern
validation_regexp (anyOf 2)nullAlternativeValidation regex pattern
values_allowedJSONOptional
values_allowed (anyOf 1)arrayAlternativeAllowed values for the field (present for select-type fields; null otherwise).
values_allowed (anyOf 1)[]ModelEach itemExpand Get dynamic bank transfer requirements — 200 response body — data steps item categories item fields item values allowed null item
values_allowed (anyOf 2)nullAlternativeAllowed values for the field (present for select-type fields; null otherwise).
values_allowed (anyOf 2)[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
keystringRequired within parentMachine-readable option key.
namestringRequired within parentHuman-readable option label.

Get dynamic bank transfer requirements — request body — body data

FieldTypePresenceDescription and constraints
$objectRootRequest data
current_stateModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootCurrent state of the bank details
bank_country_codestringOptionalCountry code of the bank
currency_codestringOptionalCurrency code
payment_typestringOptionalType of payment

Get static employee bank transfer requirements — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe preferred transfer type for the country and currency, as a list of at most one item. Empty when no route supports them.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
fieldsarrayRequired within parentGroups of input fields to collect for this transfer type.
fields[]ModelEach itemExpand Get static employee bank transfer requirements — 200 response body — data item fields item
intermediaryarrayOptionalGroups of intermediary bank fields to collect for this transfer type, when applicable.
intermediary[]ModelEach itemExpand Get static employee bank transfer requirements — 200 response body — data item fields item
titlestringRequired within parentUser-facing title of the transfer type.
typestringRequired within parentTransfer 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

FieldTypePresenceDescription and constraints
$objectRoot
grouparrayRequired within parentInput fields within this group.
group[]ModelEach itemExpand Get static employee bank transfer requirements — 200 response body — data item fields item group item
namestringRequired within parentUser-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

FieldTypePresenceDescription and constraints
$objectRoot
display_formatJSONOptional
display_format (anyOf 1)stringAlternativeOptional display format hint for the field.
display_format (anyOf 2)nullAlternativeOptional display format hint for the field.
exampleJSONOptional
example (anyOf 1)stringAlternativeExample value for the field.
example (anyOf 2)nullAlternativeExample value for the field.
is_requiredbooleanRequired within parentWhether the field is required.
keystringRequired within parentIdentifier of the input field. Dotted keys (for example `intermediary.bic`) denote nested properties.
max_lengthJSONOptional
max_length (anyOf 1)JSONAlternative
max_length (anyOf 1) (anyOf 1)integerAlternativeMaximum length of the field value.
max_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_length (anyOf 2)nullAlternativeMaximum length of the field value.
min_lengthJSONOptional
min_length (anyOf 1)JSONAlternative
min_length (anyOf 1) (anyOf 1)integerAlternativeMinimum length of the field value.
min_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_length (anyOf 2)nullAlternativeMinimum length of the field value.
namestringRequired within parentUser-facing name of the field.
should_refresh_requirements_on_changebooleanOptionalWhether 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`.
typestringOptionalInput type of the field, for example `text`, `select`, `country`, `number` or `date_local`.
validation_regexpJSONOptional
validation_regexp (anyOf 1)stringAlternativeRegular expression the field value must match.
validation_regexp (anyOf 2)nullAlternativeRegular expression the field value must match.
values_allowedJSONOptional
values_allowed (anyOf 1)arrayAlternativeAllowed values for select-type fields; null otherwise.
values_allowed (anyOf 1)[]ModelEach itemExpand Get static employee bank transfer requirements — 200 response body — data item fields item group item values allowed null item
values_allowed (anyOf 2)nullAlternativeAllowed values for select-type fields; null otherwise.
values_allowed (anyOf 2)[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
keystringRequired within parentValue to submit for this option (for example, a country code such as `AL`).
namestringRequired within parentUser-facing label for this option.

Get the auto-withdrawal setting — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
is_auto_withdraw_enabledbooleanOptionalWhether auto withdrawal is enabled
method_idJSONOptional
method_id (anyOf 1)stringAlternativeThe ID of the withdrawal method to be used for auto withdrawal
Format: uuid
method_id (anyOf 2)nullAlternativeThe ID of the withdrawal method to be used for auto withdrawal
Format: uuid

List Contractor Balances — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand List Contractor Balances — 200 response body — data

Referenced models: List Contractor Balances — 200 response body — data

List Contractor Balances — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
balancesarrayOptional
balances[]ModelEach itemExpand List Contractor Balances — 200 response body — data balances item
balances_totalModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
amountstringOptionalamount of that currency in the contractor balance
currencystringOptionalcurrency of that amount

List Contractor Balances — 200 response body — data balances total

FieldTypePresenceDescription and constraints
$objectRoot
amountstringOptionaltotal amount of all currencies in the contractor balance
currencystringOptionalcurrency of the total amount

Request to withdraw funds — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONOptional
amount (anyOf 1)numberAlternativeAmount of the transaction
Format: double
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringOptionalTimestamp of the transaction creation
Format: date-time
currencystringOptionalCurrency of the transaction
idstringOptionalID of the created transaction
Format: uuid
updated_atstringOptionalTimestamp of the transaction update
Format: date-time

Request to withdraw funds — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
amountnumberRequired within parentAmount to withdraw (must be positive)
Format: double
currencystringRequired within parentCurrency code for the withdrawal amount
withdrawal_method_idstringRequired within parentId of the withdrawal method to use
Format: uuid

Update a bank transfer method — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalUnique identifier for the bank transfer method
statusstringOptionalStatus of the method
Known values: PENDING, VERIFYING, FAILED, APPROVED
versionstringOptionalVersion identifier for the bank transfer method

Update auto withdraw setting for contractor — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
is_auto_withdraw_enabledbooleanRequired within parentSets auto withdraw to enabled or disabled for contractor

Update the auto-withdrawal setting — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
is_auto_withdraw_enabledbooleanOptionalWhether auto withdrawal is enabled
method_idstringOptionalThe ID of the withdrawal method to be used for auto withdrawal
Format: uuid

Update the auto-withdrawal setting — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
is_auto_withdraw_enabledbooleanOptionalWhether auto withdrawal should be enabled
method_idstringOptionalThe ID of the withdrawal method to be used for auto withdrawal
Format: uuid

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.