Get dynamic bank transfer requirements

POST

/payouts/employees/methods/bank_transfers/requirements

POST

/rest/payouts/employees/methods/bank_transfers/requirements

curl -X POST https://api.letsdeel.com/rest/payouts/employees/methods/bank_transfers/requirements \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "data": {
    "current_state": {
      "payment_type": "bank_transfer",
      "currency_code": "EUR",
      "bank_country_code": "LT"
    }
  }
}'

{
  "data": {
    "steps": [
      {
        "name": "CUSTOMIZE_ACCOUNT",
        "banner": null,
        "header": "Custom account name",
        "categories": [
          {
            "name": "CUSTOMIZATION",
            "alert": {
              "type": "INFO",
              "title": "Account Name",
              "message": "Add custom account name"
            },
            "banner": null,
            "fields": [
              {
                "id": 1678,
                "key": "custom_name",
                "name": "Account Custom Name",
                "type": "text",
                "example": null,
                "tooltip": null,
                "category": "CUSTOMIZATION",
                "disabled": false,
                "required": false,
                "sensitive": false,
                "max_length": "30",
                "min_length": "0",
                "values_allowed": null,
                "validation_regexp": null,
                "validation_regex_flags": null
              }
            ],
            "header": "Account name",
            "priority": 1
          }
        ],
        "right_side_placeholder": "Customize account"
      },
      {
        "name": "BANK_DETAILS",
        "banner": null,
        "header": "Bank account details",
        "categories": [
          {
            "name": "ROUTING",
            "banner": null,
            "fields": [
              {
                "id": 1676,
                "key": "payment_type",
                "name": "Payment type",
                "type": "select",
                "example": null,
                "tooltip": null,
                "category": "ROUTING",
                "disabled": false,
                "required": false,
                "sensitive": false,
                "values_allowed": [
                  {
                    "key": "bank_transfer",
                    "name": "Bank transfer"
                  },
                  {
                    "key": "paper_checks",
                    "name": "Paper checks"
                  }
                ],
                "validation_regexp": null,
                "validation_regex_flags": null
              },
              {
                "id": 1677,
                "key": "currency_code",
                "name": "Currency",
                "type": "select",
                "example": null,
                "tooltip": null,
                "category": "ROUTING",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "values_allowed": [
                  {
                    "key": "AED",
                    "name": "AED - United Arab Emirates Dirham"
                  },
                  {
                    "key": "AFN",
                    "name": "AFN - Afghani"
                  },
                  {
                    "key": "ALL",
                    "name": "ALL - Albanian Lek"
                  }
                ],
                "validation_regexp": null,
                "validation_regex_flags": null
              },
              {
                "id": 1679,
                "key": "bank_country_code",
                "name": "Bank Country Code",
                "type": "select",
                "example": null,
                "tooltip": null,
                "category": "ROUTING",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "values_allowed": [
                  {
                    "key": "AD",
                    "name": "Andorra"
                  },
                  {
                    "key": "AT",
                    "name": "Austria"
                  },
                  {
                    "key": "BE",
                    "name": "Belgium"
                  }
                ],
                "validation_regexp": null,
                "validation_regex_flags": null
              }
            ],
            "header": "Payment details",
            "priority": 2
          },
          {
            "name": "BANK_DETAILS",
            "banner": null,
            "fields": [
              {
                "id": 109,
                "key": "swift_bic",
                "name": "SWIFT BIC Code",
                "type": "text",
                "example": "BUKBGB22",
                "tooltip": null,
                "category": "BANK_DETAILS",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "max_length": "11",
                "min_length": "8",
                "values_allowed": null,
                "validation_regexp": "^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$",
                "validation_regex_flags": ""
              },
              {
                "id": 321,
                "key": "iban",
                "name": "IBAN",
                "type": "text",
                "example": "SE4550000000058398257466",
                "tooltip": "International Bank Number",
                "category": "BANK_DETAILS",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "values_allowed": null,
                "validation_regexp": "^[^\\s-]+$",
                "validation_regex_flags": "",
                "extensions": [
                  "swift_bic",
                  "bank_name"
                ]
              }
            ],
            "header": "Account details",
            "priority": 1,
            "sub_header": "Please make sure your account is in the <bold>same currency as your contract</bold> to avoid any delays"
          }
        ],
        "right_side_placeholder": "Add bank account details"
      },
      {
        "name": "RECIPIENT_DETAILS",
        "banner": null,
        "header": "Personal information",
        "categories": [
          {
            "name": "PERSONAL",
            "banner": null,
            "fields": [
              {
                "id": 34,
                "key": "full_name",
                "name": "Full Name",
                "type": "text",
                "example": null,
                "tooltip": "With no special characters and only Latin characters",
                "category": "PERSONAL",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "max_length": "140",
                "min_length": "1",
                "values_allowed": null,
                "validation_regexp": "^[a-zA-ZàáâǎäãåāÀÁÂÄÃÅĀæÆçćčÇĆČèéêëēėęÈÉÊËĒĖĘîïíīįìÎÏÍĪĮÌłŁñńÑŃöòóøôōõÖÒÓØŌÕÔœŒßẞțśșšşŚŠŞûüùúūÛÜÙÚŪÿŸžźżŽŹŻ '-.]*$",
                "validation_regex_flags": ""
              }
            ],
            "header": "Recipient details",
            "priority": 2
          },
          {
            "name": "ADDRESS",
            "banner": null,
            "fields": [
              {
                "id": 68,
                "key": "address_line1",
                "name": "Address Line 1",
                "type": "text",
                "example": null,
                "tooltip": null,
                "category": "ADDRESS",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "max_length": "70",
                "min_length": "1",
                "values_allowed": null,
                "validation_regexp": null,
                "validation_regex_flags": null
              },
              {
                "id": 69,
                "key": "address_line2",
                "name": "Address Line 2",
                "type": "text",
                "example": null,
                "tooltip": null,
                "category": "ADDRESS",
                "disabled": false,
                "required": false,
                "sensitive": false,
                "max_length": "70",
                "min_length": "0",
                "values_allowed": null,
                "validation_regexp": null,
                "validation_regex_flags": null
              },
              {
                "id": 70,
                "key": "city",
                "name": "City",
                "type": "text",
                "example": null,
                "tooltip": null,
                "category": "ADDRESS",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "max_length": "35",
                "min_length": "1",
                "values_allowed": null,
                "validation_regexp": null,
                "validation_regex_flags": null
              },
              {
                "id": 107,
                "key": "country_code",
                "name": "Country Code",
                "type": "select",
                "example": "US",
                "tooltip": null,
                "category": "ADDRESS",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "values_allowed": [
                  {
                    "key": "AD",
                    "name": "Andorra"
                  },
                  {
                    "key": "AE",
                    "name": "United Arab Emirates"
                  },
                  {
                    "key": "AF",
                    "name": "Afghanistan"
                  }
                ],
                "validation_regexp": null,
                "validation_regex_flags": null
              },
              {
                "id": 211,
                "key": "province_state",
                "name": "State",
                "type": "text",
                "example": null,
                "tooltip": null,
                "category": "ADDRESS",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "max_length": "35",
                "min_length": "1",
                "values_allowed": null,
                "validation_regexp": null,
                "validation_regex_flags": null
              },
              {
                "id": 287,
                "key": "postal",
                "name": "Postal Code",
                "type": "text",
                "example": null,
                "tooltip": null,
                "category": "ADDRESS",
                "disabled": false,
                "required": true,
                "sensitive": false,
                "values_allowed": null,
                "validation_regexp": null,
                "validation_regex_flags": null
              }
            ],
            "header": "Address",
            "priority": 1
          }
        ],
        "right_side_placeholder": "Add recipient details"
      }
    ],
    "is_final": true,
    "requirements_id": 1250
  }
}

Returns the progressive field requirements needed to configure a bank transfer payout method, based on the data provided in the request. The is_final flag in the response indicates whether all requirements have been satisfied; callers should continue submitting updated data until is_final is true before calling POST /payouts/employees/methods.

Token scopes: worker:read, worker:write

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/

Request

This endpoint expects an object.

dataobjectOptional

Request data

Response

Dynamic Requirements

dataobjectOptional

Response data

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error