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.
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"]["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 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.fetch_all_payout_methods(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.is_default | boolean | Optional |
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 Fetch all payout methods — 200 response body |
Referenced models: Fetch all payout methods — 200 response body
Schemas
Section titled “Schemas”Fetch all payout methods — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of payout methods associated with the account. |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | Address associated with the payout method, when available. |
address (anyOf 1) | Model | Alternative | Expand Fetch all payout methods — 200 response body — data item address city, country, first line, post code, state |
address (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Timestamp when the payout method was created. Format: date-time |
id | string | Required within parent | Unique identifier of the payout method (method chain ID). Format: uuid |
is_default | boolean | Required within parent | Specifies if the method is the default payout method - if true, autowithdrawal will be enabled for the contractor using this method |
method_name | JSON | Optional | |
method_name (anyOf 1) | string | Alternative | Name for the method. |
method_name (anyOf 2) | null | Alternative | Name for the method. |
payload | object | Required within parent | Dynamic 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.* | JSON | Additional keys | Any type |
payment_method | string | Required within parent | Type of payout method. |
selected_option | string | Required within parent | Specifies the type of bank transfer method. Maps from the requirements type field. |
status | string | Required within parent | Current status of the payout method (e.g. PENDING, VERIFYING, APPROVED, FAILED). |
updated_at | string | Required within parent | Timestamp when the payout method was last updated. Format: date-time |
version | string | Required within parent | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Address associated with the payout method, when available. |
city | string | Optional | City name |
country | string | Optional | Country code |
first_line | string | Optional | First line of the address |
post_code | string | Optional | Post code |
state | string | Optional | State code |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}