Deel: Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency
Deel eorWorkerBanks.getEorworkerBankGuideByCountryAndCurrency: arguments, response, policy and SDK examples.
← EOR worker banks operations · Get started
Operation deel.eorworkerbanks_geteorworkerbankguidebycountryandcurrency
Provider route: GET /eor/workers/banks-guide/country/{country}/currency/{currency}. 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["eorWorkerBanks"]["getEorworkerBankGuideByCountryAndCurrency"]>[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.eorWorkerBanks.getEorworkerBankGuideByCountryAndCurrency(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.eor_worker_banks.get_eorworker_bank_guide_by_country_and_currency(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.country | string | Required within parent | |
path.currency | string | Required within parent |
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 Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body |
Referenced models: Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body
Schemas
Section titled “Schemas”Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item |
Referenced models: Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item
Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_required | JSON | Required within parent | |
is_required (anyOf 1) | boolean | Alternative | Whether the field is required or not. |
is_required (anyOf 2) | null | Alternative | Whether the field is required or not. |
key | string | Required within parent | The key of the field. |
type | string | Optional | Type of the field |
ui_guide | Model | Required within parent | Expand Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item ui guide UI guidance information for rendering this field in forms. |
validations | array | Optional | Array of validation rules that apply to this field. |
validations[] | Model | Each item | Expand Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item validations item |
values_allowed | array | Optional | Array of allowed values for this field (used for dropdowns, select lists, etc.). |
values_allowed[] | Model | Each item | Expand Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide — 200 response body — data item values allowed item |
Referenced models: Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide — 200 response body — data item values allowed item, Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item ui guide, Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item validations item
Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide — 200 response body — data item values allowed item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
label | string | Optional | The name of the allowed value. |
value | string | Optional | The value of the allowed value. |
Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item ui guide
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | UI guidance information for rendering this field in forms. |
helper_text | JSON | Optional | |
helper_text (anyOf 1) | string | Alternative | Helper text to guide the user. |
helper_text (anyOf 2) | null | Alternative | Helper text to guide the user. |
label | string | Optional | Label for this field. |
order | JSON | Optional | |
order (anyOf 1) | integer | Alternative | Order of the field in the form. |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item validations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | string | Optional | Error message to be displayed if validation fails. |
type | string | Optional | The type of validation rule to apply. Known values: MIN_LENGTH, MAX_LENGTH, REGEX |
value | Model | Optional | Expand Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item validations item value The value to use for the validation rule (e.g., minimum length, regex pattern). |
Referenced models: Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item validations item value
Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item validations item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The value to use for the validation rule (e.g., minimum length, regex pattern). |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorworkerbanks_geteorworkerbankguidebycountryandcurrency. Catalog operation: eorworkerbanks_geteorworkerbankguidebycountryandcurrency. 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"}