---
title: "List Refunds for a Payout"
method: GET
path: "/v2.01/{ClientId}/payouts/{PayoutId}/refunds"
tags: ["Refunds"]
---

# List Refunds for a Payout

`GET /v2.01/{ClientId}/payouts/{PayoutId}/refunds`

List Refunds for a Payout

This call returns the refund for a payout, which is known as a **payout return** or return of funds.

A payout return is only generated by Mangopay. For more information, see the [payout returns](/guides/payouts/rejects-returns) guide.

## Path parameters

- `ClientId` string, required
- `PayoutId` string, required

## Query parameters

- `Status` string
- `ResultCode` string
- `BeforeDate` integer
- `AfterDate` integer

## Headers

- `Authorization` string, required

## Response `200`

Success

- ListRefundsForAPayoutResponse
  - `Array (Refunds)` ListRefundsForAPayoutResponseArrayRefundsItems[] — The list of payout refunds created for the platform.
    - `Object (Refund)` PayoutRefundResponse — A payout return — a refund of a payout, initiated automatically by Mangopay when funds cannot be delivered to the recipient bank account.
      - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object.
      - `Tag` string — Max. length: 255 characters Custom data that you can add to this object.
      - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created.
      - `AuthorId` string — The unique identifier of the user at the source of the initial transaction.
      - `CreditedUserId` string — **Default value:** The unique identifier of the owner of the credited wallet. The unique identifier of the user whose wallet is credited.
      - `DebitedFunds` PayoutRefundResponseDebitedFunds — Information about the debited funds.
        - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
        - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
      - `CreditedFunds` PayoutRefundResponseCreditedFunds — Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).
        - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
        - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
      - `Fees` PayoutRefundResponseFees — Information about the fees.
        - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
        - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
      - `Status` string — **Returned values:** `CREATED`, `SUCCEEDED`, `FAILED` The status of the transaction.
      - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.
      - `ResultMessage` string — The explanation of the result code.
      - `ExecutionDate` integer — Unix timestamp (UTC) of the date and time the status changed to `SUCCEEDED`, indicating that the transaction occurred. The statuses `CREATED` and `FAILED` return an `ExecutionDate` of `null`.
      - `Type` string — **Returned values:** `PAYIN` The type of the transaction. Payout returns are recorded as pay-ins crediting the wallet from which the payout was sent.
      - `Nature` string — **Returned values:** `REGULAR`, `REPUDIATION`, `REFUND`, `SETTLEMENT` The nature of the transaction, providing more information about the context in which the transaction occurred: - `REGULAR` – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow. - `REPUDIATION` – Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback). - `REFUND` – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay). - `SETTLEMENT` – Transfer made to the repudiation wallet by the platform to settle a lost dispute.
      - `InitialTransactionId` string — The unique identifier of the initial payout being refunded.
      - `InitialTransactionType` string — **Returned values:** `PAYOUT` The type of the initial transaction being refunded.
      - `InitialTransactionNature` string — **Returned values:** `REGULAR` The nature of the initial transaction being refunded.
      - `DebitedWalletId` string — The unique identifier of the debited wallet. Not returned for payout returns.
      - `CreditedWalletId` string — The unique identifier of the wallet re-credited with the returned funds.
      - `RefundReason` PayoutRefundResponseRefundReason — Information about the reasons for the payout return.
        - `RefundReasonMessage` string — Message explaining the reason for the refusal (for example, a bank return code).
        - `RefundReasonType` string — **Returned values:** `INITIALIZED_BY_CLIENT`, `BANKACCOUNT_INCORRECT`, `OWNER_DO_NOT_MATCH_BANKACCOUNT`, `BANKACCOUNT_HAS_BEEN_CLOSED`, `WITHDRAWAL_IMPOSSIBLE_ON_SAVINGS_ACCOUNTS`, `OTHER` The type of reason for the payout return.
      - `StatementDescriptor` string — Max. length: 10 characters; only alphanumeric and spaces Custom description to appear on the user's bank statement along with the platform name. Different banks may show more or less information. See the <a href="/bank-statements">Customizing bank statement references</a> article for details. **Note:** On refunds, the `StatementDescriptor` is only available for SEPA and BACS [direct debit pay-ins](/api-reference/direct-debit-payins/create-direct-debit-payin) (no other payment methods nor transfers).

---

[API](https://skmtc.net/mangopay/apis/api-reference.md) · [All operations](https://skmtc.net/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mangopay/api-reference/versions/795281070285/schema)