API referencePay Out endpointsVendor

Get vendor stats

Retrieve the basic statistics about a vendor for a given time period, grouped by frequency.

Path parameters

freqstringRequired

Frequency to group series. Allowed values:

  • m - monthly
  • w - weekly
  • d - daily
  • h - hourly

For example, w groups the results by week.

idVendorintegerRequired
Vendor ID.
modestringRequired

Mode for request. Allowed values:

  • ytd - Year To Date
  • mtd - Month To Date
  • wtd - Week To Date
  • today - All current day
  • m12 - Last 12 months
  • d30 - Last 30 days
  • h24 - Last 24 hours
  • lasty - Last Year
  • lastm - Last Month
  • lastw - Last Week
  • yesterday - Last Day

Headers

requestTokenstringRequired

Query parameters

parametersmap from strings to optional stringsOptional
List of parameters

Response

Success
statXstring
Statistical grouping identifier
activeinteger
Number of active transactions
activeVolumedouble
Volume of active transactions
sentToApprovalinteger
Number of transactions sent to approval
sentToApprovalVolumedouble
Volume of transactions sent to approval
toApprovalinteger
Number of transactions to approval
toApprovalVolumedouble
Volume of transactions to approval
approvedinteger
Number of approved transactions
approvedVolumedouble
Volume of approved transactions
disapprovedinteger
Number of disapproved transactions
disapprovedVolumedouble
Volume of disapproved transactions
cancelledinteger
Number of cancelled transactions
cancelledVolumedouble
Volume of cancelled transactions
inTransitinteger
Number of transactions in transit
inTransitVolumedouble
Volume of transactions in transit
paidinteger
Number of paid transactions
paidVolumedouble
Volume of paid transactions

Errors