API status
  • Tests

Tests

All test related paths.

post

Trigger a bank transaction

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.

accountobject

required

The Upvest account identification

ibanstring

required

International Bank Account Number IBAN.

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

required

Pattern
^[0-9]{1,9}(\.[0-9]{2})?$
currencystring

required

Alphabetic three-letter ISO 4217 currency code

Enum
  • EUR
  • GBP
  • USD
  • JPY
  • CHF
remittance_informationstring

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.

Pattern
^[0-9A-Za-z+?/\-:()\.,'; ]{0,140}$
Max Length
140
client_referencestring

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.

Pattern
^[0-9A-Za-z+?/\-:()\.,'; ]{0,35}$
Max Length
35
counterparty_namestring

required

The counterparty account owner

Pattern
^[0-9A-Za-z+?/\-:()\.,'; ]{0,140}$
Max Length
140
counterparty_accountobject

required

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

ibanstring

required

International Bank Account Number IBAN.

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

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

bicstring

required

Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) ISO 9362.

Pattern
^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$
virtual_bank_account_idstring

The ID of the virtual bank account to which you want to send the money.

Format
uuid
purpose_codestring

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

Max Length
4

Responses

Request examples

{
  "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"
}

Response examples

Bank Transaction

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

Was this page helpful?