Skip to content

Deel: Get static employee bank transfer requirements

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

← Payouts operations · Get started

Operation deel.payouts_getstaticemployeebanktransferrequirements_v2026_09_28

Provider route: GET /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"]["getStaticEmployeeBankTransferRequirements"]>[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.getStaticEmployeeBankTransferRequirements(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.get_static_employee_bank_transfer_requirements(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectRequired within parentAdditional keys: not allowed
query.countrystringRequired within parentMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
query.currencystringRequired within parentMaximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$

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

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

Referenced models: Get static employee bank transfer requirements — 200 response body

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.

SDK function policy ID: deel.payouts_getstaticemployeebanktransferrequirements_v2026_09_28. Catalog operation: payouts_getstaticemployeebanktransferrequirements_v2026_09_28. 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: ["payments:read"]

Pinned headers: {"X-Version": "2026-09-28"}

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.