Get static employee bank transfer requirements | Deel

{
  "data": [
    {
      "type": "bts",
      "title": "Local Bank Transfer",
      "fields": [
        {
          "name": "IBAN",
          "group": [
            {
              "key": "iban",
              "name": "IBAN",
              "is_required": true,
              "type": "text",
              "example": "LT121000011101001000",
              "max_length": 20,
              "min_length": 20,
              "display_format": "IBAN",
              "validation_regexp": "^LT[0-9]{18}$"
            }
          ]
        },
        {
          "name": "Bank country",
          "group": [
            {
              "key": "bankCountryCode",
              "name": "Bank country",
              "is_required": true,
              "type": "country",
              "values_allowed": [
                {
                  "key": "LT",
                  "name": "Lithuania"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Returns the static bank transfer requirements for a bank country and currency, as resolved for employee payouts: the preferred transfer type (BTS, then local bank account, IBAN or SWIFT) with its input fields and validation rules. Needs no employee or contract context, so organization tokens can call it. Returns no fees and does not re-evaluate requirements as values change; for that, use POST /payouts/employees/methods/bank_transfers/requirements.

Token scopes: payments:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

countrystringRequiredformat: "^[A-Z]{2}$"=2 characters

Bank country as an ISO 3166-1 alpha-2 code.

currencystringRequiredformat: "^[A-Z]{3}$"=3 characters

Payout currency as an ISO 4217 code.

Response

Successful operation.

datalist of objects

The preferred transfer type for the country and currency, as a list of at most one item. Empty when no route supports them.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error