RefundsRefunds

View a Refund

<Note icon="fa-regular fa-circle-info"> **Note – Refund data retained for 13 months** The API retains all transaction objects for 13 months from `CreationDate`. This applies to refunds and the initial transaction linked to a refund. A call to retrieve the initial transaction of a refund, based on the refund’s `InitialTransactionId`, may return a 404 Not Found if it occurred more than 13 months ago. 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.
RefundIdstringRequired

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

DebitedFundsobject

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

Required if the Fees property is sent.

Information about the debited funds. The refund DebitedFunds.Amount:

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

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Feesobject

Default value: The currency and amount (preceded by a minus sign) of the Fees of the initial transaction.

Required if the DebitedFunds property is sent.

Information about the fees. The refund Fees.Amount:

  • Must be preceded by a minus sign (-) to refund the fees, otherwise a positive value takes more fees.
  • Takes by default (when not set) the Fees.Amount of the initial transaction (preceded by a minus sign).
  • Cannot exceed the initial transaction Fees.Amount. This alsoapplies to the sum of amounts when making multiple partial refunds.
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.
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.
RefundReasonobject
Information about the reasons for the refund.
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 Customizing bank statement references article for details.