Skip to content
/Tests

Upvest Investment API (1.80.0)

Upvest Investment API.

Download OpenAPI description
api.json
api.yaml
Overview
URL
https://docs.upvest.co
Upvest API Support
api@upvest.co
License
Apache 2.0
Languages
Servers
Sandbox environment
https://sandbox.upvest.co/
Live environment
https://api.upvest.co/

Access Tokens

All authentication related paths.

Operations

Users

All user related paths.

OperationsWebhooks

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

OperationsWebhooks

Accounts

All accounts related paths

OperationsWebhooks

Account Groups

All account groups related paths

OperationsWebhooks

Tax Residencies

All tax residencies related paths.

Operations

Corporate Actions

All Corporate Action related paths.

Webhooks

Tax Wrappers

All tax wrappers related paths

OperationsWebhooks

Tax Exemptions

All tax exemptions related paths

OperationsWebhooks

Tax Collections

All tax collections related paths

Webhooks

Instruments

All instrument related paths.

OperationsWebhooks

Price Data

All price data related paths.

Operations

Orders

All order related paths.

OperationsWebhooks

Portfolios

All portfolios related paths.

Operations

Portfolios Rebalancing

All portfolios rebalancing related paths.

OperationsWebhooks

Savings Plans

All savings plans related paths.

OperationsWebhooks

Liquidations

All accounts liquidations related paths.

OperationsWebhooks

Direct Debits

All direct debits related paths

OperationsWebhooks

Top-ups

All top-ups related paths

OperationsWebhooks

Withdrawals

All withdrawals related paths

OperationsWebhooks

Reference Accounts

All reference account related paths

Operations

Mandates

All direct debit mandates related paths

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks

Credit Fundings

All credit fundings related paths

OperationsWebhooks

Cash Balances

All cash balance related paths

OperationsWebhooks

Positions

All positions related paths.

OperationsWebhooks

Valuations

All valuations related paths.

OperationsWebhooks

Returns

All accounts returns related paths.

OperationsWebhooks

Virtual Cash Balances

All virtual cash balances related paths

OperationsWebhooks

Fees

All fees related paths.

OperationsWebhooks

Fees Configurations

All fees configurations related paths.

Operations

Transaction Fees Models

All transaction fees models related paths.

Reports

All reports related paths.

OperationsWebhooks

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

OperationsWebhooks

Files

All files API related paths.

Operations

Account Transfers

All Accounts Transfers related paths.

OperationsWebhooks

Securities Transfers

All Securities Transfers related paths.

OperationsWebhooks

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Tests

All test related paths.

Operations

Trigger a bank transaction

Request

Trigger a bank transaction for testing purposes. This can be used to simulate a money transfer for various flows which need cash settlements on one of our bank accounts.

Security
oauth-client-credentials
Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^Bearer [a-zA-Z0-9\-\._~+/]*=*required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example: Bearer c2VjcmV0Cg==
signaturestringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

idempotency-keystring(uuid)^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-f...required

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

Example: ccb07f42-4104-44ad-8e1f-c660bb7b269c
upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default 1
Value"1"
Example: 1
Bodyapplication/json
accountobjectrequired

The Upvest account identification

ibanstring^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$required

International Bank Account Number IBAN.

amountstring^[0-9]{1,9}(\.[0-9]{2})?$required
currencystringrequired

Alphabetic three-letter ISO 4217 currency code

Enum"EUR""GBP""USD""JPY""CHF"
client_referencestring<= 35 characters^[0-9A-Za-z+?/\-:()\.,'; ]{0,35}$required

Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.

counterparty_namestring<= 140 characters^[0-9A-Za-z+?/\-:()\.,'; ]{0,140}$required

The counterparty account owner

counterparty_accountobjectrequired

Unambiguous identification of the account of the counterparty of the bank transaction

ibanstring^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$required

International Bank Account Number IBAN.

remittance_informationstring<= 140 characters^[0-9A-Za-z+?/\-:()\.,'; ]{0,140}$

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

counterparty_agentobject

Unambiguous identification of the agent of the counterparty of the bank transaction

virtual_bank_account_idstring(uuid)

Virtual bank account request unique identifier.

purpose_codestring<= 4 characters

An optional parameter, which describes the purpose of the payment based on ExternalPurpose1Code from ISO 20022.

curl -i -X POST \
  https://sandbox.upvest.co/tests/payments/transactions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'authorization: Bearer c2VjcmV0Cg==' \
  -H 'idempotency-key: ccb07f42-4104-44ad-8e1f-c660bb7b269c' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062' \
  -d '{
    "account": {
      "iban": "NL70ABNA0106295004"
    },
    "amount": "13.37",
    "currency": "EUR",
    "client_reference": "client-reference",
    "remittance_information": "remittance-info",
    "purpose_code": "OTHR",
    "counterparty_name": "counterparty-name",
    "counterparty_account": {
      "iban": "DE95500105173934555844"
    },
    "counterparty_agent": {
      "bic": "DEUTDEFF"
    },
    "virtual_bank_account_id": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"
  }'

Responses

Bank Transaction

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Bodyapplication/json
idstring(uuid)required

Bank transaction unique identifier

bank_referencestringrequired

Bank reference of the bank transaction (created by the bank to unambiguously identify the bank transaction in the banks systems)

Response
application/json
{
  "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99",
  "bank_reference": "f2f0ef23-c68d-42c1-a744-8c86f471954b"
}