Get bank transfer requirements

GET

/payouts/contractors/methods/bank_transfers/requirements

GET

/rest/payouts/contractors/methods/bank_transfers/requirements

curl -G https://api.letsdeel.com/rest/payouts/contractors/methods/bank_transfers/requirements \
     -H "Authorization: Bearer <token>" \
     -d amount=100 \
     -d country=US \
     -d currency=USD

{
  "data": [
    {
      "type": "turkey",
      "title": "Local bank account",
      "fields": [
        {
          "name": "Recipient's first name",
          "group": [
            {
              "key": "firstName",
              "name": "Recipient's first name",
              "type": "text",
              "required": true,
              "max_length": 50
            }
          ]
        },
        {
          "name": "Recipient's last name",
          "group": [
            {
              "key": "lastName",
              "name": "Recipient's last name",
              "type": "text",
              "required": true,
              "max_length": 50
            }
          ]
        },
        {
          "name": "Recipient's phone number",
          "group": [
            {
              "key": "phone",
              "name": "Recipient's phone number",
              "type": "text",
              "required": true,
              "max_length": 20
            }
          ]
        },
        {
          "name": "Account Number (IBAN)",
          "group": [
            {
              "key": "bank_account",
              "name": "Recipient's IBAN",
              "type": "text",
              "required": true,
              "example": "TR1234567890",
              "max_length": 26
            }
          ]
        }
      ],
      "total_fee": "0.0000"
    },
    {
      "type": "swift_code",
      "title": "SWIFT",
      "fields": [
        {
          "name": "Full name of the account holder",
          "group": [
            {
              "key": "beneficiaryName",
              "name": "Full name of the account holder",
              "type": "text",
              "required": true,
              "example": "John Doe",
              "refresh_requirements_on_change": false
            }
          ]
        },
        {
          "name": "SWIFT / BIC code",
          "group": [
            {
              "key": "swiftCode",
              "name": "SWIFT / BIC code",
              "type": "text",
              "required": true,
              "example": "BUKBGB22",
              "max_length": 11,
              "min_length": 8,
              "display_format": null,
              "values_allowed": null,
              "validation_regexp": "^[a-zA-Z]{6}(([a-zA-Z0-9]{2})|([a-zA-Z0-9]{5}))$",
              "refresh_requirements_on_change": true
            }
          ]
        },
        {
          "name": "IBAN / Account Number",
          "group": [
            {
              "key": "accountNumber",
              "name": "IBAN / Account Number",
              "type": "text",
              "required": true,
              "example": "123456789012",
              "max_length": 34,
              "min_length": 4,
              "display_format": null,
              "values_allowed": null,
              "validation_regexp": "^[a-zA-Z0-9]{4,34}$",
              "refresh_requirements_on_change": false
            }
          ]
        }
      ],
      "total_fee": "5.0000",
      "intermediary": [
        {
          "name": "BIC of the intermediary bank",
          "group": [
            {
              "key": "intermediary.bic",
              "name": "BIC of the intermediary bank",
              "type": "text",
              "required": true,
              "example": "BUKBGB22",
              "max_length": 11,
              "min_length": 8,
              "values_allowed": null,
              "validation_regexp": "^[a-zA-Z]{6}(([a-zA-Z0-9]{2})|([a-zA-Z0-9]{5}))$",
              "display_format": null,
              "refresh_requirements_on_change": true
            }
          ]
        },
        {
          "name": "Country of the intermediary bank",
          "group": [
            {
              "key": "intermediary.country",
              "name": "Country of the intermediary bank",
              "type": "select",
              "required": true,
              "example": "Choose a country",
              "max_length": null,
              "min_length": null,
              "values_allowed": [
                {
                  "key": "AS",
                  "name": "American Samoa"
                },
                {
                  "key": "AD",
                  "name": "Andorra"
                },
                {
                  "key": "AO",
                  "name": "Angola"
                }
              ],
              "validation_regexp": null,
              "display_format": null,
              "refresh_requirements_on_change": true
            }
          ]
        }
      ]
    }
  ]
}

Call this endpoint before creating a bank transfer payout method to determine the required input fields for the given country and currency, along with a fee preview for the specified amount (defaulting to 100.00 when none is provided). The returned fields map directly to the payload expected by the bank transfer method creation endpoint.

Token scopes: worker: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

Country code

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

Currency code

amountdoubleOptional

Amount for calculating fees, if not provided, the default amount of 100.00 is used

Response

Successful operation.

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error