---
title: "View a Payout"
method: GET
path: "/v2.01/{ClientId}/payouts/{PayoutId}"
tags: ["Payouts"]
---

# View a Payout

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

This endpoint returns basic information about a payout request, without some feature-specific details. Platforms integrating for the first time should use the [GET View a Payout and check mode applied](/api-reference/payouts/view-payout-check-mode-applied) endpoint.

<Note icon="fa-regular fa-circle-info">
**Note – Payout data retained for 13 months**

An API call to retrieve a payout whose `CreationDate` is older than 13 months may return 404 Not Found.

For more information, see the <a href="/api-reference/overview/data-availability-periods">Data availability periods</a> article.
</Note>

## Path parameters

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

## Headers

- `Authorization` string, required

## Response `200`

Success

- PayoutWithoutModeAppliedResponse
  - `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 transaction. **Best practice:** When the payout author is different from the bank account owner, the Payout `AuthorId` value must be different from the Recipient `UserId` value as well. Otherwise, Mangopay's Compliance team will reject the payout.
  - `CreditedUserId` unknown
  - `DebitedFunds` PayoutWithoutModeAppliedResponseDebitedFunds — 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` PayoutWithoutModeAppliedResponseCreditedFunds — 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` PayoutWithoutModeAppliedResponseFees — 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`, `TRANSFER`, `CONVERSION`, `PAYOUT` The type of the transaction.
  - `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.
  - `CreditedWalletId` unknown
  - `DebitedWalletId` string — The unique identifier of the debited wallet.
  - `PaymentType` string — **Returned values:** `BANK_WIRE` The payment type of the payout.
  - `BankAccountId` string — The unique identifier of the bank account.
  - `BankWireRef` string — Max. length: 255 characters (< 12 recommended) Custom description to appear on the user's bank statement along with the platform name. The recommended length is 12 characters – strings longer than this may be truncated depending on the bank. For the full structure of the string, see the <a href="/bank-statements">Customizing bank statement references</a> article.
  - `PaymentRef` PayoutWithoutModeAppliedResponsePaymentRef — Information about the payment reference provided for the payout. This object is returned `null` if not provided. This object must be used to provide the reference of a [bank wire pay-in](/api-reference/bank-wire-payins/bank-wire-payin-object) or a [pay-in to virtual IBAN](/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object), if the payout is being used to refund it.
    - `ReasonType` string — **Allowed values:** `PAYIN_REFUND` The reason for the reference being provided: - `PAYIN_REFUND` – The payout serves to reimburse a pay-in.
    - `ReferenceId` string — **Allowed values:** The valid `Id` of a successful pay-in. The unique identifier associated with the reference, whose value corresponds to the `ReasonType`: - `PAYIN_REFUND` – The `ReferenceId` value provided is the same as the `Id` of the initial pay-in being refunded.
  - `RecipientId` string — The unique identifier of the [Recipient](/api-reference/recipients/recipient-object) object to which the payout is being requested. This property should be used by platforms integrating for the first time (and not the `BankAccountId`).

---

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