---
title: "Get Payout Summary"
method: GET
path: "/v3/payouts/{payoutId}"
tags: ["Payout Service"]
---

# Get Payout Summary

`GET /v3/payouts/{payoutId}`

Get payout summary - returns the current state of the payout.

## Path parameters

- `payoutId` string, uuid, required

## Response `200`

Details of Payout

- PayoutSummaryResponseV3
  - `payoutId` string, uuid
  - `status` string
  - `paymentsSubmitted` integer
  - `paymentsAccepted` integer
  - `paymentsRejected` integer
  - `paymentsWithdrawn` integer, required
  - `fxSummaries` QuoteFxSummaryV3[], required
    - `rate` number, float, required
    - `invertedRate` number, float
    - `creationTime` string, date-time, required
    - `expiryTime` string, date-time
    - `quoteId` string, uuid, required
    - `totalSourceAmount` integer, required
    - `totalPaymentAmount` integer, required
    - `sourceCurrency` string, required — Valid ISO 4217 3 letter currency code. See the <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.
    - `paymentCurrency` string, required — Valid ISO 4217 3 letter currency code. See the <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.
    - `fundingStatus` string, required — Current status of the funding associated with this quote. One of the following values: UNFUNDED, INSTRUCTED, FUNDED
    - `status` string, required — Current status of the fx quote. One of the following values: UNQUOTED, QUOTED, EXPIRED, EXECUTED, REJECTED
  - `accounts` SourceAccountV3[], required
    - `sourceAccountName` string, required
    - `sourceAccountId` string, uuid, required
    - `currency` string, required — Valid ISO 4217 3 letter currency code. See the <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.
    - `totalPayoutCost` integer, required
  - `acceptedPayments` AcceptedPaymentV3[], required
    - `remoteId` string, required
    - `currencyType` string, required — Valid ISO 4217 3 letter currency code. See the <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.
    - `amount` integer, required
    - `sourceAccountName` string, required
    - `payorPaymentId` string, required
    - `paymentMemo` string
    - `remoteSystemId` string
    - `paymentMetadata` string
    - `railsId` string, required
  - `rejectedPayments` RejectedPaymentV3[], required
    - `remoteId` string, required
    - `currencyType` string, required — Valid ISO 4217 3 letter currency code. See the <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.
    - `amount` integer, required
    - `sourceAccountName` string, required
    - `payorPaymentId` string, required
    - `remoteSystemId` string
    - `paymentMetadata` string
    - `reason` string, required
    - `reasonCode` string
    - `lineNumber` integer
    - `message` string
  - `schedule` PayoutScheduleV3 — Details relating to a payout that was executed via a schedule or is still waiting to be executed
    - `scheduleStatus` string, required — The 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

## Other responses

- `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` — 12 info
  - removed the `EXECUTED` enum value from the `fxSummaries/items/status` response property for the response status `200`
  - removed the `EXECUTED` enum value from the `schedule/scheduleStatus` response property for the response status `200`
  - removed the `EXPIRED` enum value from the `fxSummaries/items/status` response property for the response status `200`
  - removed the `FAILED` enum value from the `schedule/scheduleStatus` response property for the response status `200`
  - …8 more
- **2021-11-03** `f3f98769e28f` — 1 info
  - added the optional property `schedule` to the response with the `200` status
- **2021-01-14** `5e4369698639` — 4 info
  - added the optional property `acceptedPayments/items/paymentMetadata` to the response with the `200` status
  - added the optional property `acceptedPayments/items/remoteSystemId` to the response with the `200` status
  - added the optional property `rejectedPayments/items/paymentMetadata` to the response with the `200` status
  - added the optional property `rejectedPayments/items/remoteSystemId` to the response with the `200` status
- …earlier changes not shown

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