Withdrawals

Trigger a withdrawal

Trigger a withdrawal.

Deprecation notice: The user_id field is deprecated, optional, and will be removed in a future version. For business account withdrawals, ownership is determined by the reference account linked to the business.

post/payments/withdrawals

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/payments/withdrawals
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: payments: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

reference_account_idstring uuid required

Reference account unique identifier.

account_group_idstring uuid required

Universally Unique Identifier (UUID) of the account group.

user_idstring uuid

Unique identifier of the user, as a UUID.

amountstring required

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

currency'EUR' | 'GBP'

Alphabetic three-letter ISO 4217 currency code.

  • EUR — Euro.
  • GBP — Pound Sterling.
remittance_informationstring

Payment reference the end user will see in their bank statement for the corresponding credit transfer booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting. See the (Cash balance withdrawal guide).

purpose_codestring

Purpose of the payment based on ExternalPurpose1Code from ISO 20022.

Response

Withdrawal

idstring uuid required

Cash withdrawal 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

reference_account_idstring uuid required

Reference account unique identifier.

account_group_idstring uuid required

Universally Unique Identifier (UUID) of the account group.

user_idstring uuid

Unique identifier of the user, as a UUID.

amountstring required

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

currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR — Euro.
  • GBP — Pound Sterling.
remittance_informationstring required

Payment reference the end user will see in their bank statement for the corresponding credit transfer booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting. See the (Cash balance withdrawal guide).

status'NEW' | 'PROCESSING' | 'CONFIRMED' | 'CANCELLED'

Status of the withdrawal

  • NEW - Withdrawal is created but not started processing.
  • PROCESSING - Withdrawal is in processing.
  • CONFIRMED - Withdrawal was successfully sent to the bank for processing.
  • CANCELLED - Withdrawal was cancelled. Note: In rare instances, a bank may reject a withdrawal after it has been confirmed. For more information, see the Potential cancellation after confirmation section of the guide.
cancellation_reason'CANCELLED_BY_BANK' | 'CANCELLED_BY_UPVEST' | 'CANCELLED_BY_CLIENT' | 'OTHER'

Reason the withdrawal was cancelled. The field is present in case the withdrawal has a status of CANCELLED.

  • CANCELLED_BY_BANK - The payment was not completed by your bank. Please check your account details or contact support.
  • CANCELLED_BY_UPVEST - The payment was cancelled. Contact support for details.
  • CANCELLED_BY_CLIENT - The payment was cancelled at your request.
  • OTHER - Reason not available (applies to historical data only).
purpose_codestring

Purpose of the payment based on ExternalPurpose1Code from ISO 20022.

Changes

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