List Refunds for a Transfer

GET

/v2.01/:ClientId/transfers/:TransferId/refunds

GET

/v2.01/:ClientId/transfers/:TransferId/refunds

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

200Retrieved

1 [
2   {
3     "Id": "refund_m_01JJ264GDXH7QAW558VMKBCE2M",
4     "Tag": "Partial refund with fees refunded",
5     "CreationDate": 1737387819,
6     "AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
7     "CreditedUserId": null,
8     "DebitedFunds": {
9       "Currency": "EUR",
10       "Amount": 1782
11     },
12     "CreditedFunds": {
13       "Currency": "EUR",
14       "Amount": 2454
15     },
16     "Fees": {
17       "Currency": "EUR",
18       "Amount": -672
19     },
20     "Status": "SUCCEEDED",
21     "ResultCode": "000000",
22     "ResultMessage": "Success",
23     "ExecutionDate": 1737387819,
24     "Type": "TRANSFER",
25     "Nature": "REFUND",
26     "CreditedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
27     "DebitedWalletId": "wlt_m_01JJ25YQA60D8FVZYEBMXG733F"
28   },
29   {
30     "Id": "refund_m_01JJ264WWWPCM1WPS3TG08G0Y2",
31     "Tag": "Partial refund with more fees taken",
32     "CreationDate": 1737387832,
33     "AuthorId": "user_m_01JHSSTVRDN5SN9T14SRC6SA9A",
34     "CreditedUserId": null,
35     "DebitedFunds": {
36       "Currency": "EUR",
37       "Amount": 1672
38     },
39     "CreditedFunds": {
40       "Currency": "EUR",
41       "Amount": 1183
42     },
43     "Fees": {
44       "Currency": "EUR",
45       "Amount": 489
46     },
47     "Status": "SUCCEEDED",
48     "ResultCode": "000000",
49     "ResultMessage": "Success",
50     "ExecutionDate": 1737387832,
51     "Type": "TRANSFER",
52     "Nature": "REFUND",
53     "CreditedWalletId": "wlt_m_01JHSSTYGT28P1F5KJ82QZ0K65",
54     "DebitedWalletId": "wlt_m_01JJ25YQA60D8FVZYEBMXG733F"
55   }
56 ]

List Refunds for a Transfer

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.

TransferIdstringRequired

The unique identifier of the transfer.

Query parameters

StatusstringOptional

Allowed values: CREATED, SUCCEEDED, FAILED

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

ResultCodestringOptional

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

BeforeDateintegerOptional

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.

AfterDateintegerOptional

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.

Response

Success

Array (Refunds)list of objects

The list of refunds created by the platform.