Portfolio Transfers

Allocates funds from a same-currency wallet into a portfolio so they start earning rewards. The source wallet must hold sufficient balance to cover the deposit amount.

post/earn/v1/deposits

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 deposit funds into.

referencestring required

Unique reference identifier for the deposit transaction.

Example request

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

Response

Created

idstring uuid

Unique identifier of the deposit operation.

referencestring

Unique reference identifier for the deposit.

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

Status of a portfolio transfer (deposit or withdrawal).

portfolioIdstring uuid

Unique identifier of the portfolio involved in the deposit.

originatorWalletIdstring

Unique identifier of the originator wallet.

createdAtstring date-time

Timestamp when the deposit was created.

updatedAtstring date-time

Timestamp when the deposit was last updated.

Example response

{
  "id": "660e8400-e29b-41d4-a716-446655440000",
  "reference": "DEP-2024-001",
  "createdAt": "2026-08-20T09:15:00Z",
  "updatedAt": "2026-08-20T09:15:04Z"
}

Changes