Skip to content

Deel: Get Bank Details

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

← Payouts operations · Get started

Operation deel.payouts_getbankdetails_v2026_01_01

Provider route: GET /payouts/employees/methods. 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"]["getBankDetails"]>[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.getBankDetails(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_details(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

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 Details — 200 response body

Referenced models: Get Bank Details — 200 response body

Get Bank Details — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Add Edit Bank Details — 200 response body — data

Referenced models: Add Edit Bank Details — 200 response body — data

Add Edit Bank Details — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalCreation timestamp
dataModelOptionalExpand Add Edit Bank Details — 200 response body — data data
funds_distributionJSONOptional
funds_distribution (anyOf 1)numberAlternativeFunds distribution percentage
Format: double
funds_distribution (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringOptionalUnique identifier for the bank details
is_active_versionbooleanOptionalIndicates if this is the active version
statusstringOptionalStatus of the bank details
updated_atstringOptionalLast update timestamp
versionstringOptionalVersion identifier

Referenced models: Add Edit Bank Details — 200 response body — data data

Add Edit Bank Details — 200 response body — data data
FieldTypePresenceDescription and constraints
$objectRoot
address_line1stringOptionalAddress line 1
bank_country_codestringOptionalCountry code of the bank
bank_namestringOptionalName of the bank
citystringOptionalName of the city
country_codestringOptionalCountry code
full_namestringOptionalFull name of the account holder
ibanstringOptionalInternational Bank Account Number
original_namestringOptionalOriginal name of the account holder
postalstringOptionalPostal code
province_statestringOptionalProvince or state
swift_bicstringOptionalSWIFT/BIC code

SDK function policy ID: deel.payouts_getbankdetails_v2026_01_01. Catalog operation: payouts_getbankdetails_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", "worker:write"]

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.