RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Business Account Limits Object

The Business Account Limits object represents the daily, weekly, and monthly transaction limits for a Business Account and its parent Business Accounts. The object also includes the actual transaction amounts used for each limit, based on the timestamp used in the request.

Attributes

businessAccountId OR parentBusinessAccountId

string (UUID)

ID of the Business Account specified in the request.

OR

ID of the Parent Business Account.

periods

array

List of transaction limits and amounts used by time period (daily, weekly, and monthly).

type

string, values: daily, weekly, monthly

Type of transaction limit.

from

string (date-time)

Inclusive start date for the reporting period (based on the request timestamp).

to

string (date-time)

Exclusive end date for the reporting period (based on the request timestamp).

amount

object

Transaction limit amount by currency.

{currency}

object

Transaction limit for a specific currency. The {currency} object name will be the currency code, such as USD or CAD.

limit

string (number)

Transaction limit for the time period.

used

string (number)

Actual transaction amount used for the time period.

The Business Account Limits Object

				
					[
  {
    "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-19",
        "to": "2022-06-25",
        "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-19",
        "to": "2022-06-25",
        "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"
          }
        }
      }
    ]
  }
]