Transfers

Create Transfer

post

Create Transfer

Authorizations

Header parameters

Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body

customerIdstring · uuidRequired

The identifier of the customer.

customerProductIdstring · uuidRequired

Unique customer product identification number in UUID format

referencestring · min: 6 · max: 140Optional

Transfer reference. If not provided, a text 'NOT PROVIDED' will be used. If provided, it must contain at least 6 alphanumeric characters that are not all the same and it can contain special characters include space, hyphen(-), full stop (.), ampersand(&), and forward slash (/).

Example: This is a test SEPA transfer

receiverIbanstring · max: 33Required

IBAN code

Example: DE39500105172896993442Pattern: ^[A-Z]{2}[0-9A-Z]{14,31}$

amountnumberRequired

transfer amount

Example: 750.55

instantbooleanOptional

flag indicating if the transfer is an instant transfer

Default: false

externalIdstringRequired

External Id in partner's system. This value has to be unique.

Example: a2281c82009017817759909450706418Pattern: [a-zA-Z0-9]{32,32}

currencyundefined · enumOptional

Sepa Transfer Currency

Possible values:

Responses

200

OK

application/json

400

Bad Request

application/json

post

HTTPcURLJavaScriptPython

POST /transfers HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerProductId": "123e4567-e89b-12d3-a456-426614174000",
  "reference": "This is a test SEPA transfer",
  "receiverIban": "DE39500105172896993442",
  "amount": 750.55,
  "instant": false,
  "externalId": "a2281c82009017817759909450706418",
  "currency": "EUR"
}

{
  "transferId": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2025-05-23T01:58:54.096Z"
}

Get Transfers

get

Get Transfers

Authorizations

Path parameters

customerProductIdstring · uuidRequired

Unique customer product identification number in UUID format

Query parameters

cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20

externalIdstringOptional

External Id in partner's system. This value has to be unique

startCreatedOnstring · date-timeOptional

Display transfers created on or after this date

endCreatedOnstring · date-timeOptional

Display transfers created on or before this date

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /products/{customerProductId}/transfers HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

{
  "data": [
    {
      "transfer": {
        "transferId": "123e4567-e89b-12d3-a456-426614174000",
        "transferStatus": "RECEIVED",
        "rejectReason": "text",
        "createdOn": "2025-05-23T01:58:54.096Z",
        "modifiedOn": "2025-05-23T01:58:54.096Z",
        "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
        "customerProductId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
        "reference": "This is a test SEPA transfer",
        "name": "Erika Musterfrau",
        "iban": "DE39500105172896993442",
        "bic": "text",
        "amount": 750.55,
        "instant": false,
        "externalId": "a2281c82009017817759909450706418",
        "transactionType": "INCOMING_TRANSFER",
        "currency": "EUR"
      },
      "technicalTransfer": {
        "transferId": "123e4567-e89b-12d3-a456-426614174000",
        "transferStatus": "RECEIVED",
        "createdOn": "2025-05-23T01:58:54.096Z",
        "modifiedOn": "2025-05-23T01:58:54.096Z",
        "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
        "customerProductId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
        "reference": "This is a test SEPA transfer",
        "amount": 750.55,
        "transactionType": "INCOMING_TRANSFER",
        "currency": "EUR"
      }
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Transfer

get

Get Transfer

Authorizations

Path parameters

transferIdstring · uuidRequired

Unique transfer identification number in UUID format

Responses

200

OK

application/json

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /transfers/{transferId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

{
  "transfer": {
    "transferId": "123e4567-e89b-12d3-a456-426614174000",
    "transferStatus": "RECEIVED",
    "rejectReason": "text",
    "createdOn": "2025-05-23T01:58:54.096Z",
    "modifiedOn": "2025-05-23T01:58:54.096Z",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "customerProductId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
    "reference": "This is a test SEPA transfer",
    "name": "Erika Musterfrau",
    "iban": "DE39500105172896993442",
    "bic": "text",
    "amount": 750.55,
    "instant": false,
    "externalId": "a2281c82009017817759909450706418",
    "transactionType": "INCOMING_TRANSFER",
    "currency": "EUR"
  },
  "technicalTransfer": {
    "transferId": "123e4567-e89b-12d3-a456-426614174000",
    "transferStatus": "RECEIVED",
    "createdOn": "2025-05-23T01:58:54.096Z",
    "modifiedOn": "2025-05-23T01:58:54.096Z",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "customerProductId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
    "reference": "This is a test SEPA transfer",
    "amount": 750.55,
    "transactionType": "INCOMING_TRANSFER",
    "currency": "EUR"
  }
}