PaymentMethod

Stored PaymentMethod information (card or bank_account) used by donors to make online Donations.

PaymentMethod data is for informational purposes only and cannot be used to create charges through the API.

Example Request

curl https://api.planningcenteronline.com/giving/v2/people/{person_id}/payment_methods

View in API Explorer →

Example Object

{
  "type": "PaymentMethod",
  "id": "1",
  "attributes": {
    "brand": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "expiration": "2000-01-01",
    "last4": "string",
    "method_subtype": "string",
    "method_type": "value",
    "updated_at": "2000-01-01T12:00:00Z",
    "verified": true
  },
  "relationships": {}
}

Attributes

Name	Type	Description
`brand`	`string`	For cards, this is the card brand (eg Visa, Mastercard, etc). For bank accounts, this is the bank name.
`created_at`	`date_time`	The date and time at which a payment method was created. Example: `2000-01-01T12:00:00Z`
`expiration`	`date`	For cards only. String representation of the expiration date in the `MM/YYYY` form (without leading zeros). Will be `null` for bank accounts.
`id`	`primary_key`	The unique identifier for a payment method.
`last4`	`string`	The last 4 digits of the payment method's number. For cards, this is the last 4 digits of the card number. For bank accounts, this is the last 4 digits of the bank account number. Note: In cases where we don't have all 4 digits on file, a `` will be used to pad the number. For example: `321`
`method_subtype`	`string`	For cards, either `credit`, `debit`, `prepaid`, or `unknown`. For bank accounts, either `checking` or `savings`.
`method_type`	`string`	Determines whether or not the payment method is a card or bank account. Possible values: `card`, `us_bank_account`, or `au_becs_debit`
`updated_at`	`date_time`	The date and time at which a payment method was last updated. Example: `2000-01-01T12:00:00Z`
`verified`	`boolean`	For bank accounts only. Will be `null` for cards.

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/people/{person_id}/payment_methods`

Reading

HTTP Method	Endpoint
GET	`/giving/v2/people/{person_id}/payment_methods/{id}`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/giving/v2/people/{person_id}/payment_methods/{payment_method_id}/recurring_donations`	RecurringDonation

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/giving/v2/people/{person_id}/payment_methods`	Person
GET	`https://api.planningcenteronline.com/giving/v2/recurring_donations/{recurring_donation_id}/payment_method`	RecurringDonation