Create a Refund for a Transfer

You can do a partial refund by providing a debited funds Amount value lower than the initial transaction amount. The debited funds amount must be 1 or more, if it is included.

Read more about transfer refunds →

Path parameters

TransferId · string · required

The unique identifier of the transfer.

Body parameters

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.

AuthorId · string · required

The unique identifier of the user at the source of the initial transaction.

DebitedFunds · object

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

Required if the Fees parameter is included in the call.

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

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

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

Fees · object

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

Required if the DebitedFunds parameter is included in the call.

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

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

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

Responses

200

Id · string

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

InitialTransactionId · string

The unique identifier of the initial transaction being refunded.

InitialTransactionType · string

Returned values: PAYIN, TRANSFER, PAYOUT

The type of the initial transaction being refunded.

InitialTransactionNature · string

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT

The nature of the initial transaction being refunded, 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 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 the credit from a repudiation following a lost dispute.

DebitedWalletId · string

The unique identifier of the debited wallet.

CreditedWalletId · string

The unique identifier of the credited wallet.

RefundReason · object

Information about the reasons for the refund.

Show properties

RefundReasonMessage · string

Max. length: 255 characters

Message explaining the reason for the refusal.

RefundReasonType · string

Returned values: INITIALIZED_BY_CLIENT, BANKACCOUNT_INCORRECT, OWNER_DO_NOT_MATCH_BANKACCOUNT, BANKACCOUNT_HAS_BEEN_CLOSED, WITHDRAWAL_IMPOSSIBLE_ON_SAVINGS_ACCOUNTS, OTHER

The type of reason for the refund.

400 - Incorrect AuthorId

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "7daa662f-0fe0-4ddf-8865-450fe0217798",
    "Date": 1690287917.0,
    "errors": {
        "AuthorId": "Author of the refund is not the author of the initial transfer"
    }
}  

200

{
    "Id":"155586343",
    "Tag":"custom meta",
    "CreationDate":1667916816,
    "AuthorId":"146476890",
    "CreditedUserId":null,
    "DebitedFunds":{
        "Currency":"EUR",
        "Amount":1100
    },
    "CreditedFunds":{
        "Currency":"EUR",
        "Amount":1120
    },
    "Fees":{
        "Currency":"EUR",
        "Amount":-20
    },
    "Status":"SUCCEEDED",
    "ResultCode":"000000",
    "ResultMessage":"Success",
    "ExecutionDate":1667916816,
    "Type":"TRANSFER",
    "Nature":"REFUND",
    "InitialTransactionId":"155585643",
    "InitialTransactionType":"TRANSFER",
    "InitialTransactionNature":"REGULAR",
    "DebitedWalletId":"152161320",
    "CreditedWalletId":"148968396",
    "RefundReason":{
        "RefundReasonMessage":null,
        "RefundReasonType":"OTHER"
    }
}  

REST

{
    "Tag":"custom meta",
    "AuthorId":"146476890"
}