Payment Audit Service

Get Payout Statistics

Get payout statistics for a payor.

get/v4/paymentaudit/payoutStatistics

Query parameters

payorIdstring uuid

The account owner Payor ID. Required for external users.

Response

Payout Statistics response

thisMonthPayoutsCountinteger required

thisMonthFailedPaymentsCountinteger required

Example response

{
  "thisMonthFailedPaymentsCount": 6,
  "thisMonthPayoutsCount": 0
}

Changes

Changed in 4 of the 50 revisions of this API.526

Jan 14, 20215e43696986391See the full diff
- ○
  endpoint reactivated
  endpoint-reactivated
This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 25, 2020dd71433847a6424See the full diff
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 400
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 401
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 403
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 404
  response-property-type-changed
- ○
  added the optional property errors/items/errorCode to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 404 status
  response-optional-property-added
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 24, 2020aded220b0d7b1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 15, 2019ced8e167a97c1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history