View a Payout and check mode applied

// GET has no body parameters

{
    "Id": "po_m_01HQMZSGSQPPXC51TZHDAYFAJF",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1709027672,
    "AuthorId": "user_m_01JH2Z9GXCCHGFN65T5HDZG4GB",
    "CreditedUserId": null,
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5792
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 5213
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 579
    },
    "Status": "SUCCEEDED",
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1709027738,
    "Type": "PAYOUT",
    "Nature": "REGULAR",
    "CreditedWalletId": null,
    "DebitedWalletId": "wlt_m_01JMAAKGM0VCBCQ5V4DB3EZPER",
    "PaymentType": "BANK_WIRE",
    "BankAccountId": null,
    "BankWireRef": "Example123",
    "ModeRequested": null,
    "ModeApplied": "STANDARD",
    "FallbackReason": null,
    "EndToEndId": "2c2184396eef4e5da90ab48a2feeb51d",
    "PaymentRef": null,
    "RecipientId": "rec_01KF0MPAA8X9C80Q394TSF7MEY"
}  

GET

v2.01

{ClientId}

payouts

bankwire

{PayOutId}

// GET has no body parameters

{
    "Id": "po_m_01HQMZSGSQPPXC51TZHDAYFAJF",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1709027672,
    "AuthorId": "user_m_01JH2Z9GXCCHGFN65T5HDZG4GB",
    "CreditedUserId": null,
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5792
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 5213
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 579
    },
    "Status": "SUCCEEDED",
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1709027738,
    "Type": "PAYOUT",
    "Nature": "REGULAR",
    "CreditedWalletId": null,
    "DebitedWalletId": "wlt_m_01JMAAKGM0VCBCQ5V4DB3EZPER",
    "PaymentType": "BANK_WIRE",
    "BankAccountId": null,
    "BankWireRef": "Example123",
    "ModeRequested": null,
    "ModeApplied": "STANDARD",
    "FallbackReason": null,
    "EndToEndId": "2c2184396eef4e5da90ab48a2feeb51d",
    "PaymentRef": null,
    "RecipientId": "rec_01KF0MPAA8X9C80Q394TSF7MEY"
}  

This endpoint returns 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 endpoint, this endpoint also returns information about:

ModeApplied – Relevant for platforms using SEPA Inst or RTGS for SEPA T2
ModeRequested and FallbackReason – Additionally relevant for platforms using SEPA Inst
ChargeBearer – Relevant for platforms using OUR fee allocation on SWIFT non-domestic payouts

Note – Payout data retained for 13 monthsAn 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.

Path parameters

PayoutId

string

required

The unique identifier of the payout.

Responses

200

string

Max length: 128 characters (see data formats for details)The unique identifier of the object.

Tag

string

Max. length: 255 charactersCustom data that you can add to this object.

CreationDate

Unix timestamp

The date and time at which 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 Bank Account UserId value as well. Otherwise, Mangopay’s Compliance team will reject the payout.

CreditedUserId

string

The unique identifier of the user whose wallet is credited.
In the specific case of the Payout object, this value is always null since there is no credited wallet.

DebitedFunds

object

Information about the debited funds.

Show properties

Currency

string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the debited funds.

Amount

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

CreditedFunds

object

Information about the funds being credited to the target of the transaction (CreditedFunds = DebitedFunds - Fees).

Show properties

Currency

string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the debited funds.

Amount

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Fees

object

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

Show properties

Currency

string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).The currency of the debited funds.

Amount

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Status

string

Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.

ResultCode

string

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

ResultMessage

string

The explanation of the result code.

ExecutionDate

Unix timestamp

The date and time at which 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, PAYOUTThe type of the transaction.

Nature

string

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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

string

The unique identifier of the credited wallet.
In the specific case of the Payout object, this value is always null since there is no credited wallet.

DebitedWalletId

string

The unique identifier of the debited wallet.

PaymentType

string

Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.

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

ModeRequested

string

Returned values: STANDARD, INSTANT_PAYMENT, INSTANT_PAYMENT_ONLY, RTGS_PAYMENTThe value set for the PayoutModeRequested parameter when making the request.

ModeApplied

string

Returned values: STANDARD, INSTANT_PAYMENT, RTGS_PAYMENT, PENDING_RESPONSEThe 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.

FallbackReason

object

Information regarding the reason for the refusal of the instant payout request.

Show properties

ResultCode

string

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

ResultMessage

string

The explanation of the result code.

EndToEndId

string

The unique identifier of a bank wire for tracking purposes only.

PaymentRef

object

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.

Show properties

ReasonType

string

Allowed values: PAYIN_REFUNDThe 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-inThe 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 object to which the payout is being requested. This property should be used by platforms integrating for the first time (and not the BankAccountId).

ChargeBearer

string | null

Possible values: SHA, OURDefault value: SHAThe 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.

{
    "Id": "po_m_01HQMZSGSQPPXC51TZHDAYFAJF",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1709027672,
    "AuthorId": "user_m_01JH2Z9GXCCHGFN65T5HDZG4GB",
    "CreditedUserId": null,
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5792
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 5213
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 579
    },
    "Status": "SUCCEEDED",
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1709027738,
    "Type": "PAYOUT",
    "Nature": "REGULAR",
    "CreditedWalletId": null,
    "DebitedWalletId": "wlt_m_01JMAAKGM0VCBCQ5V4DB3EZPER",
    "PaymentType": "BANK_WIRE",
    "BankAccountId": null,
    "BankWireRef": "Example123",
    "ModeRequested": null,
    "ModeApplied": "STANDARD",
    "FallbackReason": null,
    "EndToEndId": "2c2184396eef4e5da90ab48a2feeb51d",
    "PaymentRef": null,
    "RecipientId": "rec_01KF0MPAA8X9C80Q394TSF7MEY"
}  

// GET has no body parameters

View a Payout The Conversion Rate object (FX)

⌘I

Documentation Index

​Path parameters

​Responses

Path parameters

Responses