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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.data | Model | Optional | Expand Get dynamic bank transfer requirements — request body — body data Request data |
Referenced models: Get dynamic bank transfer requirements — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get dynamic bank transfer requirements — 200 response body |
Referenced models: Get dynamic bank transfer requirements — 200 response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
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 — 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 — 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 — 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 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 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 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 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
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}