Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
balance

Convert or Move Money Between Balances

This endpoint allows conversion and movement of funds between balance accounts.

Convert across balance accounts: Convert funds between two STANDARD balance accounts in different currencies. Requires a quote created with "payOut": "BALANCE".

Move money between balances:

  • Add money to a same-currency jar (move from STANDARD to SAVINGS without conversion)
  • Add money to another-currency jar (convert money using a quote)
  • Withdraw money from a jar (move from SAVINGS to STANDARD without conversion)

Either amount or quoteId is required. Use quoteId for cross-currency movements.

post/v2/profiles/{profileId}/balance-movements

Path parameters

profileIdinteger required

The profile ID.

Headers

X-idempotence-uuidstring uuid required

Unique identifier assigned by you. Used for idempotency check purposes. Should your call fail for technical reasons then you can use the same value again for making a retry call.

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

quoteIdstring uuid

Quote ID. Required for cross-currency movements. Quote must be created with payOut: BALANCE.

sourceBalanceIdinteger

Source balance ID. Required when moving between balances (with targetBalanceId).

targetBalanceIdinteger

Target balance ID. Required when moving between balances (with sourceBalanceId).

Response

Created - Movement completed successfully.

idinteger

Movement transaction ID.

type'DEPOSIT' | 'WITHDRAWAL' | 'CONVERSION'

Type of movement.

state'PENDING' | 'COMPLETED' | 'CANCELLED' | 'REVERSED'

State of the movement.

creationTimestring date-time

When the movement was created.

ratenumber

Exchange rate applied to the conversion.

Example response

{
  "id": 30000001,
  "type": "CONVERSION",
  "state": "COMPLETED",
  "balancesAfter": [
    {
      "id": 1,
      "value": 10000594.71,
      "currency": "GBP"
    }
  ],
  "creationTime": "2017-11-21T09:55:49.275Z",
  "sourceAmount": {
    "value": 113.48,
    "currency": "EUR"
  },
  "targetAmount": {
    "value": 100,
    "currency": "GBP"
  },
  "rate": 0.88558,
  "feeAmounts": [
    {
      "value": 0.56,
      "currency": "EUR"
    }
  ],
  "steps": [
    {
      "id": 369588,
      "type": "CONVERSION",
      "creationTime": "2017-11-21T09:55:49.276Z",
      "balancesAfter": [
        {
          "value": 9998887.01,
          "currency": "EUR"
        }
      ],
      "sourceAmount": {
        "value": 113.48,
        "currency": "EUR"
      },
      "targetAmount": {
        "value": 100,
        "currency": "GBP"
      },
      "fee": {
        "value": 0.56,
        "currency": "EUR"
      },
      "rate": 0.88558
    }
  ]
}