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

# 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

- PayoutSummaryResponse
  - `payoutId` string, uuid
  - `status` string
  - `paymentsSubmitted` integer
  - `paymentsAccepted` integer
  - `paymentsRejected` integer
  - `fxSummaries` QuoteFxSummary[], 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` 'UNFUNDED' | 'INSTRUCTED' | 'FUNDED', required
    - `status` 'UNQUOTED' | 'QUOTED' | 'EXPIRED' | 'EXECUTED' | 'REJECTED', required
  - `accounts` SourceAccount[], 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` AcceptedPayment[], 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
  - `rejectedPayments` RejectedPayment[], 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
    - `reason` string, required
    - `reasonCode` string
    - `lineNumber` integer
    - `message` string

## 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` — Resource not found

## Changes

- **2020-01-28** `1b2abf26b5d6` — 9 info
  - api operation id `getPayoutSummaryV3` removed and replaced with ``
  - added the media type `application/json` for the response with the status `404`
  - added the non-success response with the status `401`
  - added the non-success response with the status `403`
  - …5 more
- **2019-12-11** `a0b19fa311c0` — 1 info
  - added the required property `acceptedPayments` to the response with the `200` status
- **2019-11-27** `4052795ca58f` — 1 info
  - api operation id `getPayoutSummaryV3` was added
- **2019-10-17** `f27462c28e5f` — 8 warning, 2 info
  - added the new `EXECUTED` enum value to the `fxSummaries/items/status` response property for the response status `200`
  - added the new `EXPIRED` enum value to the `fxSummaries/items/status` response property for the response status `200`
  - added the new `FUNDED` enum value to the `fxSummaries/items/fundingStatus` response property for the response status `200`
  - added the new `INSTRUCTED` enum value to the `fxSummaries/items/fundingStatus` response property for the response status `200`
  - …6 more
- …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/1b2abf26b5d6?raw)