---
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
- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

Payor data found

- GetPayoutsResponseV4 — List Payouts Response
  - `page` PagedPayeeInvitationStatusResponsePage
    - `numberOfElements` integer
    - `totalElements` integer
    - `totalPages` integer
    - `page` integer
    - `pageSize` integer
  - `links` PagedPayeeResponseLinks[]
    - `rel` string
    - `href` string
  - `content` PayoutSummaryAuditV4[]
    - `payoutId` string, uuid
    - `payorId` string, uuid
    - `status` 'ACCEPTED' | 'REJECTED' | 'SUBMITTED' | 'QUOTED' | 'INSTRUCTED' | 'COMPLETED' | 'INCOMPLETE' | 'CONFIRMED' | 'WITHDRAWN', required
    - `dateTime` string, date-time
    - `submittedDateTime` string, required
    - `instructedDateTime` string
    - `withdrawnDateTime` string, date-time
    - `totalPayments` integer
    - `totalIncompletePayments` integer
    - `totalReturnedPayments` integer
    - `sourceAccountSummary` SourceAccountSummaryV4[]
      - `sourceAccountId` string, uuid, required
      - `totalCost` integer, required
      - `currency` 'USD' | 'GBP' | 'EUR' — ISO 3 character currency code
    - `fxSummaries` FxSummaryV4[]
      - `quoteId` string, uuid, required
      - `creationDateTime` string, date-time, required
      - `rate` number, double, required
      - `invertedRate` number, double, required
      - `totalCost` integer, required
      - `totalPaymentAmount` integer, required
      - `sourceCurrency` 'USD' | 'GBP' | 'EUR' — ISO 3 character currency code
      - `paymentCurrency` 'USD' | 'GBP' | 'EUR' — ISO 3 character currency code
      - `status` 'UNQUOTED' | 'QUOTED' | 'EXPIRED' | 'EXECUTED', required
      - `fundingStatus` 'FUNDED' | 'INSTRUCTED' | 'UNFUNDED', required
    - `payoutMemo` string
    - `payoutType` 'STANDARD' | 'AS' | 'ON_BEHALF_OF', required — The type of payout.
    - `payorName` string, required

## Other responses

- `400` — Invalid Request Parameter
- `401` — Not Authorized
- `403` — Forbidden
- `404` — Payor Id Not Found

## Changes

- **2019-12-11** `a0b19fa311c0` — 1 breaking, 4 info
  - the response property `content/items/payoutId` became optional for the status `200`
  - added the new optional `query` request parameter `fromPayorName`
  - the `query` request parameter `payorId` became optional
  - response property `content/items/payorId` reactivated
  - …1 more
- **2019-12-06** `fbe041e3d325` — 1 warning, 2 info
  - removed the optional property `summary` from the response with the `200` status
  - added the non-success response with the status `401`
  - added the non-success response with the status `403`
- **2019-10-17** `f27462c28e5f` — 2 info
  - response property `content/items/payorId` deprecated
  - added the required property `content/items/payoutType` to the response with the `200` status
- **2019-07-25** `6febece3adc1` — 1 info
  - added the optional property `content/items/withdrawnDateTime` to the response with the `200` status
- **2019-07-15** `ced8e167a97c` — 6 breaking, 32 warning, 4 info
  - the `query` request parameter `payorId` became required
  - removed the media type `application/json` for the response with the status `400`
  - removed the media type `application/json` for the response with the status `404`
  - the `content/items/sourceAccountSummary/items/totalCost` response's property type changed from `integer` to `number`, and format from `int64` to `int32` for status `200`
  - …38 more

[Change 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.dev/velopaymentsapi/apis/velo-payments-apis/revisions/1b2abf26b5d6?raw)