---
title: "Get Payouts for Payor"
method: GET
path: "/v4/paymentaudit/payouts"
tags: ["Payment Audit Service"]
---

# Get Payouts for Payor

`GET /v4/paymentaudit/payouts`

Get List of payouts for payor

## Query parameters

- `payorId` string, uuid
- `payoutMemo` string
- `status` 'ACCEPTED' | 'REJECTED' | 'SUBMITTED' | 'QUOTED' | 'INSTRUCTED' | 'COMPLETED' | 'INCOMPLETE' | 'CONFIRMED' | 'WITHDRAWN'
- `submittedDateFrom` string, date
- `submittedDateTo` string, date
- `fromPayorName` string
- `scheduledForDateFrom` string, date
- `scheduledForDateTo` string, date
- `scheduleStatus` 'ANY' | 'SCHEDULED' | 'EXECUTED' | 'FAILED'
- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

Payor data found

- GetPayoutsResponse — List Payouts Response
  - `page` PagedPayeeInvitationStatusResponseV3Page
    - `numberOfElements` integer
    - `totalElements` integer
    - `totalPages` integer
    - `page` integer
    - `pageSize` integer
  - `links` PagedPayeeResponseV3Links[]
    - `rel` string
    - `href` string
  - `content` PayoutSummaryAudit[]
    - `payoutId` string, uuid
    - `payorId` string, uuid
    - `status` string, required — Current status of the Payout. One of the following values: ACCEPTED, REJECTED, SUBMITTED, QUOTED, INSTRUCTED, COMPLETED, INCOMPLETE, CONFIRMED, WITHDRAWN
    - `dateTime` string, date-time
    - `submittedDateTime` string, required
    - `instructedDateTime` string
    - `withdrawnDateTime` string, date-time
    - `totalPayments` integer
    - `totalIncompletePayments` integer
    - `totalReturnedPayments` integer
    - `totalWithdrawnPayments` integer
    - `sourceAccountSummary` SourceAccountSummary[]
      - `sourceAccountId` string, uuid, required
      - `totalCost` integer, required
      - `currency` string — ISO-4217 3 character currency code
    - `fxSummaries` FxSummary[]
      - `quoteId` string, uuid, required
      - `creationDateTime` string, date-time, required
      - `rate` number, double, required
      - `invertedRate` number, double, required
      - `totalCost` integer, required
      - `totalPaymentAmount` integer, required
      - `sourceCurrency` string — ISO-4217 3 character currency code
      - `paymentCurrency` string — ISO-4217 3 character currency code
      - `status` string, required — Current status of the FX Summary. One of the following values: UNQUOTED, QUOTED, EXPIRED, EXECUTED
      - `fundingStatus` string, required — Current status of the funding. One of the following values: FUNDED, INSTRUCTED, UNFUNDED
    - `payoutMemo` string
    - `payoutType` string, required — The type of payout. One of the following values: STANDARD, AS, ON_BEHALF_OF
    - `payorName` string, required
    - `schedule` PayoutSchedule — Details relating to a payout that was executed via a schedule or is still waiting to be executed
      - `scheduleStatus` string, required — Current status of the payout schedule. One of the following values: SCHEDULED, EXECUTED, FAILED
      - `scheduledAt` string, date-time, required
      - `scheduledFor` string, date-time, required
      - `scheduledByPrincipalId` string, required — ID of the user or application that scheduled the payout
      - `notificationsEnabled` boolean, required
      - `scheduledBy` string — Optional display name as a hint for who scheduled the payout. Not populated if payout was scheduled by an application.

## Other responses

- `400` — Invalid request. See Error message payload for details of failure
- `401` — Invalid access token. May be expired or invalid
- `403` — The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions
- `404` — The resource was not found or is no longer available

## Changes

- **2022-06-27** `1e7a1734a45c` — 31 info
  - removed the `ACCEPTED` enum value from the `content/items/status` response property for the response status `200`
  - removed the `AS` enum value from the `content/items/payoutType` response property for the response status `200`
  - removed the `COMPLETED` enum value from the `content/items/status` response property for the response status `200`
  - removed the `CONFIRMED` enum value from the `content/items/status` response property for the response status `200`
  - …27 more
- **2021-11-03** `f3f98769e28f` — 4 info
  - added the new optional `query` request parameter `scheduleStatus`
  - added the new optional `query` request parameter `scheduledForDateFrom`
  - added the new optional `query` request parameter `scheduledForDateTo`
  - added the optional property `content/items/schedule` to the response with the `200` status
- **2020-09-25** `dd71433847a6` — 4 breaking, 24 info
  - the `errors/items/` response's property type changed from no type to `object` for status `400`
  - the `errors/items/` response's property type changed from no type to `object` for status `401`
  - the `errors/items/` response's property type changed from no type to `object` for status `403`
  - the `errors/items/` response's property type changed from no type to `object` for status `404`
  - …24 more
- …earlier changes not shown

[Full history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v4/paymentaudit/payouts/get.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/velopaymentsapi/velo-payments-apis/revisions/05c3f09fc50a/schema)