TransferRequirement

The fields a transfer needs.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

created, err := client.TransferRequirement(nil).Create(map[string]any{"quoteUuid": "example", "targetAccount": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)

Lua

Construct client as shown in the Lua setup, then call the operations:

local created, err = client:TransferRequirement():create({ quoteUuid = "example", targetAccount = 1 })

PHP

Construct client as shown in the PHP setup, then call the operations:

$created = $client->TransferRequirement()->create(["quoteUuid" => "example", "targetAccount" => 1]);

Python

Construct client as shown in the Python setup, then call the operations:

created = client.TransferRequirement().create({ "quoteUuid": "example", "targetAccount": 1 })

Ruby

Construct client as shown in the Ruby setup, then call the operations:

created = client.TransferRequirement.create({ "quoteUuid" => "example", "targetAccount" => 1 })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const created = await client.TransferRequirement().create({ quoteUuid: "example", targetAccount: 1 })

Fields

create

POST /transfer-requirements

Operation ID: transferRequirementsValidate.

Authentication: bearer token (UserToken) or bearer token (PersonalToken).

Parameters

Request body

application/json

Example request body:

{
  "details": {
    "reference": "Invoice 2026-001",
    "sourceOfFunds": "verification.source.of.funds.salary",
    "transferPurpose": "verification.transfers.purpose.pay.bills"
  },
  "originatorLegalEntityType": "PRIVATE",
  "quoteUuid": "8fa9be20-ba43-4b15-abbb-9424e1481050",
  "targetAccount": 8692237
}

Responses

200: Returns a list of transfer requirement objects describing the dynamic form fields

application/json

Example response:

[
  {
    "fields": [
      {
        "group": [
          {
            "displayFormat": null,
            "example": null,
            "key": "reference",
            "maxLength": 10,
            "minLength": null,
            "name": "Transfer reference",
            "refreshRequirementsOnChange": false,
            "required": false,
            "type": "text",
            "validationAsync": null,
            "validationRegexp": "[a-zA-Z0-9- ]*",
            "valuesAllowed": null
          }
        ],
        "name": "Transfer reference"
      },
      {
        "group": [
          {
            "displayFormat": null,
            "example": null,
            "key": "transferPurpose",
            "maxLength": null,
            "minLength": null,
            "name": "Transfer purpose",
            "refreshRequirementsOnChange": true,
            "required": true,
            "type": "select",
            "validationAsync": null,
            "validationRegexp": null,
            "valuesAllowed": [
              {
                "key": "verification.transfers.purpose.purchase.property",
                "name": "Buying property abroad"
              },
              {
                "key": "verification.transfers.purpose.pay.bills",
                "name": "Rent or other property expenses"
              },
              {
                "key": "verification.transfers.purpose.mortgage",
                "name": "Mortgage payment"
              },
              {
                "key": "verification.transfers.purpose.pay.tuition",
                "name": "Tuition fees or studying expenses"
              },
              {
                "key": "verification.transfers.purpose.send.to.family",
                "name": "Sending money home to family"
              },
              {
                "key": "verification.transfers.purpose.living.expenses",
                "name": "General monthly living expenses"
              },
              {
                "key": "verification.transfers.purpose.other",
                "name": "Other"
              }
            ]
          },
          {
            "displayFormat": null,
            "example": null,
            "key": "transferPurposeSubTransferPurpose",
            "maxLength": null,
            "minLength": null,
            "name": "Please select a specific reason for your transfer",
            "refreshRequirementsOnChange": true,
            "required": true,
            "type": "select",
            "validationAsync": null,
            "validationRegexp": null,
            "valuesAllowed": [
              {
                "key": "INTERPRETATION_SERVICE",
                "name": "Interpretation service"
              },
              {
                "key": "TRANSLATION_SERVICE",
                "name": "Translation service"
              },
              {
                "key": "HUMAN_RESOURCE_SERVICE",
                "name": "Human resource service"
              },
              {
                "key": "SOFTWARE_DEVELOPMENT_SERVICE",
                "name": "Software development service"
              }
            ]
          }
        ],
        "name": "Transfer purpose"
      },
      {
        "group": [
          {
            "displayFormat": null,
            "example": null,
            "key": "sourceOfFunds",
            "maxLength": null,
            "minLength": null,
            "name": "Source of funds",
            "refreshRequirementsOnChange": true,
            "required": true,
            "type": "select",
            "validationAsync": null,
            "validationRegexp": null,
            "valuesAllowed": [
              {
                "key": "verification.source.of.funds.salary",
                "name": "Salary"
              },
              {
                "key": "verification.source.of.funds.investment",
                "name": "Investments (stocks, properties, etc.)"
              },
              {
                "key": "verification.source.of.funds.inheritance",
                "name": "Inheritance"
              },
              {
                "key": "verification.source.of.funds.loan",
                "name": "Loan"
              },
              {
                "key": "verification.source.of.funds.other",
                "name": "Other"
              }
            ]
          }
        ],
        "name": "Source of funds"
      }
    ],
    "type": "transfer"
  }
]

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.