Resolve the Active Budget for an Entity and Currency

GET

https://{{env}}-lb.simplifipay.com/v1/budget/of

Budget

This endpoint resolves the active budget that applies to a given entity (card program, card
group, or Team) in a given currency, and optionally returns how much of it has been utilized
in the current period. This is the endpoint used to check whether a card load would be within
budget before applying it.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Header Params

Responses

🟢200

application/json

Bodyapplication/json

🟠400EntityNotFoundError

🟠401UnauthorizedError

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://uat-lb.simplifipay.com/v1/budget/of?entityUuid=undefined&currency=undefined&includeBudget=undefined' \
--header 'requestUuid;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "uuid": "string",
    "name": "string",
    "entityType": "CARD_PROGRAM",
    "entityUuid": "string",
    "budget": 0,
    "frequency": "string",
    "currency": "string",
    "utilizedBudget": 0,
    "status": "ACTIVE",
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "creationDate": "2019-08-24T14:15:22.123Z",
    "updatedDate": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-09-15 04:11:46

Suspend a Budget

Create a Team