---
title: "Check Budget"
method: POST
path: "/cards/transactions/check-budget"
tags: ["Transactions"]
---

# Check Budget

`POST /cards/transactions/check-budget`

## Request

- Base URL: `https://api-dev.wittix.com/v1`
- URL: `https://api-dev.wittix.com/v1/cards/transactions/check-budget`
- Auth: API key in header `Authorization`

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.

## Request body

- union
  - object
    - `company_uuid` string, required: Public PayPlus company UUID.
    - `card_uuid` string, required: Card UUID. Use this mode without card credentials.
    - `currency` string: Currency code. Defaults to ILS.
  - object
    - `company_uuid` string, required: Public PayPlus company UUID.
    - `card_number` string, required: Card PAN. Required when card_uuid is not sent.
    - `cvv` string, required: Card CVV. Required when card_uuid is not sent.
    - `expiry_month` integer, required: Card expiry month. Required when card_uuid is not sent.
    - `expiry_year` integer, required: Card expiry year. Required when card_uuid is not sent.
    - `currency` string: Currency code. Defaults to ILS.

## Response `200`

Success response envelope

- object
  - `results` object, required
    - `status` string, required
    - `code` integer, required
  - `data` object, required
    - `currency` string, required
    - `balance` integer, required
    - `finalBalance` integer, required
    - `daily_usage` object, required
      - `count` integer, required
      - `amount` integer, required
    - `monthly_usage` object, required
      - `count` integer, required
      - `amount` integer, required
    - `card` object, required
      - `uuid` string, required
      - `type` string, required
      - `last4` string, required
      - `status` string, required

## Other responses

- `400`: Error response envelope
- `401`: Error response envelope

---

[API](https://skmtc.dev/payplus/apis/wittix-cards.md) - [All operations](https://skmtc.dev/payplus/apis/wittix-cards/llms.txt) - [OpenAPI document](https://skmtc.dev/payplus/apis/wittix-cards/revisions/68e6a77cf776?raw)