Sign in
MembershipCharges

Refund a MembershipCharge

Initiates a refund for some or all of the amount on a MembershipCharge. The refund is processed asynchronously through the payment processor.

post/customers/membership-charges/{membershipChargeId}/refund

Request body

amountinteger required

The amount to refund from this charge as an integer of the smallest unit (e.g. pence)

notestring

A custom description of why this refund was made

Example request

{
  "amount": 1000,
  "note": "Customer forgot to cancel last week"
}

Response

The MembershipCharge was successfully retrieved.

Example response

{
  "data": {
    "membership": {
      "membership_number": "00000014",
      "type_name": "Gold Membership",
      "customer_name": "Jane Jones"
    },
    "processor": "adyen",
    "processor_data": {
      "cardholder_name": "Mrs J Jones",
      "processor_type": "Cash"
    },
    "amount": 3995,
    "original_amount": 3995,
    "currency": "gbp",
    "status": "succeeded",
    "refunds": [
      {
        "status": "succeeded",
        "currency": "gbp",
        "notes": "Gesture of good will",
        "failure_reason": "invalid_details",
        "refunded_by": {
          "full_name": "Jane Jenkins"
        },
        "processor_data": {
          "processor": "adyen",
          "processor_id": "re_64301e0b2df9d11814010ea6"
        }
      }
    ]
  }
}

Changes

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