Refund a payment

Return captured money to the shopper, in full or in parts.

🚧

Early release

Online payments is in early development (MVP). This section may change.

Refund money you have already captured, for example for cancelled orders, returned goods, price adjustments or duplicate charges.

You can refund payment methods that allow it after capture, such as cards and some alternative payment methods, for example Vipps and wallets. What works depends on your acquirer and the payment methods you support.

When to refund

  • You have captured the payment, fully or partly.
  • The acquirer has collected the money.
  • You need to return some or all of it.

You can't refund before capture. To release money that isn't captured, cancel instead.

How much you can refund

Refundable amount = captured amount − refunded amount

A refund can't be more than the refundable amount.

Refund the full amount

Send the request without a body. Aera refunds the full refundable amount.

POST /v1/{pspReference}/refund

Refund part of the amount

Example partial refund request
{
  "amountDetails": { "amount": 3000, "currency": "NOK" },
  "reference": "Customer returned one item"
}
FieldDescription
amountDetailsThe amount to refund, in minor units. Leave out to refund the full refundable amount.
referenceYour own text, for example the return reason. Optional.

You can make several partial refunds, until the refunded total equals the captured amount. The payment is then refunded.

Good to know

  • Some payment methods process refunds later (asynchronously). Check the result with Get payment status.
  • Every refund needs a new idempotency-key.
  • When the shopper gets the money depends on the acquirer and card scheme rules.

Did this page help you?