Before you begin
- The settlement account that received the payment must have its
bankIdset. Refunds from an account without one fail. See Set up Roqqett. - Check that your bank supports open banking refunds: List banks returns
supportsRefundsfor each bank. - Only payments from
SHOPPINGcheckout sessions can be refunded. A payment’sisRefundablefield tells you whether you can still refund it.
Step 1: Start the refund
POST
/v2/roqqett/payments/{paymentId}/refundsamountmust be in the payment’s currency. You can refund part of a payment, and make several refunds, up to the amount paid.reasonis optional, up to 140 characters.
409 if the payment can’t be refunded, the amount is more than what’s left to refund, or the amount is over that limit.
Step 2: Authorise the refund at your bank
OpenauthorisationUrl in a new window. The person authorising the refund logs in to your bank and approves the payment, as they would any other payment from that account.
authorisationUrl is only returned when you create the refund. If it’s lost, or the refund is cancelled, start a new refund.
Step 3: Check the refund status
GET
/v2/roqqett/refunds/{refundId}
Each refund also appears in List payments with a
type of REFUND and refundedPaymentId set to the original payment.