Create a Budget

POST

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

Budget

This endpoint creates a budget for a card program, a card group, or a Team, in a given
currency. Only one active budget can apply to a given entity/currency combination at a time.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠400EntityNotFoundError

🟠401UnauthorizedError

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://uat-lb.simplifipay.com/v1/budget' \
--header 'requestUuid;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "uuid": "string",
    "entityType": "CARD_PROGRAM",
    "entityUuid": "string",
    "name": "Marketing Budget",
    "budget": 0,
    "frequency": "MONTHLY",
    "currency": "AED"
}'

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 or Reactivate a Receipt Rule

List Budgets