API reference · Donors

Find donor payment methods

GET/v1/donors/{donorId}/payment-methods

List all payment methods for a donor. Requires B2C or Donor Platform entitlement.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

donorId#stringin pathrequired

Response

200 · PaymentMethod[]

No field is described in the spec.

paymentMethodId#stringalways returned
status#PaymentMethodStatusalways returned
ENABLEDFAILEDDISABLED
type#PaymentMethodTypealways returned
PAYMENT_CARDSEPA_DIRECT_DEBITBANK_TRANSFER
externalPaymentMethodId#string
accountId#stringalways returned
createdAt#string (date-time)always returned
updatedAt#string (date-time)always returned
token#string
expiryDate#string
externalRecurringPayinRegistrationId#string

Errors

401Unauthorized
Missing, expired or invalid access token.
```
{
  "statusCode": 401,
  "message": "Unauthorized"
}
```

402Plan upgrade required

{
  "statusCode": 402,
  "message": "Plan upgrade required"
}

403Account closed

{
  "message": "Account closed",
  "code": "ACCOUNT_CLOSED"
}

GET /v1/donors/<donorId>/payment-methods

1curl -X GET https://api.sandbox.charitips.com/v1/donors/<donorId>/payment-methods \2  -H "Authorization: Bearer $CHARITIPS_TOKEN"

Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.