Portfolio Transfers

Create withdrawal

Changed on

Withdraws funds from a portfolio back into a same-currency wallet you own. The portfolio must hold sufficient balance to cover the withdrawal amount.

post/earn/v1/withdrawals

Request

Headers

Idempotency-Keystring required

Unique key to safely retry the request without performing the operation twice

Request body

portfolioIdstring uuid required

UUID of the portfolio to withdraw funds from.

referencestring required

Unique reference identifier for the withdrawal transaction.

Example request

{
  "portfolioId": "550e8400-e29b-41d4-a716-446655440000",
  "reference": "WTH-2024-001",
  "beneficiary": {
    "walletId": "a:25041872910033:pXk9RmF:1",
    "amount": 1000
  },
  "counterparty": {
    "walletId": "a:25041872910033:pXk9RmF:1",
    "amount": 1000
  }
}

Response

Created

idstring uuid

Unique identifier of the withdrawal operation.

referencestring

Unique reference identifier for the withdrawal.

status'PROCESSING' | 'COMPLETED' | 'FAILED'

Status of a portfolio transfer (deposit or withdrawal).

portfolioIdstring uuid

Unique identifier of the portfolio involved in the withdrawal.

beneficiaryWalletIdstring

Unique identifier of the beneficiary wallet.

createdAtstring date-time

Timestamp when the withdrawal was created.

updatedAtstring date-time

Timestamp when the withdrawal was last updated.

Example response

{
  "id": "770e8400-e29b-41d4-a716-446655440000",
  "reference": "WTH-2024-001",
  "createdAt": "2026-08-21T14:02:30Z",
  "updatedAt": "2026-08-21T14:02:33Z"
}

Changes