API
⌘K
My Developer Account

Refund

A Refund record holds information pertaining to a refunded Donation.

Example Request 

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

View in API Explorer →

Example Object 

{
  "type": "Refund",
  "id": "1",
  "attributes": {
    "amount_cents": 1,
    "amount_currency": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "fee_cents": 1,
    "fee_currency": "USD",
    "refunded_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name Type Description
amount_cents integer

The number of cents being refunded.
amount_currency string

The currency of amount_cents.
created_at date_time

The date and time at which a refund was created. Example: 2000-01-01T12:00:00Z
fee_cents integer

The payment processing fee returned by Stripe, if any.
fee_currency currency_abbreviation

The currency of fee_cents.
id primary_key

The unique identifier for a refund.
refunded_at date_time

The date and time at which a refund was processed. Example: 2000-01-01T12:00:00Z
updated_at date_time

The date and time at which a refund was last updated. Example: 2000-01-01T12:00:00Z

Can Include

Parameter Value Description Assignable
include designation_refunds

include associated designation_refunds

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

Reading

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

Associations

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

Belongs To

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