Sign in
Savings Goals

Withdraw money from a savings goal

put/api/v2/account/{accountUid}/savings-goals/{savingsGoalUid}/withdraw-money/{transferUid}

Path parameters

accountUidstring uuid required
Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Account uid

savingsGoalUidstring uuid required
Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Savings goal uid

transferUidstring uuid required
Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Transfer uid, generated by the caller

Request body

referencestring nullable

The reference for the withdrawal from a savings goal.

Example request

{
  "amount": {
    "currency": "GBP",
    "minorUnits": 123456
  }
}

Response

Successful operation

transferUidstring uuid required

Unique identifier for the transfer

successboolean

True if the method completed successfully

Example response

{
  "transferUid": "88998899-8899-8899-8899-889988998899",
  "success": true
}