Skip to content

Deel: Get bank transfer requirements

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

← Payouts operations · Get started

Operation deel.payouts_getbanktransferrequirements_v2026_01_01

Provider route: GET /payouts/contractors/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"]["getBankTransferRequirements"]>[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.getBankTransferRequirements(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_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}$
query.amountnumberOptionalFormat: double

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

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

Referenced models: Get bank transfer requirements — 200 response body

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 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 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 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 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).

SDK function policy ID: deel.payouts_getbanktransferrequirements_v2026_01_01. Catalog operation: payouts_getbanktransferrequirements_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"]

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.