Sign in

v2

latestOpenAPI 3.0.3Apache 2.02026-08-0715707.5 MB
ISA Transfers

Create ISA transfer

Create ISA transfer

post/isa/transfers

Headers

idempotency-keystring uuid required
Example:ccb07f42-4104-44ad-8e1f-c660bb7b269c

A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency

Request body

direction'INCOMING' | 'OUTGOING' required

Direction of the ISA transfer

  • INCOMING - Transfer is incoming to the user.
  • OUTGOING - Transfer is outgoing from the user.
transfer_type'ISA_INTERNAL' | 'ISA_EXTERNAL' required

Type of the securities transfer

  • ISA_INTERNAL - Transfer occurs within the same ISA manager.
  • ISA_EXTERNAL - Transfer occurs across different ISA managers, via Equisoft or others.
transfer_valuestring
currency'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • GBP - Great British Pound
transfer_method'CASH' required

Method of the ISA transfer

  • CASH - Cash transfer.

Other methods can be supported in the future, e.g. IN_SPECIE

user_idstring uuid required

User unique identifier.

account_group_idstring uuid required

Account group unique identifier.

referencestring

Random string reference on which API clients can build logic.

transfer_datestring date-time required

The date when end user initiated the transfer. Relevant for tax year's end reporting. If not sent it will be the time we create the transfer internally on our side. RFC 3339-5, ISO8601 UTC

Response

ISA Transfer created

idstring uuid required

ISA transfer request unique identifier.

created_atstring date-time required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

updated_atstring date-time required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

direction'INCOMING' | 'OUTGOING' required

Direction of the ISA transfer

  • INCOMING - Transfer is incoming to the user.
  • OUTGOING - Transfer is outgoing from the user.
status'NEW' | 'DISCOVERY' | 'DISCOVERY_CONFIRMED' | 'INSTRUCTED' | 'PROCESSING' | 'SETTLED' required

Status of the transfer

  • NEW - Transfer is created.
  • DISCOVERY - Discovery with the ceding provider where information about the transfer is being exchanged and reviewed. Only relevant if type ISA_EXTERNAL.
  • DISCOVERY_CONFIRMED - Discovery is completed and transfer request is accepted by the ceding provider. Only relevant if type ISA_EXTERNAL.
  • INSTRUCTED - Transfer is instructed to the ceding provider.
  • PROCESSING - Transfer instruction is confirmed by the ceding provider. Transfer is being processed.
  • SETTLED - Transfer is completed.
transfer_type'ISA_INTERNAL' | 'ISA_EXTERNAL' required

Type of the securities transfer

  • ISA_INTERNAL - Transfer occurs within the same ISA manager.
  • ISA_EXTERNAL - Transfer occurs across different ISA managers, via Equisoft or others.
transfer_valuestring
currency'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • GBP - Great British Pound
transfer_method'CASH' required

Method of the ISA transfer

  • CASH - Cash transfer.

Other methods can be supported in the future, e.g. IN_SPECIE

user_idstring uuid required

User unique identifier.

account_group_idstring uuid required

Account group unique identifier.

referencestring required

Random string reference on which API clients can build logic.

transfer_datestring date-time required

The date when end user initiated the transfer. Relevant for tax year's end reporting. RFC 3339-5, ISO8601 UTC