search
tradevest.ai

Transfers

hashtag
Create Transfer

post
/transfers

Create Transfer

Authorizations
OAuth2clientCredentialsRequired
Token URL:
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
chevron-right
200

OK

application/json
post
/transfers

hashtag
Get Transfers

get
/products/{customerProductId}/transfers

Get Transfers

Authorizations
OAuth2clientCredentialsRequired
Token URL:
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
chevron-right
200

OK

application/json
get
/products/{customerProductId}/transfers

hashtag
Get Transfer

get
/transfers/{transferId}

Get Transfer

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
transferIdstring · uuidRequired

Unique transfer identification number in UUID format

Responses
chevron-right
200

OK

application/json
get
/transfers/{transferId}

Last updated