View a Refund

GET

/v2.01/:ClientId/refunds/:RefundId

GET

/v2.01/:ClientId/refunds/:RefundId

$ curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/refunds/{RefundId} \
>      -H "Authorization: Bearer <token>"

1 {
2   "AuthorId": "user_m_01JJ23MPT0Y79AFQA637ZK81CF",
3   "CreationDate": 1730373612,
4   "CreditedFunds": {
5     "Amount": 550,
6     "Currency": "EUR"
7   },
8   "CreditedUserId": null,
9   "CreditedWalletId": null,
10   "DebitedFunds": {
11     "Amount": 500,
12     "Currency": "EUR"
13   },
14   "DebitedWalletId": "wlt_m_01JJ23NKD34XA6G4N70ZFKFH5W",
15   "ExecutionDate": 1730373612,
16   "Fees": {
17     "Amount": -50,
18     "Currency": "EUR"
19   },
20   "Id": "refund_m_01JJ23MDDHCXX1GYVKDPYNJKJ8",
21   "InitialTransactionId": "payin_m_01JJ23NT128Y1V1B5B16VKMQ92",
22   "InitialTransactionNature": "REGULAR",
23   "InitialTransactionType": "PAYIN",
24   "Nature": "REFUND",
25   "RefundReason": {
26     "RefundReasonMessage": null,
27     "RefundReasonType": "INITIALIZED_BY_CLIENT"
28   },
29   "ResultCode": "000000",
30   "ResultMessage": "Success",
31   "StatementDescriptor": null,
32   "Status": "SUCCEEDED",
33   "Tag": "Example with fees refunded",
34   "Type": "PAYOUT"
35 }

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 Data availability periods article.

<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 to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

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

PayInRefundResponseobject

TransferRefundResponseobject

PayoutRefundResponseobject

A payout return — a refund of a payout, initiated automatically by Mangopay when funds cannot be delivered to the recipient bank account.

RepudiationRefundResponseobject

A repudiation return — a refund created automatically by Mangopay when a dispute is won in favor of the platform, re-crediting the Repudiation Wallet.