PaymentSource
A donation's PaymentSource refers to the platform it originated from.
Donations made through Giving will be assigned the built-in PaymentSource "Planning Center". Donations made through external platforms (Square, Pushpay, ect.) can be assigned a PaymentSource identifying them as such.
Example Object
{
"type": "PaymentSource",
"id": "1",
"attributes": {
"created_at": "2000-01-01T12:00:00Z",
"name": "string",
"status": "value",
"updated_at": "2000-01-01T12:00:00Z"
},
"relationships": {}
}
Attributes
| Name |
Type |
Description |
created_at |
date_time |
The date and time at which a payment source was created. Example: `2000-01-01T12:00:00Z` |
id |
primary_key |
The unique identifier for a payment source. |
name |
string |
Required. The name of a payment source. Must be unique within the associated organization. |
status |
string |
The status of the payment source. Can be either `active` or `archived`. `active` payment sources can be assigned to donations, while `archived` payment sources cannot. Payment sources are `active` by default upon creation. Archiving a payment source will keep all historical records intact and can be undone.
Possible values: `active` or `archived` |
updated_at |
date_time |
The date and time at which a payment source was last updated. Example: `2000-01-01T12:00:00Z` |
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/payment_sources |
Reading
| HTTP Method |
Endpoint |
| GET |
/giving/v2/payment_sources/{id} |
Creating
| HTTP Method |
Endpoint |
Assignable Attributes |
| POST |
/giving/v2/payment_sources |
- name
- status
- payment_source_type
|
Updating
| HTTP Method |
Endpoint |
Assignable Attributes |
| PATCH |
/giving/v2/payment_sources/{id} |
- name
- status
- payment_source_type
|
Deleting
| HTTP Method |
Endpoint |
| DELETE |
/giving/v2/payment_sources/{id} |
Associations
| HTTP Method |
Endpoint |
Returns |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/giving/v2/payment_sources/{payment_source_id}/donations |
Donation
|
|
|
Belongs To
| HTTP Method |
Endpoint |
Association |
Details |
Filter By |
| GET |
https://api.planningcenteronline.com/giving/v2/payment_sources |
Organization
|
|
|