Payment methods
Payment methods (PaymentMethod) define how an organization can receive money. Each method is tied to a processor (the payment gateway) and can be enabled on specific publishing channels.
Available processors
| Processor | Description |
|---|---|
manual | Manual payment (e.g. bank transfer). No automatic processing. |
stripe | Credit card, SEPA debit or POS terminal via Stripe. |
paypal | PayPal wallet. |
satispay | Satispay gateway. |
sumup | SumUp POS terminal. |
Payment types by processor
Stripe
| Type | Value | Description |
|---|---|---|
| Credit card | card | Online payment by card |
| SEPA debit | sepa_debit | Direct debit from a European bank account |
| Physical POS | card_present | Physical terminal (e.g. WisePOS E) |
PayPal
| Type | Value | Description |
|---|---|---|
| Wallet | wallet | Payment via PayPal account |
SumUp
| Type | Value | Description |
|---|---|---|
| Physical POS | pos | Physical SumUp terminal |
Manual and Satispay
No sub-type: a single method per processor.
Main fields
| Field | Type | Description |
|---|---|---|
id | Int | Unique identifier |
label | String | Human-readable name of the method (e.g. "Credit card") |
processor | String | Associated processor (see table above) |
has_oneoff_support | Boolean | Accepts oneoff donations |
has_subscription_support | Boolean | Accepts recurring donations |
include_in_certificate | Boolean | Payments through this method go into the annual tax certificate |
channels | [Int] | IDs of the channels on which the method is available |
description | String | Descriptive text (manual methods only) |
instructions | String | Instructions for the donor (manual methods only) |
disconnected_at | DateTime | When the account of the processor was disconnected. null while the method is in use |
Methods of a disconnected account
An organization can disconnect its Stripe or PayPal account (Settings > Payments > Disconnect account, administrators only; through the API with stripeAccountDisconnect and paypalAccountDisconnect). Riseact deletes neither the account nor its methods, because they carry the history of donations and payments:
- the methods stay in the
paymentMethodslist, withdisconnected_atset and the label renamed to<label> (deleted <identifier>), where the identifier is the Stripeaccount_idor the PayPalmerchant_id; - they are no longer offered to donors, on any campaign or channel;
- donations collected with those methods can no longer be revoked, changed in amount or refunded from Riseact:
donationRevoke,donationUpdate(onamountandfrequency) andpaymentRefundreturn an error, and they have to be managed from the Stripe dashboard or from PayPal; - active recurring donations keep being charged on the old account until the organization cancels them on the provider. Renewals and cancellations made on the provider are still recorded in Riseact;
- recurring donations are not moved to the new account: donors who want to keep giving have to start a new donation.
The account is also disconnected automatically when the organization revokes the access of Riseact from its Stripe or PayPal account.
After disconnecting, a new account can be connected, which creates new payment methods.
Channels
The channels field is an array of channel IDs. A payment method is shown in the checkout only if the checkout's channel is included in this array. If channels is empty, the method is not available on any channel.
GraphQL Query
List all payment methods:
query {
paymentMethods {
id
label
processor
hasOneoffSupport
hasSubscriptionSupport
includeInCertificate
channels
}
}
List only manual methods (useful for creating payments manually):
query {
manualPaymentMethods {
id
label
description
instructions
}
}
Single manual method:
query {
manualPaymentMethod(id: 5) {
id
label
description
instructions
}
}
Using payment methods in the checkout
When creating a checkout via API, you can specify the desired payment method. It is important to verify that the method supports the donation type (oneoff or recurring) and that it is active on the correct channel.
mutation {
checkoutCreate(data: {
campaignId: 29,
donationAmount: 50,
donationFrequency: 0,
paymentMethodId: 3
}) {
checkout {
id
state
}
userErrors {
field
message
}
}
}
Creating a manual payment
To manually record a payment (e.g. after receiving a bank transfer), use the paymentCreate mutation specifying a manual type method:
mutation {
paymentCreate(data: {
donationId: 229,
paymentMethodId: 1,
amount: "50.00",
paymentDate: "2024-01-15"
}) {
payment {
id
state
amount
}
userErrors {
field
message
}
}
}