POST
/
v2.01
/
{ClientId}
/
transfers
/
{TransferId}
/
refunds
{
    "Tag":"custom meta",
    "AuthorId":"146476890"
}
{
    "Id":"155586343",
    "Tag":"custom meta",
    "CreationDate":1667916816,
    "AuthorId":"146476890",
    "CreditedUserId":null,
    "DebitedFunds":{
        "Currency":"EUR",
        "Amount":1100
    },
    "CreditedFunds":{
        "Currency":"EUR",
        "Amount":1120
    },
    "Fees":{
        "Currency":"EUR",
        "Amount":-20
    },
    "Status":"SUCCEEDED",
    "ResultCode":"000000",
    "ResultMessage":"Success",
    "ExecutionDate":1667916816,
    "Type":"TRANSFER",
    "Nature":"REFUND",
    "InitialTransactionId":"155585643",
    "InitialTransactionType":"TRANSFER",
    "InitialTransactionNature":"REGULAR",
    "DebitedWalletId":"152161320",
    "CreditedWalletId":"148968396",
    "RefundReason":{
        "RefundReasonMessage":null,
        "RefundReasonType":"OTHER"
    }
}

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.

Read more about transfer refunds →

​
Path parameters

​
TransferId
string
required

The unique identifier of the transfer.

​
Body parameters

​
Tag
string

Max. length: 255 characters

Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.

​
AuthorId
string
required

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

​
DebitedFunds
object

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

Required if the Fees parameter is included in the call.

Information about the debited funds. Debited funds:

  • Takes by default the amount and currency values of the initial transaction when left empty.
  • Must be entered manually to perform a partial refund.
  • Cannot exceed the initial transaction CreditedFunds value when entered manually. This also applies to the sum of debited funds when making multiple partial refunds.
​
Fees
object

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

Required if the DebitedFunds parameter is included in the call.

Information about the fees. This value:

  • Should be preceded by a minus sign (-) to refund the fees, otherwise more fees will be taken.
  • Takes by default the amount and currency values of the fees of the initial transaction when left empty (preceded by a -).
  • Cannot exceed the initial transaction fees amount when entered manually. This also applies to the sum of the amount of the fees when making multiple partial refunds.

​
Responses

{
    "Id":"155586343",
    "Tag":"custom meta",
    "CreationDate":1667916816,
    "AuthorId":"146476890",
    "CreditedUserId":null,
    "DebitedFunds":{
        "Currency":"EUR",
        "Amount":1100
    },
    "CreditedFunds":{
        "Currency":"EUR",
        "Amount":1120
    },
    "Fees":{
        "Currency":"EUR",
        "Amount":-20
    },
    "Status":"SUCCEEDED",
    "ResultCode":"000000",
    "ResultMessage":"Success",
    "ExecutionDate":1667916816,
    "Type":"TRANSFER",
    "Nature":"REFUND",
    "InitialTransactionId":"155585643",
    "InitialTransactionType":"TRANSFER",
    "InitialTransactionNature":"REGULAR",
    "DebitedWalletId":"152161320",
    "CreditedWalletId":"148968396",
    "RefundReason":{
        "RefundReasonMessage":null,
        "RefundReasonType":"OTHER"
    }
}
{
    "Tag":"custom meta",
    "AuthorId":"146476890"
}