API
⌘K
My Developer Account

DesignationRefund

A record that links a Refund with a Designation

Example Request

curl https://api.planningcenteronline.com/giving/v2/donations/{donation_id}/refund/designation_refunds

View in API Explorer →

Example Object

{
  "type": "DesignationRefund",
  "id": "1",
  "attributes": {
    "amount_cents": 1,
    "amount_currency": "string"
  },
  "relationships": {
    "designation": {
      "data": {
        "type": "Designation",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
amount_cents integer The number of cents being refunded.
amount_currency string The currency of `amount_cents`.
id primary_key The unique identifier for a designation refund.

Relationships

Name Type Association Type Note
designation Designation to_one

Can Include

Parameter Value Description Assignable
include designation include associated designation create and update

Pagination

Name Parameter Type Description
per_page per_page integer how many records to return per page (min=1, max=100, default=25)
offset offset integer get results from given offset

Endpoints

Listing

HTTP Method Endpoint
GET /giving/v2/donations/{donation_id}/refund/designation_refunds

Reading

HTTP Method Endpoint
GET /giving/v2/donations/{donation_id}/refund/designation_refunds/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/giving/v2/donations/{donation_id}/refund/designation_refunds/{designation_refund_id}/designation Designation

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/giving/v2/donations/{donation_id}/refund/{refund_id}/designation_refunds Refund