v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Partner Endpoints

partner/invoice-details

This endpoint is used to retrieve the invoice-details (number of transactions, rates, etc) for a given billing cycle. If no month/year is provided, the current month/year is used.

get/partner/invoice-details

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

VopayAccountIDstring

Only returns billing info for this VoPay account

monthstring

Billing cycle month (eg: 03). Defaults to current month

yearstring

Billing cycle year (eg: 2021). Defaults to current year

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

Example response

{
  "Success": true,
  "InvoicePeriod": {
    "FromDate": "2021-10-01",
    "ToDate": "2021-10-31"
  },
  "InvoiceDetails": {
    "AccountID": {
      "Currency": {
        "Service": {
          "description": "EFT Funding Transaction fee"
        }
      }
    }
  }
}