PayoutsPayouts

View a Payout and check mode applied

Retrieve the full details of a payout request. First-time integrators should used this endpoint. In addition to the data returned by the legacy [GET View a Payout](/api-reference/payouts/view-payout) endpoint, this endpoint also returns information about: - `ModeApplied` – Relevant for platforms using [SEPA Inst](/guides/payouts/integration#initiate-an-sct-inst-payout) or [RTGS for SEPA T2](/guides/payouts#real-time-gross-settlement-rtgs) - `ModeRequested` and `FallbackReason` – Additionally relevant for platforms using [SEPA Inst](/guides/payouts/integration#initiate-an-sct-inst-payout) - `ChargeBearer` – Relevant for platforms using [OUR fee allocation](/guides/payouts#fees-for-international-payouts) on SWIFT non-domestic payouts <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](/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.

ModeRequestedstring

Returned values: STANDARD, INSTANT_PAYMENT, INSTANT_PAYMENT_ONLY, RTGS_PAYMENT

The value set for the PayoutModeRequested parameter when making the request.

ModeAppliedstring

Returned values: STANDARD, INSTANT_PAYMENT, RTGS_PAYMENT, PENDING_RESPONSE

The mode defining how the payout request is sent:

  • STANDARD – Non-EUR: Sent via the relevant local rail if the Recipient’s destination country corresponds, or otherwise sent via SWIFT. Mangopay automatically routes funds via the available rails, which also determines delivery times. Requests received after the applicable cutoff are processed the next working day. EUR: Sent via the SEPA Credit Transfer scheme or SWIFT (if non-domestic).
  • INSTANT_PAYMENT – EUR only: Sent via the SEPA Instant Credit Transfer scheme (funds processed within 10 seconds).
  • RTGS_PAYMENT – EUR only: Sent via the Eurozone’s real-time gross settlement (RGTS) scheme T2 (funds processed same working day) without a fallback. If the request is received after the applicable cutoff (16:15 CET), it is processed the next working day (from 07:00 CET).
  • PENDING_RESPONSE – Temporary state to accommodate the possible latency between the creation of the request and the mode being applied in the case of instant payment and RGTS modes.
FallbackReasonobject or null
Information regarding the reason for the refusal of the instant payout request.
EndToEndIdstring
The unique identifier of a bank wire for tracking purposes only.
PaymentRefobject or null

Information about the payment reference provided for the payout.

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

ChargeBearerstring

Possible values: SHA, OUR

Default value: SHA

The allocation of processing fees for an international SWIFT payout:

  • SHA - SWIFT fees are shared between the remitter and beneficiary. The beneficiary’s share is deducted from the payout, meaning that the amount arriving on the recipient’s bank account may be less than the Payout’s CreditedFunds.Amount.
  • OUR - All SWIFT fees are paid by the remitter. The recipient receives the full CreditedFunds.Amount of the Payout, and Mangopay recovers the fees from the platform during the billing cycle. A 400 HTTP error is returned if Mangopay’s network of partners does not support OUR fees for the given currency and recipient country, or if this feature is not activated.

For non-SWIFT requests, the ChargeBearer is ignored and SHA or null is displayed by default in the response.