Create a new donation(transaction)
None.
Donation(transaction) data
DonationRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DonorFirstName | string |
Max length: 50 |
|
| DonorLastName | string |
Max length: 50 |
|
| DonorEmail | string |
Max length: 100 |
|
| DonorAddress | AddressRequest | ||
| AnonymousDonation |
Indicate if payment was made anonymously |
boolean | |
| TransactionType | TransactionType |
Required |
|
| DonationDate |
Date transaction was processed (in timezone used in organization settings) |
date |
Required |
| Description | string | ||
| Amount |
Transaction Amount |
decimal number |
Required |
| AssociatedEventId |
Optionally specify an event id if this payment is associated with an opportunity |
integer | |
| DonatedToUserId |
Optionally specify a user id if this payment was designated for an opportunity participant. Note: AssociatedEventId must be provided if DonatedToUserId is set |
integer | |
| ExternalIdentifier |
External identifier for this payment |
string |
{
"DonorFirstName": "sample string 1",
"DonorLastName": "sample string 2",
"DonorEmail": "sample string 3",
"DonorAddress": {
"Address1": "sample string 1",
"Address2": "sample string 2",
"City": "sample string 3",
"State": "sample string 4",
"Zip": "sample string 5",
"Country": "sample string 6",
"Name": "sample string 7"
},
"AnonymousDonation": true,
"TransactionType": "CreditCardPayment",
"DonationDate": "2024-12-22T18:36:39.7250492Z",
"Description": "sample string 6",
"Amount": 7.0,
"AssociatedEventId": 1,
"DonatedToUserId": 1,
"ExternalIdentifier": "sample string 8"
}
Sample not available.
https://api.servicereef.com/v1/payments/add?model={model}
| Name | Description | Type | Additional information |
|---|---|---|---|
| TransactionId | integer | ||
| UserId |
User who placed this transaction. Null if user was not logged in |
integer | |
| FirstName | string | ||
| LastName | string | ||
| string | |||
| Phone | string | ||
| UserProfileUrl |
Url for member profile for member who placed transaction if user was logged in |
string | |
| Address | AddressModel | ||
| EventId | integer | ||
| EventName | string | ||
| EventCode |
Unique identifier brought over from your accounting software that helps you manage your internal records of donations and payments |
string | |
| EventUrl | string | ||
| DonatedToUsers |
List of users who made donations on this transaction |
Collection of GiftedToUserModel | |
| DonatedToUserId |
Gets the DonatedToUserId. Is Obsolete; Use DonatedToUsers |
integer | |
| DonatedToFirstName |
Gets the DonatedToUser FirstName. Is Obsolete; Use DonatedToUsers |
string | |
| DonatedToLastName |
Gets the DonatedToUser LastName. Is Obsolete; Use DonatedToUsers |
string | |
| Description | string | ||
| Type |
Transaction type - Cash, Check, CredidCard, or ACH |
string | |
| TransactionFees |
Any credit card fees from the payment processor or ServiceReef transaction fees |
decimal number | |
| Amount |
Transaction Amount |
decimal number | |
| Date |
Date transaction was processed |
date | |
| DateCreated |
Date transaction was created |
date | |
| DateLastUpdated |
Date transaction was last updated |
date | |
| Anonymous |
Payment was made anonymously |
boolean | |
| CCLast4 |
Last 4 digits of credit card number if this was a credit card transaction |
string | |
| PaymentProcessorName |
Name of the payment processor (Stripe, PayPal, etc) |
string | |
| PaymentProcessorTransactionId |
Transaction ID from the payment processor |
string | |
| PaymentProcessorBatchId |
Batch ID from the payment processor |
string | |
| IntegrationIdentifiers |
Identifiers in integrated systems |
Collection of IntegrationIdentifierModel | |
| FellowshipOneContributionReceiptId |
FellowshipOne's contribution receipt id. |
integer | |
| RegularAttenderOfThisChurch |
Is the donor a regular attender |
boolean | |
| ExternalId |
External Identifier |
string |
Try this endpoint by entering your credentials and using the API Explorer.
Try With API Explorer
{
"TransactionId": 1,
"UserId": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 5",
"Phone": "sample string 6",
"UserProfileUrl": "https://sample string 22.servicereef.com/users/sample string 4",
"Address": {
"Latitude": 1.1,
"Longitude": 1.1,
"Address1": "sample string 1",
"Address2": "sample string 2",
"City": "sample string 3",
"State": "sample string 4",
"Zip": "sample string 5",
"Country": "sample string 6",
"Name": "sample string 7"
},
"EventId": 1,
"EventName": "sample string 7",
"EventCode": "sample string 8",
"EventUrl": "https://sample string 22.servicereef.com/events/sample string 21/sample string 18",
"DonatedToUsers": [
{
"UserId": 1,
"FirstName": "sample string 1",
"LastName": "sample string 2",
"DonationAmount": 3.0
},
{
"UserId": 1,
"FirstName": "sample string 1",
"LastName": "sample string 2",
"DonationAmount": 3.0
}
],
"DonatedToUserId": 1,
"DonatedToFirstName": "sample string 1",
"DonatedToLastName": "sample string 2",
"Description": "sample string 9",
"Type": "Charge",
"TransactionFees": 10.0,
"Amount": 11.0,
"Date": "2024-12-22T18:36:39.7406766Z",
"DateCreated": "2024-12-22T18:36:39.7406766Z",
"DateLastUpdated": "2024-12-22T18:36:39.7406766Z",
"Anonymous": true,
"CCLast4": "sample string 14",
"PaymentProcessorName": "sample string 15",
"PaymentProcessorTransactionId": "sample string 16",
"PaymentProcessorBatchId": "sample string 17",
"IntegrationIdentifiers": [
{
"IntegrationId": 1,
"IntegrationName": "sample string 2",
"ExternalSystemIdentifier": "sample string 3",
"LastSyncedTime": "2024-12-22T18:36:39.7563018Z"
},
{
"IntegrationId": 1,
"IntegrationName": "sample string 2",
"ExternalSystemIdentifier": "sample string 3",
"LastSyncedTime": "2024-12-22T18:36:39.7563018Z"
}
],
"FellowshipOneContributionReceiptId": null,
"RegularAttenderOfThisChurch": true,
"ExternalId": "sample string 19"
}