Tests

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.

post/tests/payments/transactions

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/tests/payments/transactions
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: tests:admin)

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

amountstring required

A positive cash amount, as a decimal string with up to two decimal places.

currency'EUR' | 'GBP' | 'USD' | 'JPY' | 'CHF' required

Alphabetic three-letter ISO 4217 currency code

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.

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.

counterparty_namestring required

The counterparty account owner

virtual_bank_account_idstring uuid

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

purpose_codestring

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

Response

Bank Transaction

idstring uuid required

Bank transaction unique identifier

bank_referencestring required

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

Changes

No recorded changes to this operation across all 25 revisions of this API.