Skip to content

Deel: Fetch all payout methods

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

← Payouts operations · Get started

Operation deel.payouts_fetchallpayoutmethods_v2026_01_01

Provider route: GET /payouts/contractors/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"]["fetchAllPayoutMethods"]>[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.fetchAllPayoutMethods(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.fetch_all_payout_methods(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.is_defaultbooleanOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Fetch all payout methods — 200 response body

Referenced models: Fetch all payout methods — 200 response body

Fetch all payout methods — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of payout methods associated with the account.
data[]ModelEach itemExpand Fetch all payout methods — 200 response body — data item

Referenced models: Fetch all payout methods — 200 response body — data item

Fetch all payout methods — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptionalAddress associated with the payout method, when available.
address (anyOf 1)ModelAlternativeExpand Fetch all payout methods — 200 response body — data item address city, country, first line, post code, state
address (anyOf 2)nullAlternative
created_atstringRequired within parentTimestamp when the payout method was created.
Format: date-time
idstringRequired within parentUnique identifier of the payout method (method chain ID).
Format: uuid
is_defaultbooleanRequired within parentSpecifies if the method is the default payout method - if true, autowithdrawal will be enabled for the contractor using this method
method_nameJSONOptional
method_name (anyOf 1)stringAlternativeName for the method.
method_name (anyOf 2)nullAlternativeName for the method.
payloadobjectRequired within parentDynamic properties based on selected option. For example, if `selected_option` is `SWIFT CODE`, payload may include `swiftCode`, `accountHolderName`, and `accountNumber`.
Additional keys: see wildcard field
payload.*JSONAdditional keysAny type
payment_methodstringRequired within parentType of payout method.
selected_optionstringRequired within parentSpecifies the type of bank transfer method. Maps from the requirements type field.
statusstringRequired within parentCurrent status of the payout method (e.g. PENDING, VERIFYING, APPROVED, FAILED).
updated_atstringRequired within parentTimestamp when the payout method was last updated.
Format: date-time
versionstringRequired within parentUnique identifier of the specific version of the payout method.
Format: uuid

Referenced models: Fetch all payout methods — 200 response body — data item address city, country, first line, post code, state

Fetch all payout methods — 200 response body — data item address city, country, first line, post code, state
FieldTypePresenceDescription and constraints
$objectRootAddress associated with the payout method, when available.
citystringOptionalCity name
countrystringOptionalCountry code
first_linestringOptionalFirst line of the address
post_codestringOptionalPost code
statestringOptionalState code

SDK function policy ID: deel.payouts_fetchallpayoutmethods_v2026_01_01. Catalog operation: payouts_fetchallpayoutmethods_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.