List Refunds for a Payout

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

REST

// GET has no body parameters

200

[
    {
        "Id": "refund_m_01JJ22Z1JGMFEHB5P4B5DZ8CCQ",
        "Tag": null,
        "CreationDate": 1734628083,
        "AuthorId": "user_m_01JJ22ZEP6JQQ5KMBPHBGYFQBG",
        "CreditedUserId": null,
        "DebitedFunds": {
            "Currency": "EUR",
            "Amount": 12000
        },
        "CreditedFunds": {
            "Currency": "EUR",
            "Amount": 12000
        },
        "Fees": {
            "Currency": "EUR",
            "Amount": 0
        },
        "Status": "SUCCEEDED",
        "ResultCode": "000000",
        "ResultMessage": "Success",
        "ExecutionDate": 1734628084,
        "Type": "PAYIN",
        "Nature": "REFUND",
        "InitialTransactionId": "po_m_01JJ2303Q94M2SNSFEX4M3W3N0",
        "InitialTransactionType": "PAYOUT",
        "InitialTransactionNature": "REGULAR",
        "DebitedWalletId": null,
        "CreditedWalletId": "wlt_m_01JJ230JF16SKNVFR2FRPHEZWZ"
    }
]

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

Query parameters

Status · string

Allowed values: CREATED, SUCCEEDED, FAILED

The status of the transaction. You can filter on multiple values by separating them with a comma.

ResultCode · string

The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.

BeforeDate · Unix timestamp

The date before which the transaction was created (based on the transaction’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

AfterDate · Unix timestamp

The date after which the transaction was created (based on the transaction’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

Path parameters

PayoutId · string · required

The unique identifier of the payout.

Responses

200

Array (Refunds) · array

The list of payout refunds created for the platform.

Show properties

Object (Refund) · object

The refund created by the platform.

Show properties

Id · string

Max length: 128 characters (see 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.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.

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 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 · object

Default value: The amount and currency values of the debited funds of the initial transaction.

Information about the debited funds. Debited funds:

• Takes by default the amount and currency values of the initial transaction when left empty.
• Must be entered manually to perform a partial refund.
• Cannot exceed the initial transaction CreditedFunds value when entered manually. This also applies to the sum of debited funds when making multiple partial refunds.

Show properties

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

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.

CreditedFunds · object

Information about the credited funds (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 credited 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

Default value: The amount and currency values of the fees of the initial transaction.

Information about the fees. This value:

• Should be preceded by a minus sign (-) to refund the fees, otherwise more fees will be taken.
• Takes by default the amount and currency values of the fees of the initial transaction when left empty (preceded by a -).
• Cannot exceed the initial transaction fees amount when entered manually. This also applies to the sum of the amount of the fees when making multiple partial refunds.

Show properties

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

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.

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

DebitedWalletId · string

The unique identifier of the debited wallet.

CreditedWalletId · string

The unique identifier of the credited wallet.

200

[
    {
        "Id": "refund_m_01JJ22Z1JGMFEHB5P4B5DZ8CCQ",
        "Tag": null,
        "CreationDate": 1734628083,
        "AuthorId": "user_m_01JJ22ZEP6JQQ5KMBPHBGYFQBG",
        "CreditedUserId": null,
        "DebitedFunds": {
            "Currency": "EUR",
            "Amount": 12000
        },
        "CreditedFunds": {
            "Currency": "EUR",
            "Amount": 12000
        },
        "Fees": {
            "Currency": "EUR",
            "Amount": 0
        },
        "Status": "SUCCEEDED",
        "ResultCode": "000000",
        "ResultMessage": "Success",
        "ExecutionDate": 1734628084,
        "Type": "PAYIN",
        "Nature": "REFUND",
        "InitialTransactionId": "po_m_01JJ2303Q94M2SNSFEX4M3W3N0",
        "InitialTransactionType": "PAYOUT",
        "InitialTransactionNature": "REGULAR",
        "DebitedWalletId": null,
        "CreditedWalletId": "wlt_m_01JJ230JF16SKNVFR2FRPHEZWZ"
    }
]

REST

// GET has no body parameters