Withdraw from a Budget

Withdraw funds from a budget account back to your balance account. Only budget accounts in ACTIVE status can be withdrawn from.
Request Parameters
requestIdstring
required
Idempotency key. Required for all fund-movement operations. Assign a unique value per request to safely retry without double-processing. Must be unique within your partnerId. Max 64 characters.
idstring
required
Unique budget account identifier returned by Create a Budget. Max 64 characters.
amountAmount
required
Withdrawal amount. value must be greater than 0. See Data Types.
Response Parameters
resultResult
See Result.
idstring
Unique budget account identifier. Max 64 characters.
amountAmount
Withdrawal amount. See Data Types.
statusstring
Withdrawal operation status (e.g., SUCCESS).
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSSuccess.Withdrawal succeeded.
BUDGET_NOT_FOUNDFBudget account {id} not found.Verify the `id` is correct.
BUDGET_ACCOUNT_STATUS_INACTIVEFBudget account is not in ACTIVE status.Only `ACTIVE` budget accounts can be withdrawn from.
BALANCE_NOT_ENOUGHFBalance insufficient.Ensure the budget account has sufficient available balance.
USER_NOT_EXISTFThe user does not exist.Retry with correct user information.
AUTHORIZATION_NOT_EXISTFThe authorization relationship does not exist.Verify the `account-id` / `access-token` authorization before retrying.
CONTRACT_CHECK_FAILFThe contract check has failed.Contact WorldFirst support to confirm the contract status, then retry.
REPEAT_REQ_INCONSISTENTFRepeated requests are inconsistent.A prior request reused this `requestId` with different parameters. Keep all parameters identical, or use a new `requestId`.
PARAM_ILLEGALFIllegal parameters exist.Verify request fields against this reference, including the `amount` structure.
PROCESS_FAILFA general business failure occurred. Do not retry.Do not retry. Contact WorldFirst support.
UNKNOWN_EXCEPTIONUAn unknown exception occurred.Server error. Retry later; contact WorldFirst support if the issue persists.
Definition
POST /api/open/v1/issuing/budgets/withdraw
Request
{
"requestId": "req_withdraw_20240101****",
"id": "BUDGET_20260401100101****",
"amount": {
  "value": 20000,
  "currency": "USD"
}
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"id": "BUDGET_20260401100101****",
"amount": {
  "value": 20000,
  "currency": "USD"
},
"status": "SUCCESS"
}