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.
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"]["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 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.get_bank_transfer_requirements(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.country | string | Required within parent | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
query.currency | string | Required within parent | Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
query.amount | number | Optional | Format: double |
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 bank transfer requirements — 200 response body |
Referenced models: Get bank transfer requirements — 200 response body
Schemas
Section titled “Schemas”Get bank transfer requirements — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fields | array | Required within parent | Each field key is input field for the bank transfer method creation payload. |
fields[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item fields item |
intermediary | array | Optional | Each field is input for the bank transfer method creation payload intermediary object |
intermediary[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item intermediary item |
title | string | Required within parent | Title of the bank transfer method |
total_fee | string | Required within parent | Fee preview for amount provided in query parameter |
type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
group | array | Required within parent | List of input field definitions within this group. |
group[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item fields item group item |
name | string | Required within parent | User-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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
group | array | Required within parent | List of input field definitions for the intermediary bank. |
group[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item intermediary item group item |
name | string | Required within parent | User 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_format | JSON | Optional | |
display_format (anyOf 1) | string | Alternative | Optional display format hint for the field |
display_format (anyOf 2) | null | Alternative | Optional display format hint for the field |
example | string | Optional | Example value for the field |
key | string | Required within parent | The key of the field in the method creation payload |
max_length | JSON | Optional | |
max_length (anyOf 1) | JSON | Alternative | |
max_length (anyOf 1) (anyOf 1) | integer | Alternative | The maximum length of the field |
max_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_length (anyOf 2) | null | Alternative | The maximum length of the field |
min_length | JSON | Optional | |
min_length (anyOf 1) | JSON | Alternative | |
min_length (anyOf 1) (anyOf 1) | integer | Alternative | The minimum length of the field |
min_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_length (anyOf 2) | null | Alternative | The minimum length of the field |
name | string | Required within parent | User facing name of property |
refresh_requirements_on_change | boolean | Optional | Whether to refresh the requirements when the field value changes with field key as query parameter |
required | boolean | Required within parent | Whether the field is required |
type | string | Required within parent | The type of the field, such as text, radio, select, or date_local. Known values: text, radio, select, date_local |
validation_regexp | JSON | Optional | |
validation_regexp (anyOf 1) | string | Alternative | The regular expression to validate the field |
validation_regexp (anyOf 2) | null | Alternative | The regular expression to validate the field |
values_allowed | JSON | Optional | |
values_allowed (anyOf 1) | array | Alternative | An array of allowed values with corresponding key and name. |
values_allowed (anyOf 1)[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item fields item group item values allowed null item |
values_allowed (anyOf 2) | null | Alternative | An array of allowed values with corresponding key and name. |
values_allowed (anyOf 2)[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
example | string | Optional | Example value for the field |
key | string | Required within parent | The key of the intermediary field in the method creation payload. |
max_length | JSON | Optional | |
max_length (anyOf 1) | JSON | Alternative | |
max_length (anyOf 1) (anyOf 1) | integer | Alternative | The maximum length of the field |
max_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_length (anyOf 2) | null | Alternative | The maximum length of the field |
min_length | JSON | Optional | |
min_length (anyOf 1) | JSON | Alternative | |
min_length (anyOf 1) (anyOf 1) | integer | Alternative | The minimum length of the field |
min_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_length (anyOf 2) | null | Alternative | The minimum length of the field |
name | string | Required within parent | User facing name of the intermediary object |
required | boolean | Required within parent | Whether the field is required |
type | string | Required within parent | The type of the field, such as text, radio, select, or date_local. |
validation_regexp | JSON | Optional | |
validation_regexp (anyOf 1) | string | Alternative | The regular expression to validate the field |
validation_regexp (anyOf 2) | null | Alternative | The regular expression to validate the field |
values_allowed | JSON | Optional | |
values_allowed (anyOf 1) | array | Alternative | An array of allowed values with corresponding key and name. |
values_allowed (anyOf 1)[] | Model | Each item | Expand Get bank transfer requirements — 200 response body — data item fields item group item values allowed null item |
values_allowed (anyOf 2) | null | Alternative | An array of allowed values with corresponding key and name. |
values_allowed (anyOf 2)[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
key | string | Required within parent | The country code (e.g., AL for Albania). |
name | string | Required within parent | The full name of the country (e.g., Albania). |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}