apiResponses1

applePay1

Authentication3

Bancontact1

bankAccounts8

bankingAliases4

bankWirePayins1

Bizum1

Blik1

cardRegistrations4

Cards4

cardValidations2

Client3

clientWallets3

conversionRates1

Conversions5

countryAuthorizations2

depositPreauthorizations6

directCardPayins1

directDebitPayins1

disputeDocuments7

Disputes9

disputeSettlement3

Events1

extendedPreauthorizations6

Giropay1

googlePay1

iDEAL1

idvSessions4

Intents16

Klarna1

kycDocuments6

Mandates7

mbWay1

Multibanco1

payByBank2

Payconiq1

payins1

paymentMethodMetadata1

Payouts4

PayPal8

Preauthorizations6

Quotes2

Recipients7

recurringApplePayPayins1

recurringCardPayins1

recurringGooglePayPayins1

recurringPayinRegistrations3

Refunds7

Reporting3

Reports4

Repudiations1

Satispay1

Settlements7

Swish1

Transactions11

Transfers2

TWINT1

uboDeclarations7

userDataFormat1

userEmoney1

userRegulatoryStatus1

Users18

virtualAccounts5

wallets4

webCardPayins2

webDirectDebitPayins1

Webhooks4

Refunds

Create a Refund for a PayIn

Changed on Sep 17, 2026

The pay-in refund is a request to reimburse a pay-in and is supported for most payment methods. You can make partial refunds by providing a debited funds Amount value lower than the initial transaction amount.

<Note icon="fa-regular fa-circle-info"> **Note – Conditions for pay-in refund**

The amount value is 1 or above, regardless of the currency.
The initial transaction status is SUCCEEDED.
The initial transaction hasn't been disputed.
The initial transaction was made within the time window specified for the payment method. </Note>

Request

Base URL
https://api.sandbox.mangopay.com
URL
https://api.sandbox.mangopay.com/v2.01/{ClientId}/payins/{PayInId}/refunds
Auth
HTTP bearer

Path parameters

ClientIdstring required

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

PayInIdstring required

The unique identifier of the pay-in.

Request body

Tagstring

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

AuthorIdstring required

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

StatementDescriptorstring

Max. length: 10 characters; only alphanumeric and spaces

Custom description to appear on the user's bank statement along with the platform name. On refunds, the StatementDescriptor is only available when refunding SEPA and BACS direct debit pay-ins (no other payment methods nor transfers).

Different banks may show more or less information. See the <a href="/bank-statements">Customizing bank statement references</a> article for details.

Response

Success

Idstring

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

The unique identifier of the object.

Tagstring

Max. length: 255 characters

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 initial transaction.

CreditedUserIdstring

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

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 <a href="/errors/codes">handle errors</a> 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.

InitialTransactionIdstring

The unique identifier of the initial transaction being refunded.

InitialTransactionTypestring

Returned values: PAYIN, TRANSFER, PAYOUT

The type of the initial transaction being refunded.

InitialTransactionNaturestring

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.

DebitedWalletIdstring

The unique identifier of the debited wallet.

CreditedWalletIdstring

The unique identifier of the credited wallet.