Retrieve Business Account Limits

Retrieve the daily, weekly, and monthly transaction limits for a Business Account and its Parent Business Accounts. The response also includes the actual transaction amounts used for each limit, based on the timestamp used in the request. Limits are returned for each supported currency for the Business Account.

By default, the response includes the transaction limits in effect at the current time. Use the ts query parameter to return the transaction limits in effect on a specific date and time instead.

Endpoint

GET /v1/business-accounts/{businessAccountId}/limits

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

businessAccountId REQUIRED

string (UUID)

Business Account ID.

Query Parameters

string (date-time), required format: ISO 8601 (example: 2018-11-13T20:20:39+00:00)

Timestamp used to retrieve the transaction limits. If not specified, the timestamp for the current date and time is used.

Request Body

None

Returns

Returns an array of Business Account Limits objects. This object is returned for the Business Account and for its Parent Business Accounts. Each object contains the Business Account’s daily, weekly, and monthly transaction limits as well as the actual transaction amount used for each limit.

SAMPLE RESPONSE

				
					[
  {
    "businessAccountId": "93900da4-b882-4299-95e5-8e11a95b1a6e",
    "periods": [
      {
        "type": "daily",
        "from": "2022-06-22T00:00:00+00:00",
        "to": "2022-06-23T00:00:00+00:00",
        "amount": {
          "USD": {
            "limit": "10000.00",
            "used": "150.00"
          },
          "CAD": {
            "limit": "15000.00",
            "used": "350.00"
          }
        }
      },
      {
        "type": "weekly",
        "from": "2022-06-19T00:00:00+00:00",
        "to": "2022-06-26T00:00:00+00:00",
        "amount": {
          "USD": {
            "limit": "50000.00",
            "used": "2150.00"
          },
          "CAD": {
            "limit": "65000.00",
            "used": "550.00"
          }
        }
      },
      {
        "type": "monthly",
        "from": "2022-06-01T00:00:00+00:00",
        "to": "2022-07-01T00:00:00+00:00",
        "amount": {
          "USD": {
            "limit": "200000.00",
            "used": "20150.00"
          },
          "CAD": {
            "limit": "265000.00",
            "used": "17550.00"
          }
        }
      }
    ]
  },
  {
    "parentBusinessAccountId": "0c4a9810-8ad9-4f86-aed1-66ede24288a1",
    "periods": [
      {
        "type": "daily",
        "from": "2022-06-22T00:00:00+00:00",
        "to": "2022-06-23T00:00:00+00:00",
        "amount": {
          "USD": {
            "limit": "5000.00",
            "used": "150.00"
          },
          "CAD": {
            "limit": "5000.00",
            "used": "350.00"
          }
        }
      },
      {
        "type": "weekly",
        "from": "2022-06-19T00:00:00+00:00",
        "to": "2022-06-26T00:00:00+00:00",
        "amount": {
          "USD": {
            "limit": "20000.00",
            "used": "150.00"
          },
          "CAD": {
            "limit": "5000.00",
            "used": "50.00"
          }
        }
      },
      {
        "type": "monthly",
        "from": "2022-06-01T00:00:00+00:00",
        "to": "2022-07-01T00:00:00+00:00",
        "amount": {
          "USD": {
            "limit": "100000.00",
            "used": "10150.00"
          },
          "CAD": {
            "limit": "165000.00",
            "used": "7550.00"
          }
        }
      }
    ]
  }
]