Skip to content

Deel: Retrieve bank guide — global Payroll get Gp Contract Bank Guide

Deel globalPayroll.getGpContractBankGuide: arguments, response, policy and SDK examples.

← Global payroll operations · Get started

Operation deel.globalpayroll_getgpcontractbankguide_v2026_09_17

Provider route: GET /gp/contracts/{contract_id}/banks/guide. 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["globalPayroll"]["getGpContractBankGuide"]>[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.globalPayroll.getGpContractBankGuide(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.global_payroll.get_gp_contract_bank_guide(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired 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 guide — global Payroll get Gp Contract Bank Guide — 200 response body

Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body

Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item

Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item

Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
is_requiredbooleanRequired within parentIndicates whether the field is required.
keystringRequired within parentThe unique key representing the field.
labelstringOptionalThe label or display name for this field.
typestringOptionalThe type of the field, such as 'Text' or 'Dropdown'.
validationsarrayOptionalAn array of validation rules applied to the field.
validations[]ModelEach itemExpand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item
values_allowedarrayOptionalAn array of allowed values for the field (e.g., for dropdown fields).
values_allowed[]ModelEach itemExpand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item values allowed item

Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item values allowed item, Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item

Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item values allowed item
FieldTypePresenceDescription and constraints
$objectRoot
labelstringOptionalThe display name of the allowed value.
valuestringOptionalThe value associated with the allowed option.
Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item
FieldTypePresenceDescription and constraints
$objectRoot
typestringOptionalThe type of validation applied to the field.
Known values: MIN_LENGTH, MAX_LENGTH, REGEX
valueModelOptionalExpand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value

Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value

Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (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.globalpayroll_getgpcontractbankguide_v2026_09_17. Catalog operation: globalpayroll_getgpcontractbankguide_v2026_09_17. 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: ["people:read"]

Pinned headers: {"X-Version": "2026-09-17"}

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.