---
title: "Retrieve payments for a payout"
method: GET
path: "/v3/payouts/{payoutId}/payments"
tags: ["Payouts"]
---

# Retrieve payments for a payout

`GET /v3/payouts/{payoutId}/payments`

## Request

- Base URL: `https://api.sandbox.velopayments.com`
- URL: `https://api.sandbox.velopayments.com/v3/payouts/{payoutId}/payments`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.sandbox.velopayments.com/v1/login`

Retrieve payments for a payout

## Path parameters

- `payoutId` string, uuid, required

## Query parameters

- `status` 'ACCEPTED' | 'REJECTED' | 'WITHDRAWN' | 'WITHDRAWABLE'
- `remoteId` string
- `payorPaymentId` string
- `sourceAccountName` string
- `transmissionType` string: Valid values for transmissionType can be found attached to the Source Account
- `paymentMemo` string
- `pageSize` integer
- `page` integer

## Response `200`

Payments for payout

- PagedPaymentsResponseV3: List Payees Response Object
  - `page` PagedPayeeInvitationStatusResponseV3Page
    - `numberOfElements` integer
    - `totalElements` integer
    - `totalPages` integer
    - `page` integer
    - `pageSize` integer
  - `links` PagedPayeeResponseV3Links[]
    - `rel` string
    - `href` string
  - `content` PaymentV3[]
    - `paymentId` string, uuid, required: The id of the payment
    - `remoteId` string: The remoteId supplied by the payor that identifies the payee
    - `currency` string: The currency that the payment was made in
    - `amount` integer: The amount of the payment in minor units
    - `sourceAccountName` string: The identifier of the source account to debit the payment from
    - `payorPaymentId` string: A reference identifier for the payor for the given payee payment
    - `paymentMemo` string: <p>Any value here will override the memo value in the parent payout</p> <p>This should be the reference field on the statement seen by the payee (but not via ACH)</p>
    - `payee` PayoutPayeeV3: Payee data associated with a payment. Either individual or company must be populated
      - `payeeId` string, uuid, required
      - `individual` PayoutIndividualV3
        - `name` PayoutNameV3, required
          - `firstName` string, required
          - `lastName` string, required
      - `company` PayoutCompanyV3
        - `companyName` string, required
    - `withdrawable` boolean: Can this paynent be withdrawn
    - `status` string: Current status of payment. One of the following values: SUBMITTED, ACCEPTED, REJECTED, WITHDRAWN, RETURNED, AWAITING_FUNDS, FUNDED, UNFUNDED, CANCELLED, BANK_PAYMENT_REQUESTED
    - `transmissionType` string: <p>The transmission method of the payment.</p> <p>Valid values for transmissionType can be found attached to the Source Account</p>
    - `remoteSystemId` string: <p>The identifier for the remote payments system if not Velo</p>
    - `paymentMetadata` string: <p>Metadata about the payment that may be relevant to the specific rails or remote system making the payout</p> <p>The structure of the data will be dictated by the requirements of the payment rails</p>
    - `autoWithdrawnReasonCode` string: Populated only if the payment was automatically withdrawn during instruction for being invalid
    - `railsId` string: Indicates the 3rd party system involved in making this payment
    - `transactionId` string, uuid: The id of the transaction associated with this payment if there was one

## Other responses

- `404`: The resource was not found or is no longer available

## Changes

- **2026-07-13** `05c3f09fc50a`: 3 breaking, 1 info
  - removed the enum value `ACH` from the `query` request parameter `transmissionType`
  - removed the enum value `SAME_DAY_ACH` from the `query` request parameter `transmissionType`
  - removed the enum value `WIRE` from the `query` request parameter `transmissionType`
  - added the optional property `content/items/transactionId` to the response with the `200` status
- **2022-12-22** `2c03ca69ee09`: 2 info
  - api tag `Payouts` added
  - api tag `Payout Service` removed
- **2022-08-10** `1e7a1734a45c`: 14 info
  - added the optional property `content/items/railsId` to the response with the `200` status
  - removed the `ACCEPTED` enum value from the `content/items/status` response property for the response status `200`
  - removed the `ACH` enum value from the `content/items/transmissionType` response property for the response status `200`
  - removed the `AWAITING_FUNDS` enum value from the `content/items/status` response property for the response status `200`
  - …10 more
- **2021-11-03** `f3f98769e28f`: 1 info
  - added the optional property `content/items/autoWithdrawnReasonCode` to the response with the `200` status
- …earlier changes not shown

[Operation history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v3/payouts/:payoutId/payments/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/05c3f09fc50a?raw)