Query a Budget

Retrieve the details and multi-currency balances of a specific budget account by its ID.
Request Parameters
idstring
required
Unique budget account identifier returned by Create a Budget. Max 64 characters.
Response Parameters
resultResult
See Result.
idstring
Unique budget account identifier. Max 64 characters.
namestring
Budget account name.
statusstring
Current budget account status.

Valid Values:

ACTIVE — Account is activated and ready to use.
FAILED — Account creation failed.
createdAtdatetime
Timestamp when the budget account was created. ISO 8601 extended format.
balanceAmountsarray
An array of Amount objects representing balances in multiple currencies. Contains at most one entry per currency. Empty when status is FAILED. See Data Types.
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSSuccess.N/A
BUDGET_NOT_FOUNDFBudget account {id} not found.Verify the `id` is correct.
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.
PARAM_ILLEGALFIllegal parameters exist.Verify request fields against this reference.
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/query
Request
{
"id": "BUDGET_20260808100101****"
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"id": "BUDGET_20260808100101****",
"name": "Marketing Cards Q3",
"status": "ACTIVE",
"createdAt": "2026-08-08T10:56:52Z",
"balanceAmounts": [
  {
    "currency": "USD",
    "value": 100
  }
]
}