Create a Refund for a Transfer

POST

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

POST

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

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/transfers/TransferId/refunds \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "Tag": "custom meta",
>     "AuthorId": "146476890"
>   }
> }'

1 {
2   "Id": "155586343",
3   "Tag": "custom meta",
4   "CreationDate": 1667916816,
5   "AuthorId": "146476890",
6   "CreditedUserId": null,
7   "DebitedFunds": {
8     "Currency": "EUR",
9     "Amount": 1100
10   },
11   "CreditedFunds": {
12     "Currency": "EUR",
13     "Amount": 1120
14   },
15   "Fees": {
16     "Currency": "EUR",
17     "Amount": -20
18   },
19   "Status": "SUCCEEDED",
20   "ResultCode": "000000",
21   "ResultMessage": "Success",
22   "ExecutionDate": 1667916816,
23   "Type": "TRANSFER",
24   "Nature": "REFUND",
25   "InitialTransactionId": "155585643",
26   "InitialTransactionType": "TRANSFER",
27   "InitialTransactionNature": "REGULAR",
28   "DebitedWalletId": "152161320",
29   "CreditedWalletId": "148968396",
30   "RefundReason": {
31     "RefundReasonMessage": null,
32     "RefundReasonType": "OTHER"
33   }
34 }

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.

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.

Request

This endpoint expects an object.

AuthorIdstringRequired

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

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

DebitedFundsobjectOptional

Information about the debited funds.

FeesobjectOptional

Information about the fees.

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

Information about the debited funds.

CreditedFundsobject

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

Feesobject

Information about the fees.

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.

Errors

400

Bad Request Error