Refund payments in Console

A refund is a payment, or multiple payments, to an account that previously paid in. A refund is linked to, and cannot exceed the total value of, an initial pay-in into your merchant account.

You can issue refunds using the /v3/payments/{id}/refunds endpoint.

However, you can also issue refunds for payments from the payments view in Console without the need to integrate with the endpoint.

You can only refund closed-loop payments (payments that a user makes into your merchant account).

Requirements

A user signed into your application in Console can only issue a refund if they meet two requirements:

• The Owner, Admin, or Payment operator role in the application.
• Authenticated using multi-factor authentication (MFA) for their Console account.
  If they don't have MFA enabled, configure it for them from the User settings page.

Refund a payment

To refund a payment:

1. Click the payment in the payments view to open it. You will be navigated do the payment detail details. Click the Refund button.

   

2. The dialog displays. Enter the amount that you want to refund. The amount of money refunded cannot be more than the amount of the original payment.
   Optionally, you can add custom metadata to your refund.

   

3. Then click the Refund. If authentication is needed, a modal opens that enables you to do this. After you authenticate, a 5-minute session starts during which you can refund payments. After 5 minutes, you need to re-authenticate.

   

4. A confirmation modal shows the payment details. The refund also displays in the payments view if successful.
   When a refund succeeds, a modal displays with the refund ID and the ID of the original payment.
   Click the View refund details button to open the newly created refund details.