Skip to content

Deel: Get dynamic bank transfer requirements

Deel payouts.dynamicRequirements: arguments, response, policy and SDK examples.

← Payouts operations · Get started

Operation deel.payouts_dynamicrequirements_v2026_01_01

Provider route: POST /payouts/employees/methods/bank_transfers/requirements. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["payouts"]["dynamicRequirements"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.payouts.dynamicRequirements(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.payouts.dynamic_requirements(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.dataModelOptionalExpand Get dynamic bank transfer requirements — request body — body data
Request data

Referenced models: Get dynamic bank transfer requirements — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get dynamic bank transfer requirements — 200 response body

Referenced models: Get dynamic bank transfer requirements — 200 response body

1 more schema is linked from the tables above, on the schema pages.

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 — 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 — 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 — 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 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 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 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 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

SDK function policy ID: deel.payouts_dynamicrequirements_v2026_01_01. Catalog operation: payouts_dynamicrequirements_v2026_01_01. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["worker:read", "worker:write"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

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.