---
updatedAt: 2026-07-28T06:01:08.000Z
agentTools:
  projectIndex: https://docs.payplus.co.il/llms.txt
---

# Check Budget

Checks balance and usage by card UUID. Do not send credentials in this mode.

Checks balance and usage by card credentials. Do not send card_uuid in this mode.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Wittix Cards",
    "version": "0.1.1",
    "description": "Public Wittix Cards API definition.\nThis definition is scoped to card and transaction routes only."
  },
  "servers": [
    {
      "url": "https://api-dev.wittix.com/v1",
      "description": "Wittix Staging API"
    }
  ],
  "security": [
    {
      "AuthorizationHeader": []
    }
  ],
  "components": {
    "securitySchemes": {
      "AuthorizationHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization"
      }
    }
  },
  "tags": [
    {
      "name": "Transactions"
    }
  ],
  "paths": {
    "/cards/transactions/check-budget": {
      "post": {
        "tags": [
          "Transactions"
        ],
        "summary": "Check Budget",
        "description": "Checks balance and usage by card UUID. Do not send credentials in this mode.\n\nChecks balance and usage by card credentials. Do not send card_uuid in this mode.",
        "operationId": "wittix-transactions-check-budget",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "title": "By card UUID",
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "company_uuid",
                      "card_uuid"
                    ],
                    "properties": {
                      "company_uuid": {
                        "type": "string",
                        "description": "Public PayPlus company UUID."
                      },
                      "card_uuid": {
                        "type": "string",
                        "description": "Card UUID. Use this mode without card credentials."
                      },
                      "currency": {
                        "type": "string",
                        "description": "Currency code. Defaults to ILS.",
                        "default": "ILS"
                      }
                    }
                  },
                  {
                    "title": "By card credentials",
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "company_uuid",
                      "card_number",
                      "cvv",
                      "expiry_month",
                      "expiry_year"
                    ],
                    "properties": {
                      "company_uuid": {
                        "type": "string",
                        "description": "Public PayPlus company UUID."
                      },
                      "card_number": {
                        "type": "string",
                        "description": "Card PAN. Required when card_uuid is not sent."
                      },
                      "cvv": {
                        "type": "string",
                        "description": "Card CVV. Required when card_uuid is not sent."
                      },
                      "expiry_month": {
                        "type": "integer",
                        "description": "Card expiry month. Required when card_uuid is not sent.",
                        "minimum": 1,
                        "maximum": 12
                      },
                      "expiry_year": {
                        "type": "integer",
                        "description": "Card expiry year. Required when card_uuid is not sent.",
                        "minimum": 2000,
                        "maximum": 2199
                      },
                      "currency": {
                        "type": "string",
                        "description": "Currency code. Defaults to ILS.",
                        "default": "ILS"
                      }
                    }
                  }
                ]
              },
              "examples": {
                "Check Budget - By Card UUID": {
                  "value": {
                    "company_uuid": "{{company_uuid}}",
                    "card_uuid": "{{card_uuid}}",
                    "currency": "{{currency}}"
                  }
                },
                "Check Budget - By Credentials": {
                  "value": {
                    "company_uuid": "{{company_uuid}}",
                    "card_number": "{{card_number}}",
                    "cvv": "{{cvv}}",
                    "expiry_month": 12,
                    "expiry_year": 2028,
                    "currency": "{{currency}}"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success response envelope",
            "content": {
              "application/json": {
                "examples": {
                  "Success": {
                    "value": {
                      "results": {
                        "status": "success",
                        "code": 0
                      },
                      "data": {
                        "currency": "ILS",
                        "balance": 10000,
                        "finalBalance": 10000,
                        "daily_usage": {
                          "count": 1,
                          "amount": 2500
                        },
                        "monthly_usage": {
                          "count": 3,
                          "amount": 7500
                        },
                        "card": {
                          "uuid": "card-uuid",
                          "type": "GIFT",
                          "last4": "1234",
                          "status": "active"
                        }
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "additionalProperties": true,
                  "required": [
                    "results",
                    "data"
                  ],
                  "properties": {
                    "results": {
                      "type": "object",
                      "additionalProperties": true,
                      "required": [
                        "status",
                        "code"
                      ],
                      "properties": {
                        "status": {
                          "type": "string"
                        },
                        "code": {
                          "type": "integer"
                        }
                      }
                    },
                    "data": {
                      "type": "object",
                      "additionalProperties": true,
                      "required": [
                        "currency",
                        "balance",
                        "finalBalance",
                        "daily_usage",
                        "monthly_usage",
                        "card"
                      ],
                      "properties": {
                        "currency": {
                          "type": "string"
                        },
                        "balance": {
                          "type": "integer"
                        },
                        "finalBalance": {
                          "type": "integer"
                        },
                        "daily_usage": {
                          "type": "object",
                          "additionalProperties": true,
                          "required": [
                            "count",
                            "amount"
                          ],
                          "properties": {
                            "count": {
                              "type": "integer"
                            },
                            "amount": {
                              "type": "integer"
                            }
                          }
                        },
                        "monthly_usage": {
                          "type": "object",
                          "additionalProperties": true,
                          "required": [
                            "count",
                            "amount"
                          ],
                          "properties": {
                            "count": {
                              "type": "integer"
                            },
                            "amount": {
                              "type": "integer"
                            }
                          }
                        },
                        "card": {
                          "type": "object",
                          "additionalProperties": true,
                          "required": [
                            "uuid",
                            "type",
                            "last4",
                            "status"
                          ],
                          "properties": {
                            "uuid": {
                              "type": "string"
                            },
                            "type": {
                              "type": "string"
                            },
                            "last4": {
                              "type": "string"
                            },
                            "status": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Error response envelope",
            "content": {
              "application/json": {
                "examples": {
                  "Error - Both Identifier Modes Sent": {
                    "value": {
                      "results": {
                        "status": "error",
                        "code": -1,
                        "description": "PARAMETERS_VALIDATION_FAILED",
                        "message": "Parameters validation failed"
                      },
                      "data": null
                    }
                  },
                  "Error - Card Not Found": {
                    "value": {
                      "results": {
                        "status": "error",
                        "code": -4,
                        "description": "CARD_NOT_FOUND",
                        "message": "Card not found"
                      },
                      "data": null
                    }
                  },
                  "Error - Incomplete Credentials": {
                    "value": {
                      "results": {
                        "status": "error",
                        "code": -1,
                        "description": "PARAMETERS_VALIDATION_FAILED",
                        "message": "Parameters validation failed"
                      },
                      "data": null
                    }
                  },
                  "Error - Voucher Inactive": {
                    "value": {
                      "results": {
                        "status": "error",
                        "code": -3,
                        "description": "VOUCHER_INACTIVE",
                        "message": "Voucher is not active"
                      },
                      "data": null
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "additionalProperties": true,
                  "required": [
                    "results",
                    "data"
                  ],
                  "properties": {
                    "results": {
                      "type": "object",
                      "additionalProperties": true,
                      "required": [
                        "status",
                        "code",
                        "description",
                        "message"
                      ],
                      "properties": {
                        "status": {
                          "type": "string"
                        },
                        "code": {
                          "type": "integer"
                        },
                        "description": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    },
                    "data": {
                      "type": "object",
                      "nullable": true,
                      "additionalProperties": true
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Error response envelope",
            "content": {
              "application/json": {
                "examples": {
                  "Error - Missing Permission": {
                    "value": {
                      "results": {
                        "status": "error",
                        "code": -1,
                        "description": "INVALID_ACCESS_TOKEN",
                        "message": "Invalid access token"
                      },
                      "data": null
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "additionalProperties": true,
                  "required": [
                    "results",
                    "data"
                  ],
                  "properties": {
                    "results": {
                      "type": "object",
                      "additionalProperties": true,
                      "required": [
                        "status",
                        "code",
                        "description",
                        "message"
                      ],
                      "properties": {
                        "status": {
                          "type": "string"
                        },
                        "code": {
                          "type": "integer"
                        },
                        "description": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    },
                    "data": {
                      "type": "object",
                      "nullable": true,
                      "additionalProperties": true
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```