Create a recurring transfer into a savings goal

put/api/v2/account/{accountUid}/savings-goals/{savingsGoalUid}/recurring-transfer

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

Request body

topUpboolean

If the payment is a top up or not

referencestring nullable

The reference used on each occasion

Example request

{
  "recurrenceRule": {
    "startDate": "2023-01-01",
    "interval": 2,
    "count": 10,
    "untilDate": "2023-01-01"
  },
  "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
}