Create a budget-to-budget transfer

Transfer money from one budget to another budget.

SecurityCommonAuth
Request
path Parameters
budgetId
required
string <uuid> <= 36 characters

The ID of the budget to work with.

Example: 775596ae-2624-40af-a9dc-9756110a4a03
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json

Body

destinationBudgetId
required
string <uuid> <= 36 characters

The ID of the budget to work with.

currency
required
string
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SEK" "SGD" "SHN" "SLL" "SOS" "SRD" "SSP" "STN" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XOF" "XPD" "XPF" "XPT" "YER" "ZAR" "ZMK" "ZMW" "ZWD"
amount
required
string

The amount to be transferred.

reference
string^[ A-Za-z0-9-,./:?()]{1,18}$

A reference for the transfer.

Responses
200

OK

post/budgets/{budgetId}/transfer
Request samples
application/json
{
  • "destinationBudgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  • "currency": "USD",
  • "amount": "string",
  • "reference": "Personal allowance"
}
Response samples
application/json
{
  • "success": true,
  • "debitBoxTransactionId": "179032",
  • "creditBoxTransactionId": "179033"
}