Skip to content

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.

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 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.eor_worker_banks.get_eorworker_bank_guide_by_country_and_currency(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.countrystringRequired within parent
path.currencystringRequired within parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand 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

Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
is_requiredJSONRequired within parent
is_required (anyOf 1)booleanAlternativeWhether the field is required or not.
is_required (anyOf 2)nullAlternativeWhether the field is required or not.
keystringRequired within parentThe key of the field.
typestringOptionalType of the field
ui_guideModelRequired within parentExpand 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.
validationsarrayOptionalArray of validation rules that apply to this field.
validations[]ModelEach itemExpand Retrieve bank account guide — eor Worker Banks get Eorworker Bank Guide By Country And Currency — 200 response body — data item validations item
values_allowedarrayOptionalArray of allowed values for this field (used for dropdowns, select lists, etc.).
values_allowed[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
labelstringOptionalThe name of the allowed value.
valuestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootUI guidance information for rendering this field in forms.
helper_textJSONOptional
helper_text (anyOf 1)stringAlternativeHelper text to guide the user.
helper_text (anyOf 2)nullAlternativeHelper text to guide the user.
labelstringOptionalLabel for this field.
orderJSONOptional
order (anyOf 1)integerAlternativeOrder of the field in the form.
order (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$objectRoot
error_messagestringOptionalError message to be displayed if validation fails.
typestringOptionalThe type of validation rule to apply.
Known values: MIN_LENGTH, MAX_LENGTH, REGEX
valueModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$JSONRootThe value to use for the validation rule (e.g., minimum length, regex pattern).
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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"}

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.