---
title: "Changes to Get Payout Summary"
method: GET
path: "/v3/payouts/{payoutId}"
---

# Changes to Get Payout Summary

`GET /v3/payouts/{payoutId}`

> Every recorded change to this operation, newest first.

## Timeline

Changed in 15 of 70 revisions.

- **2022-12-22** `2c03ca69ee09`: 2 info
- **2022-08-10** `1e7a1734a45c`: 12 info
- **2021-11-03** `f3f98769e28f`: 1 info
- **2021-02-03** `5e4369698639`: 4 info
- **2020-10-30** `dd71433847a6`: 3 breaking, 18 info
- **2020-06-24** `aded220b0d7b`: 2 breaking, 3 info
- **2020-03-19** `10644a139f81`: 1 info
- **2020-01-28** `1b2abf26b5d6`: 9 info
- **2019-12-11** `a0b19fa311c0`: 1 info
- **2019-11-27** `4052795ca58f`: 1 info
- **2019-10-17** `f27462c28e5f`: 8 warning, 2 info
- **2019-07-29** `0ef0b7abcc81`: 15 info
- **2019-07-16** `02b01d19d9e3`: 2 breaking
- **2019-04-03** `01d6075fd71c`: 2 info
- **2019-03-29** `0c34292d9984`: 6 breaking, 11 info

## Changes

- **2022-12-22** `2c03ca69ee09`: 2 info
  - api tag `Payouts` added
  - api tag `Payout Service` removed
- **2022-08-10** `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`
  - removed the `FUNDED` enum value from the `fxSummaries/items/fundingStatus` response property for the response status `200`
  - removed the `INSTRUCTED` enum value from the `fxSummaries/items/fundingStatus` response property for the response status `200`
  - removed the `QUOTED` enum value from the `fxSummaries/items/status` response property for the response status `200`
  - removed the `REJECTED` enum value from the `fxSummaries/items/status` response property for the response status `200`
  - removed the `SCHEDULED` enum value from the `schedule/scheduleStatus` response property for the response status `200`
  - removed the `UNFUNDED` enum value from the `fxSummaries/items/fundingStatus` response property for the response status `200`
  - removed the `UNQUOTED` enum value from the `fxSummaries/items/status` response property for the response status `200`
  - added the required property `acceptedPayments/items/railsId` to the response with the `200` status
- **2021-11-03** `f3f98769e28f`: 1 info
  - added the optional property `schedule` to the response with the `200` status
- **2021-02-03** `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
- **2020-10-30** `dd71433847a6`: 3 breaking, 18 info
  - 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`
  - added the optional property `errors/items/errorCode` to the response with the `401` status
  - added the optional property `errors/items/errorCode` to the response with the `403` status
  - added the optional property `errors/items/errorCode` to the response with the `404` status
  - added the optional property `errors/items/errorData` to the response with the `401` status
  - added the optional property `errors/items/errorData` to the response with the `403` status
  - added the optional property `errors/items/errorData` to the response with the `404` status
  - added the optional property `errors/items/localisationDetails` to the response with the `401` status
  - added the optional property `errors/items/localisationDetails` to the response with the `403` status
  - added the optional property `errors/items/localisationDetails` to the response with the `404` status
  - added the optional property `httpStatusCode` to the response with the `401` status
  - added the optional property `httpStatusCode` to the response with the `403` status
  - added the optional property `httpStatusCode` to the response with the `404` status
  - response property `errors/items/locationType` deprecated
  - response property `errors/items/locationType` deprecated
  - response property `errors/items/locationType` deprecated
  - response property `errors/items/reasonCode` deprecated
  - response property `errors/items/reasonCode` deprecated
  - response property `errors/items/reasonCode` deprecated
- **2020-06-24** `aded220b0d7b`: 2 breaking, 3 info
  - the response's body type changed from `object` to no type for status `404`
  - the `errors/items/` response's property type changed from `object` to no type for status `404`
  - api operation id `getPayoutSummaryV3` was added
  - api tag `Payout Service` added
  - api tag `Get Payout` removed
- **2020-03-19** `10644a139f81`: 1 info
  - added the required property `paymentsWithdrawn` to the response with the `200` status
- **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`
  - the `acceptedPayments/items/currencyType` response's property pattern `^[A-Z]{3}$` was added for the status `200`
  - the `accounts/items/currency` response's property pattern `^[A-Z]{3}$` was added for the status `200`
  - the `fxSummaries/items/paymentCurrency` response's property pattern `^[A-Z]{3}$` was added for the status `200`
  - the `fxSummaries/items/sourceCurrency` response's property pattern `^[A-Z]{3}$` was added for the status `200`
  - the `rejectedPayments/items/currencyType` response's property pattern `^[A-Z]{3}$` was added for the status `200`
- **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`
  - added the new `QUOTED` enum value to the `fxSummaries/items/status` response property for the response status `200`
  - added the new `REJECTED` enum value to the `fxSummaries/items/status` response property for the response status `200`
  - added the new `UNFUNDED` enum value to the `fxSummaries/items/fundingStatus` response property for the response status `200`
  - added the new `UNQUOTED` enum value to the `fxSummaries/items/status` response property for the response status `200`
  - the response property `fxSummaries/items/fundingStatus` became required for the status `200`
  - the response property `fxSummaries/items/status` became required for the status `200`
- **2019-07-29** `0ef0b7abcc81`: 15 info
  - added the optional property `rejectedPayments/items/reasonCode` to the response with the `200` status
  - removed the `BADLY_FORMED_DATA_ROW` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `COMPLIANCE_ISSUE` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `CURRENCY_MISMATCH` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `DECLINED_INVITE` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `DUPLICATE_PAYOR_PAYMENT_ID` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `OTHER` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `PAYEE_NOT_ONBOARDED` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `PAYMENT_VALUE_TOO_HIGH` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `PENDING_INVITE` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `UNKNOWN_REMOTE_ID` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `UNKNOWN_SOURCE_ACCOUNT` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `UNSUPPORTED_COUNTRY` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `UNSUPPORTED_CURRENCY` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
  - removed the `UNSUPPORTED_CURRENCY_FOR_COUNTRY` enum value from the `rejectedPayments/items/reason` response property for the response status `200`
- **2019-07-16** `02b01d19d9e3`: 2 breaking
  - the `fxSummaries/items/invertedRate` response's property format changed from `decimal` to `float` for status `200`
  - the `fxSummaries/items/rate` response's property format changed from `decimal` to `float` for status `200`
- **2019-04-03** `01d6075fd71c`: 2 info
  - api tag `Get Payout` added
  - api tag `Payout Service` removed
- **2019-03-29** `0c34292d9984`: 6 breaking, 11 info
  - the response property `fxSummaries/items/fundingStatus` became optional for the status `200`
  - the response property `fxSummaries/items/status` became optional for the status `200`
  - the response property `rejectedPayments/items/lineNumber` became optional for the status `200`
  - the response property `rejectedPayments/items/message` became optional for the status `200`
  - removed the required property `fxSummaries/items/creationDateTime` from the response with the `200` status
  - removed the required property `fxSummaries/items/totalCost` from the response with the `200` status
  - added the non-success response with the status `404`
  - added the optional property `fxSummaries/items/expiryTime` to the response with the `200` status
  - added the optional property `fxSummaries/items/invertedRate` to the response with the `200` status
  - removed the `EXECUTED` enum value from the `fxSummaries/items/status` 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 `FUNDED` enum value from the `fxSummaries/items/fundingStatus` response property for the response status `200`
  - removed the `INSTRUCTED` enum value from the `fxSummaries/items/fundingStatus` response property for the response status `200`
  - removed the `QUOTED` enum value from the `fxSummaries/items/status` response property for the response status `200`
  - removed the `UNFUNDED` enum value from the `fxSummaries/items/fundingStatus` response property for the response status `200`
  - added the required property `fxSummaries/items/creationTime` to the response with the `200` status
  - added the required property `fxSummaries/items/totalSourceAmount` to the response with the `200` status

---

[Operation](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/docs/v3/payouts/:payoutId/get.md) - [API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) - [Page](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v3/payouts/:payoutId/get)
