Skip to main content

Refunds

Overview​

Refunds allow sellers to return funds to buyers for completed payments. A refund can be initiated for various reasons, such as order cancellations, product returns, or disputes.

You can refund the full captured amount or perform one or multiple partial refunds. Some payment methods do not support partial refunds, you can check in the payment methods overview.

Steps​

1. Create a full payment refund​

For already captured payments, you can initiate a refund by calling the POST api.getpaid.io/v2/payments/{payment_id}/refunds endpoint.

In this scenario, a full refund is performed. See how to perform a partial refund when the total amount is not returned.

For full refunds, all the funds split between the parties involved in the original payment are returned, therefore there is no need to set the splits for the refund.

POST api.getpaid.io/v2/payments/{payment_id}/refunds
{
  "type": "full",
  "reference": "RFD-202510-0002",
  "webhooks": {
    "url": "https://webhooks.titanauto.com/getpaid"
  }
}

2. Handle refund response​

If the refund creation is successful, it returns a unique refund id and the original payment information that is being used to determined the funds to be returned to the buyer and from which accounts these funds are being deducted.

201 Created - POST api.getpaid.io/v2/payments/{payment_id}/refunds
{
  "id": "rfd_4a4m2pjycdb1jbj68h1rvk9kcz",
  "type": "full",
  "status": "initiated",
  "reference": "RFD-202510-0002",
  "created_at": "2025-10-25T07:11:57.761Z",
  "updated_at": "2025-10-25T07:11:57.761Z",
  "amount": 1000,
  "splits": {
    "accounts": [
      {
        "id": "acc_4f5zanqzxfg9w9jj5e81bm6bc9",
        "split": {
          "amount": 900
        }
      },
      {
        "id": "acc_4q90qx2kdczs59yqfq34p09qx6",
        "split": {
          "amount": 100
        }
      }
    ]
  }
}

3. Payment refunded notification​

Once the refund is completed, and the funds are returned to the buyer, your platform server receives a payment_refunded webhook.

payment_refunded webhook
{
  "id": "evt_4yd8tht4hwkpk3g14w4sey01mt",
  "type": "payment_refunded",
  "version": "v2",
  "occurred_at": "2025-10-27T08:01:33.295Z",
  "data": {
    "id": "pay_4kf9v6xp00hzc99rdwr5m97wce",
    "reference": "ORD-202510-0232",
    "refund": {
      "id": "rfd_4a4m2pjycdb1jbj68h1rvk9kcz",
      "reference": "RFD-202510-0002"
    }
  }
}