GEgetpaid
Payments

Refund a payment

Refund a captured payment fully or partially.

Related webhooks:

  • payment_refunded: sent when the funds are returned to the buyer.
  • payment_refund_failed: sent when a refund process fails due to business or technical issues.
post/v2/payments/{payment_id}/refunds

Request

Path parameters

payment_idstring id required

The unique identifier of the payment.

Example:pay_4a4m2pjycdb1jbj68h1rvk9kcz

The ID of the payment to refund.

Headers

Getpaid-Idempotency-Keystring required
Example:5c255194-30ec-11ed-a261-0242ac120002

A unique idempotency key to allow safe retrying. See Getpaid API idempotency for more details.

Request body

OR

Example request

{
  "reference": "ORD-202510-0232",
  "webhooks": {
    "url": "https://webhooks.titanauto.com/getpaid"
  }
}

Response

Created

OR

Example response

{
  "id": "rfd_4a4m2pjycdb1jbj68h1rvk9kcz",
  "reference": "ORD-202510-0232",
  "created_at": "2025-09-01T22:05:48.479Z",
  "updated_at": "2025-09-01T22:05:48.479Z",
  "amount": 1000,
  "splits": {
    "accounts": [
      {
        "id": "acc_44678r08jtm8zbt227tzhc4nw5",
        "split": {
          "amount": 1000
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.