v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Account Endpoints

account/remaining-limit

This endpoint returns the remaining daily, weekly and monthly transaction limits for your VoPay account. If not limits are currently set for your VoPay account, N/A will be returned for each.

get/account/remaining-limit

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Datestring

A future date (in Y-m-d format) to check the remaining limits for. If not specified, the current date will be used.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Datestring nullable required

The date used to calculate the remaining limits

Example response

{
  "Success": true,
  "Date": "2023-12-25",
  "Inbound": {
    "Limits": {
      "Daily": "10000.00",
      "Weekly": "10000.00",
      "Monthly": "10000.00"
    },
    "RemainingLimits": {
      "Daily": "10000.00",
      "Weekly": "10000.00",
      "Monthly": "10000.00"
    }
  },
  "Outbound": {
    "Limits": {
      "Daily": "10000.00",
      "Weekly": "10000.00",
      "Monthly": "10000.00"
    },
    "RemainingLimits": {
      "Daily": "10000.00",
      "Weekly": "10000.00",
      "Monthly": "10000.00"
    }
  }
}