VEvelopaymentsapi
Payment Audit Service

Get Payout Statistics

Changed on

Get payout statistics for a payor.

get/v4/paymentaudit/payoutStatistics

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

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

  • 5e4369698639Revision changes
    • info

      endpoint reactivated

  • dd71433847a6Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated