Refund

To return funds to your shopper, you can refund all or part of their payment. For example: if an item in the order is out of stock, you refund that part of the payment.

When you make a refund request for a payment that was only pre-authorised, Datman captures the payment in full first and then refunds it.

RequirementsCopy Anchor Link

Before you begin, take into account the following requirements, limitations, and preparations.

Types of refundsCopy Anchor Link

Make a refundCopy Anchor Link

To return funds to the shopper:

1. From the information of the payment you want to refund, get your order_id and the merchant_id.

2. Make a refund request with your api_token header and the following parameters:

   Parameter	Required	Description
   merchant_id	Required	The merchant that took the payment.
   order_id	Required	Your own order reference for the payment, as you sent it when paying.
   amount	Required	The amount to refund, in major units, for example 3.25. Minimum 0.01.
   reason		Why the payment is refunded.
   requested_by		Who asked for the refund, for your records.
   refund_split_fee		For a payment with splits: how much to take back from each merchant that received part of the payment. Each item has partner_merchant_id and refund_amount. The total can't be more than amount.

   The Refund a payment page in the API Explorer has the full request, with examples you can try.

3. When you receive the response, note:

   • outcome: success when the refund was made, or failed when it wasn't. Errors are returned with HTTP 200, so always check outcome.
   • destination: the amount refunded to each destination, as strings, for example CARD 3.25.
   • transaction_methods: the payment method of the original payment (ECOM, GPAY, APPLEPAY or WALLET) and its original total, as strings.
   • message: present for an uncaptured pre-authorisation, which is captured first and then refunded.

   Example response for a refund request

   Copy Text

   {
     "outcome": "success",
     "destination": {
       "CARD": "3.25"
     },
     "transaction_methods": {
       "ECOM": "27.75"
     }
   }

4. To check the refunds recorded against a payment, get the refunds recorded against the transaction.

Reasons for a failed refundCopy Anchor Link

When a refund fails, you receive outcome failed and a message with the reason. The next table shows the most common reasons.

See alsoCopy Anchor Link

• Refund a payment in the API Explorer
• Reverse authorisation
• Capture
• Modify payments