💳 Payment
This API is being retired on September 30th, 2026, and is replaced by the new Cloud API. Please see here for details on how to get started on the Cloud API.
Payments for registrations and donations can all be found in the Payments endpoints.
Refunds can also be found through the Payments endpoints which will come through as a negative value and transaction_type will be 'refund'.
The payment_transaction_guid or payment_guid is the unique ID for that payment and can be linked to other data types such as registrations.
The following table contains the fields that are returned within the response call of the payment endpoints.
| Key | Label | Type | Description |
|---|---|---|---|
| address_line_1 | Address Line 1 | String | Address line 1 |
| address_line_2 | Address Line 2 | String | Address line 2 |
| amount_with_fees | Amount With Fees | Long | Total amount paid |
| amount_without_fees | Amount Without Fees | Long | Total amount paid minus the total fees |
| charity_account_guid | Charity Account GUID | UUID | Charity account GUID |
| company_account_guid | Company Account GUID | UUID | Company account GUID |
| country_code | Country Code | String | Country code |
| currency | Currency | String | Currency |
| donation_message | Donation Message | String | Donation message |
| donor_fee_covered_amount | Donor Fee Covered Amount | Long | Donor fee covered amount |
| String | |||
| fee_model | Fee Model | String | Fee model |
| first_name | First Name | String | First name |
| fundraise_checkout_id | Fundraise Checkout Id | Long | Fundraise checkout Id |
| fundraise_event_page_id | Fundraise Event Page Id | Long | Fundraise event page Id |
| fundraise_page_or_team_page_ids | Fundraise Page or Team Page Ids | Array[Integer] | Fundraise page or team page Ids |
| fundraise_payment_id | Fundraise Payment Id | Long | Fundraise payment Id |
| fundraise_schedule_id | Fundraise Schedule Id | Long | Fundraise schedule Id |
| gift_aid_amount | Gift Aid Amount | Long | Gift aid amount |
| gift_aid_fee | Gift Aid Fee | Long | Gift aid fee |
| gifting_amount | Gifting Amount | Long | Gifting amount |
| house_name | House Name | String | House name |
| is_anonymous | Is Anonymous | Boolean | The donor has opted to be anonymous |
| is_guest | Is Guest | Boolean | The payment is made by a guest |
| is_submitted_to_hmrc_status | Is Submitted to HMRC Status | Boolean | If the payment has been submitted to HMRC |
| last_name | Last Name | String | Last name |
| parent_payment_transaction_guid | Parent Payment Transaction GUID | UUID | Parent payment transaction GUID |
| payment_date | Payment Date | Date | Date of payment |
| payment_method_reference | Payment Method Reference | String | Payment method reference |
| payment_provider_fee | Payment Provider Fee | Long | Payment provider fee |
| payment_system | Payment System | String | Payment system |
| payment_transaction_guid | Payment Transaction GUID | UUID | Payment transaction GUID |
| payment_type | Payment Type | String | Payment type, values can be: -Donation -Purchase -Ticket |
| platform_fee | Platform Fee | Long | Total fees charged |
| post_code | Post Code | String | Post code |
| product_type | Product Type | String | Product type, values can be: -EventRegistration -Fundraising |
| registrations_event_id | Registrations Event Id | Long | Registrations event Id |
| registrations_order_id | Registrations Order Id | Long | Registrations order Id |
| service_fee | Service Fee | Long | Enthuse platform fees |
| shared_campaign_guid | Shared Campaign GUID | UUID | Shared campaign GUID |
| supporter_id | Supporter Id | Long | Supporter Id |
| title | Title | String | Title |
| town | Town | String | Town |
| transaction_type | Transaction Type | String | Transaction type, values can be: -Payment -Refund |
| checkoutReferenceCode | Checkout Reference Code | String | Checkout Reference Code |
| purchaseInformation | Purchase Information | String | Purchase Information |
🚀 Return a list of payments within your account
/payments
Get a list of payment objects filterable by the attributes below:
| Key | Label | Type | Description |
|---|---|---|---|
| date_from | Date From | String | Start date from which to filter by |
| date_to | Date To | String | End date from which to filter by |
| first_name | First Name | String | First name associated with payment |
| last_name | Last Name | String | Last name associated with payment |
| limit | Limit | Integer | Number of records to be returned in the response |
| order_by | Order By | String | Used to order the response by chosen value, values can be: -FIRSTNAME -LASTNAME -TRANSACTIONTYPE -(Default) PAYMENTDATE |
| page | Page | Integer | The number of pages to skip before starting to collect the result set |
| type | Type | String | Transaction type, values can be: -PAYMENT -REFUND |
Sample Request
GET - http://dataapi.enthuse.com/payments/access_token=rR5_kQN_TVZMwqz4tyc8vzJ0ltc
&date_from=2020-02-25%2000%3A00%3A00
&date_to=2020-02-25%2000%3A00%3A00
&first_name=Shaun
&last_name=Reid
&limit=25
&order_by=firstname
&page=1
&type=PaymentSample Responses:
200 - OK call was successful and returned data
"paymentList": [
{
"payment_transaction_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"charity_account_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"company_account_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shared_campaign_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"registrations_event_id": 0,
"registrations_order_id": 0,
"fundraise_event_page_id": 0,
"fundraise_checkout_id": 0,
"fundraise_payment_id": 0,
"payment_method_reference": "string",
"payment_system": "string",
"first_name": "string",
"last_name": "string",
"transaction_type": "string",
"product_type": "string",
"payment_date": "2022-08-30T13:01:26.630Z",
"fundraise_page_or_team_page_ids": [
0
],
"payment_type": "string",
"currency": "string",
"platform_fee": 0,
"gift_aid_fee": 0,
"service_fee": 0,
"payment_provider_fee": 0,
"amount_without_fees": 0,
"amount_with_fees": 0,
"gift_aid_amount": 0,
"gifting_amount": 0,
"donor_fee_covered_amount": 0,
"fee_model": "string",
"is_submitted_to_hmrc_status": true,
"fundraise_schedule_id": 0,
"parent_payment_transaction_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"title": "string",
"house_name": "string",
"address_line_1": "string",
"address_line_2": "string",
"town": "string",
"post_code": "string",
"country_code": "string",
"supporter_id": 0,
"is_guest": true,
"is_anonymous": true,
"donation_message": "string",
"email": "string",
"checkoutReferenceCode": "string",
"purchaseInformation": "string"
}
]401 - Access token has expired or is incorrect
{
"message": "Unauthorized.",
"status": 401
}403 - The account linked to the token does not match the account of the records attempting to retrieve
{
"message": "Forbidden.",
"status": 403
}404 - Call authenticated but no records match the searched criteria
{
"message": "No records found.",
"status": 404
}500 - Error occurred within Service, data could not be returned
{
"message": "Internal Server Error.",
"status": 500
}🚀 Retrieves an existing payment record
Get a payment object filterable by a known 'payment_guid'.
| Key | Label | Type | Description |
|---|---|---|---|
| payment_guid | Payment GUID | UUID | Payment GUID |
Sample Request
GET - http://dataapi.enthuse.com/payments/00000000-0000-0000-0000-000000000000/?access_token=rR5_kQN_TVZMwqz4tyc8vzJ0ltcSample Responses
200 - OK call was successful and returned data
{
"payment_transaction_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"charity_account_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"company_account_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shared_campaign_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"registrations_event_id": 0,
"registrations_order_id": 0,
"fundraise_event_page_id": 0,
"fundraise_checkout_id": 0,
"fundraise_payment_id": 0,
"payment_method_reference": "string",
"payment_system": "string",
"first_name": "string",
"last_name": "string",
"transaction_type": "string",
"product_type": "string",
"payment_date": "2022-08-30T13:02:25.169Z",
"fundraise_page_or_team_page_ids": [
0
],
"payment_type": "string",
"currency": "string",
"platform_fee": 0,
"gift_aid_fee": 0,
"service_fee": 0,
"payment_provider_fee": 0,
"amount_without_fees": 0,
"amount_with_fees": 0,
"gift_aid_amount": 0,
"gifting_amount": 0,
"donor_fee_covered_amount": 0,
"fee_model": "string",
"is_submitted_to_hmrc_status": true,
"fundraise_schedule_id": 0,
"parent_payment_transaction_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"title": "string",
"house_name": "string",
"address_line_1": "string",
"address_line_2": "string",
"town": "string",
"post_code": "string",
"country_code": "string",
"supporter_id": 0,
"is_guest": true,
"is_anonymous": true,
"donation_message": "string",
"email": "string",
"checkoutReferenceCode": "string",
"purchaseInformation": "string"
}401 - Access token has expired or is incorrect
{
"message": "Unauthorized.",
"status": 401
}403 - The account linked to the token does not match the account of the records attempting to retrieve
{
"message": "Forbidden.",
"status": 403
}404 - Call authenticated but no records match the searched criteria
{
"message": "No records found.",
"status": 404
}500 - Error occurred within Service, data could not be returned
{
"message": "Internal Server Error.",
"status": 500
}Updated 24 days ago