View a Payout

GET

/v2.01/:ClientId/payouts/:PayoutId

GET

/v2.01/:ClientId/payouts/:PayoutId

$ curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/payouts/{PayoutId} \
>      -H "Authorization: Bearer <token>"

1 {
2   "Id": "po_m_01HQMZSGSQPPXC51TZHDAYFAJF",
3   "Tag": "Created using Mangopay API Postman Collection",
4   "CreationDate": 1709027672,
5   "AuthorId": "user_m_01JH2Z9GXCCHGFN65T5HDZG4GB",
6   "CreditedUserId": null,
7   "DebitedFunds": {
8     "Currency": "EUR",
9     "Amount": 5792
10   },
11   "CreditedFunds": {
12     "Currency": "EUR",
13     "Amount": 5213
14   },
15   "Fees": {
16     "Currency": "EUR",
17     "Amount": 579
18   },
19   "Status": "SUCCEEDED",
20   "ResultCode": "000000",
21   "ResultMessage": "Success",
22   "ExecutionDate": 1709027738,
23   "Type": "PAYOUT",
24   "Nature": "REGULAR",
25   "CreditedWalletId": null,
26   "DebitedWalletId": "204069727",
27   "PaymentType": "BANK_WIRE",
28   "BankAccountId": null,
29   "BankWireRef": "Example123",
30   "PaymentRef": null,
31   "RecipientId": "rec_01KF0MPAA8X9C80Q394TSF7MEY"
32 }

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 endpoint.

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 Data availability periods article.

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>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

PayoutIdstringRequired

The unique identifier of the payout.

Response

Success

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

AuthorIdstring

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.

CreditedUserIdany

For a payout, the CreditedUserId is always null as the funds are being paid out of the Mangoapy environment.

DebitedFundsobject

Information about the debited funds.

CreditedFundsobject

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Feesobject

Information about the fees.

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCodestring

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessagestring

The explanation of the result code.

ExecutionDateinteger

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.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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.

CreditedWalletIdany

For a payout, the CreditedWalletId is always null as the funds are being paid out of the Mangoapy environment.

DebitedWalletIdstring

The unique identifier of the debited wallet.

PaymentTypestring

Returned values: BANK_WIRE

The payment type of the payout.

BankAccountIdstring

The unique identifier of the bank account.

BankWireRefstring

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 Customizing bank statement references article.

PaymentRefobject or null

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 or a pay-in to virtual IBAN, if the payout is being used to refund it.

RecipientIdstring

The unique identifier of the Recipient object to which the payout is being requested. This property should be used by platforms integrating for the first time (and not the BankAccountId).