Usage of the Salesforce Fundraising Business Process API & Field Mappings
The Salesforce Fundraising Business Process API is a product provided by salesforce.org. We recommend the Salesforce documentation for more details.
- Field Mappings GiftCommitment for subscriptions created through the RaiseNow Hub
- Field Mappings GiftTransaction for payments created through the RaiseNow Hub
- Field Mappings GiftCommitment for transactions created through the legacy RaiseNow Manager
- Field Mappings GiftTransaction for transactions created through the legacy RaiseNow Manager
RaiseNow makes extensive use of the Fundraising Business Process API provided by Salesforce. Though the integration also uses the standard REST API to interact with Salesforce, important objects are created through this API to ensure compliance with the official interpretation of the data model. This has implications for the resulting implementation:
- Account deduplication is handled by the fundraising business process API.
- Field mappings for GiftCommitments are largely handled by the Fundraising Business Process API.
- Field mappings for GiftTransactions are largely handled by the Fundraising Business Process API.
With regard to the below fields mappings, please note that setting most of these fields is optional in the RaiseNow API. Client applications have a lot of freedom to set fields in the RaiseNow API, and though we work with partners to ensure as much compliance as possible, it is the responsibility of the partner to set these fields accordingly.
Field Mappings GiftCommitment for subscriptions created through the RaiseNow Hub
Introduced in version | RaiseNow Hub | Salesforce Fundraising BP API | Note |
---|---|---|---|
1.0.0 | subscription::currency | currencyIsoCode | 3-letter ISO code |
1.0.0 | subscription::amount | amount | unit conversion applied |
1.0.0 | subscription.recurring_interval | transactionPeriod | unit conversion applied |
1.0.0 | subscription::recurring_interval | transactionInterval | unit conversion applied |
1.0.0 | subscription::recurring_interval | transactionDay | unit conversion applied |
1.0.0 | subscription::created | startDate | unit conversion applied |
1.0.0 | subscription::planned_end | endDate | unit conversion applied |
1.0.0 | subscription::custom_parameters::campaign_id | campaign::id | Mappings stored in Salesforce campaign-map will be applied |
1.0.0 | subscription::custom_parameters::campaign_subid | outreachSourceCode::id | Mappings stored in Salesforce outreach-source-code-map will be applied |
1.0.0 | subscription::custom_parameters::is_company_donation | donor::donorType | If the RaiseNow value is false, a Person Account will be created in Salesforce |
1.0.0 | supporter::crm_account_id | donor::id | |
1.0.0 | supporter::legal_entity | donor::organizationName | |
1.0.0 | supporter::first_name | donor::firstName | |
1.0.0 | supporter::last_name | donor::lastName | |
1.0.0 | supporter::phone | donor::phone | |
1.0.0 | supporter::email | donor::email | |
1.0.0 | address-type::value | donor::address::type | Controlled through address-type configuration record in RaiseNowNPOKit__Configuration__c |
1.0.0 | supporter::street | donor::address::street | |
1.0.0 | supporter::city | donor::address::city | |
1.0.0 | supporter::postal_code | donor::address::postalCode | |
1.0.0 | supporter::country | donor::address::country | |
1.0.0 | supporter::uuid | donor::accountCustomFields::RaiseNowNPOKit__SupporterUuid__c | |
1.0.0 | supporter::address_addendum | donor::accountCustomFields::RaiseNowNPOKit__SupporterAddressAddendum__c | |
1.0.0 | supporter::post_office_box | donor::accountCustomFields::RaiseNowNPOKit__SupporterPostOfficeBox__c | |
1.0.0 | supporter::locale | donor::accountCustomFields::RaiseNowNPOKit__SupporterLocale__c | |
1.0.0 | supporter::opt_in_email | donor::accountCustomFields::RaiseNowNPOKit__OptInEmail__c | |
1.0.0 | payment_source::expiry_month | paymentInstrument::expiryMonth | unit conversion applied |
1.0.0 | payment_source::expiry_year | paymentInstrument::expiryYear | unit conversion applied |
1.0.0 | subscription::payment_method::payment_info::number | paymentInstrument::last4 | defaults to xxxx |
1.0.0 | payment_source::brand_code | paymentInstrument::cardBrand | |
1.0.0 | na | paymentInstrument::processorName | Always RaiseNow |
1.0.0 | payment_source::metadata::payment_info::wallet_type | paymentInstrument::digitalWalletProvider | |
1.0.0 | payment_source::uuid | paymentInstrument::processorPaymentReference | |
1.0.0 | payment_source::payment_provider | paymentInstrument::gatewayName | |
1.0.0 | payment_source::provider_payment_source_id | paymentInstrument::gatewayReference | |
1.0.0 | payment_source::payment_method | paymentInstrument::type | Mappings stored in Salesforce payment-instrument-map will be applied |
1.0.0 | subscription::raisenow_parameters::integration::message | giftCommitmentCustomFields::RaiseNowNPOKit__DonorMessage__c | |
1.0.0 | subscription::raisenow_parameters::integration::donation_receipt_requested | giftCommitmentCustomFields::RaiseNowNPOKit__DonationReceiptRequested__c | |
1.0.0 | subscription::raisenow_parameters::fundraising_automation::crm_fundraiser_identifier | giftCommitmentCustomFields::RaiseNowNPOKit__CrmFundraiserIdentifier__c | |
1.0.0 | subscription::raisenow_parameters::fundraising_automation::marketing_location | giftCommitmentCustomFields::RaiseNowNPOKit__MarketingLocation__c | |
1.0.0 | subscription::raisenow_parameters::analytics::channel | giftCommitmentCustomFields::RaiseNowNPOKit__AnalyticsChannel__c | |
1.0.0 | subscription::raisenow_parameters::analytics::preselected_amount | giftCommitmentCustomFields::RaiseNowNPOKit__AnalyticsPreselectedAmount__c | |
1.0.0 | subscription::raisenow_parameters::analytics::suggested_amounts | giftCommitmentCustomFields::RaiseNowNPOKit__AnalyticssuggestedAmounts__c | |
1.0.0 | subscription::raisenow_parameters::subscription::product::source_url | giftCommitmentCustomFields::RaiseNowNPOKit__ProductSourceUrl__c | |
1.0.0 | subscription::raisenow_parameters::solution::name | giftCommitmentCustomFields::RaiseNowNPOKit__SolutionName__c | |
1.0.0 | subscription::raisenow_parameters::solution::uuid | giftCommitmentCustomFields::RaiseNowNPOKit__SolutionUuid__c | |
1.0.0 | https://hub.raisenow.com/#/subscriptions/{{subscription::uuid}} | giftCommitmentCustomFields::RaiseNowNPOKit__SubscriptionLink__c | |
1.0.0 | subscription::raisenow_parameters::solution::product::name | giftCommitmentCustomFields::RaiseNowNPOKit__ProductName__c | |
1.0.0 | subscription::raisenow_parameters::solution::fundraising_automation::attachment | giftCommitmentCustomFields::RaiseNowNPOKit__Attachment__c | |
1.0.0 | subscription::custom_parameters::cover_transaction_fee | giftCommitmentCustomFields::RaiseNowNPOKit__CoverTransactionFee__c | |
1.0.0 | subscription::raisenow_parameters::cover_fee::amount | giftCommitmentCustomFields::RaiseNowNPOKit__CoverTransactionFeeAmount__c | unit conversion applied |
1.0.0 | subscription::account_uuid | giftCommitmentCustomFields::RaiseNowNPOKit__AccountUuid__c | |
1.0.0 | subscription::uuid | giftCommitmentCustomFields::RaiseNowNPOKit__SubscriptionUuid__c |
Field Mappings GiftTransaction for payments created through the RaiseNow Hub
Introduced in version | RaiseNow Hub | Salesforce Fundraising BP API | Note |
---|---|---|---|
1.0.0 | payment::last_status | transactionStatus | Mappings stored in Salesforce cpayment-instrument-map will be applied |
1.0.0 | payment::last_status_timestamp | receivedDate | Unit conversion applied |
1.0.0 | payment::currency_identifier | currencyIsoCode | |
1.0.0 | payment::aisenow_parameters::fundraising_automation::crm_commitment_identifier | commitmentId | Optional parameter to automatically map a payment to the designated GiftCommiment |
1.0.0 | payment::amount | amount | Unit conversion applied |
1.0.0 | payment::raisenow_parameters::cover_fee::amount | donorCoverAmount | Unit conversion applied |
1.0.0 | payment::uuid | processorReference | |
1.0.0 | payment::::pricing::fees | processorTransactionFee | Unit conversion applied |
1.0.0 | payment::provider_payment_id | gatewayReference | |
1.0.0 | payment::metadata::adapter::payment:fee_amount | gatewayTransactionFee | Unit conversion applied |
1.0.0 | payment::raisenow_parameters::reference_codes::qr_reference | paymentIdentifier | |
1.0.0 | payment::custom_parameters::campaign_id | campaign::id | Mappings stored in Salesforce campaign-map will be applied |
1.0.0 | payment::custom_parameters::campaign_subid | outreachSourceCode::id | Mappings stored in Salesforce outreach-source-code-map will be applied |
1.0.0 | subscription::custom_parameters::is_company_donation | donor::donorType | If the RaiseNow value is false, a Person Account will be created in Salesforce |
1.0.0 | supporter::crm_account_id | donor::id | |
1.0.0 | supporter::legal_entity | donor::organizationName | |
1.0.0 | supporter::first_name | donor::firstName | |
1.0.0 | supporter::last_name | donor::lastName | |
1.0.0 | supporter::phone | donor::phone | |
1.0.0 | supporter::email | donor::email | |
1.0.0 | address-type::value | donor::address::type | Controlled through address-type configuration record in RaiseNowNPOKit__Configuration__c |
1.0.0 | supporter::street | donor::address::street | |
1.0.0 | supporter::city | donor::address::city | |
1.0.0 | supporter::postal_code | donor::address::postalCode | |
1.0.0 | supporter::country | donor::address::country | |
1.0.0 | supporter::uuid | donor::accountCustomFields::SupporterUuid__c | |
1.0.0 | supporter::address_addendum | donor::accountCustomFields::SupporterAddressAddendum__c | |
1.0.0 | supporter::post_office_box | donor::accountCustomFields::SupporterPostOfficeBox__c | |
1.0.0 | supporter::locale | donor::accountCustomFields::SupporterLocale__c | |
1.0.0 | supporter::opt_in_email | donor::accountCustomFields::OptInEmail__c | |
1.0.0 | payment::payment_method | paymentInstrument::type | Mappings stored in Salesforce payment-instrument-map will be applied |
1.0.0 | payment::metadata::request::payment_info::cardholder | paymentInstrument::accountHolderName | |
1.0.0 | payment::metadata::request::payment_info::expiry_month | paymentInstrument::expiryMonth | |
1.0.0 | payment::metadata::request::payment_info::expiry_year | paymentInstrument::expiryYear | |
1.0.0 | payment::metadata::request::payment_info::number | paymentInstrument::last4 | |
1.0.0 | payment::brand_code | paymentInstrument::cardBrand | |
1.0.0 | payment::wallet_type | paymentInstrument::digitalWalletProvider | |
1.0.0 | RaiseNow | paymentInstrument::processorName | |
1.0.0 | payment::uuid | paymentInstrument::processorPaymentReference | |
1.0.0 | payment::payment_provider | paymentInstrument::gatewayName | |
1.0.0 | payment::provider_payment_id | paymentInstrument::gatewayReference | |
1.0.0 | payment::raisenow_parameters::integration::message | giftTransactionCustomFields::RaiseNowNPOKit__DonorMessage__c | |
1.0.0 | payment::raisenow_parameters::integration::donation_receipt_requested | giftTransactionCustomFields::DonationReceiptRequested__c | |
1.0.0 | payment::raisenow_parameters::fundraising_automation::crm_fundraiser_identifier | giftTransactionCustomFields::RaiseNowNPOKit__CrmFundraiserIdentifier__c | |
1.0.0 | payment::raisenow_parameters::fundraising_automation::marketing_location | giftTransactionCustomFields::RaiseNowNPOKit__MarketingLocation__c | |
1.0.0 | payment::raisenow_parameters::analytics::channel | giftTransactionCustomFields::RaiseNowNPOKit__AnalyticsChannel__c | |
1.0.0 | payment::raisenow_parameters::analytics::preselected_amount | giftTransactionCustomFields::RaiseNowNPOKit__AnalyticsPreselectedAmount__c | |
1.0.0 | payment::raisenow_parameters::analytics::suggested_amounts | giftTransactionCustomFields::RaiseNowNPOKit__AnalyticsSuggestedAmounts__c | |
1.0.0 | payment::raisenow_parameters::product::source_url | giftTransactionCustomFields::RaiseNowNPOKit__ProductSourceUrl__c | |
1.0.0 | payment::raisenow_parameters::solution::name | giftTransactionCustomFields::RaiseNowNPOKit__SolutionName__c | |
1.0.0 | payment::raisenow_parameters::solution::uuid | giftTransactionCustomFields::RaiseNowNPOKit__SolutionUuid__c | |
1.0.0 | https://hub.raisenow.com/#/transactions/{{payment_uuid}} | giftTransactionCustomFields::RaiseNowNPOKit__TransactionLink__c | |
1.0.0 | payment::raisenow_parameters::product::name | giftTransactionCustomFields::RaiseNowNPOKit__ProductName__c | |
1.0.0 | payment::raisenow_parameters::fundraising_automation::attachment | giftTransactionCustomFields::RaiseNowNPOKit__Attachment__c | |
1.0.0 | payment::custom_parameters::cover_transaction_fee | giftTransactionCustomFields::RaiseNowNPOKit__CoverTransactionFee__c | |
1.0.0 | payment::account_uuid | giftTransactionCustomFields::RaiseNowNPOKit__AccountUuid__c |
Field Mappings GiftCommitment for transactions created through the legacy RaiseNow Manager
Introduced in version | RaiseNow Manager Transaction | Salesforce Fundraising BP API | Note |
---|---|---|---|
1.1.0 | currency | currencyIsoCode | 3-letter ISO code |
1.1.0 | amount | amount | unit conversion applied |
1.1.0 | recurring_interval | transactionPeriod | unit conversion applied |
1.1.0 | recurring_interval | transactionInterval | unit conversion applied |
1.1.0 | recurring_interval | transactionDay | unit conversion applied |
1.1.0 | created | startDate | unit conversion applied |
1.1.0 | stored_campaign_id | campaign::id | Mappings stored in Salesforce campaign-map will be applied |
1.1.0 | stored_campaign_subid | outreachSourceCode::id | Mappings stored in Salesforce outreach-source-code-map will be applied |
1.1.0 | stored_customer_company | donor::donorType | If this property is set, a Business Account will be created in Salesforce |
1.1.0 | stored_crm_account_identifier | donor::id | |
1.1.0 | stored_customer_company | donor::organizationName | |
1.1.0 | stored_customer_firstname | donor::firstName | |
1.1.0 | stored_customer_lastname | donor::lastName | |
1.1.0 | stored_customer_mobile_phone | donor::phone | |
1.1.0 | stored_customer_email | donor::email | |
1.1.0 | address-type::value | donor::address::type | Controlled through address-type configuration record in RaiseNowNPOKit__Configuration__c |
1.1.0 | stored_customer_street + stored_customer_street_number | donor::address::street | |
1.1.0 | stored_customer_city | donor::address::city | |
1.1.0 | stored_customer_zip_code | donor::address::postalCode | |
1.1.0 | stored_customer_country | donor::address::country | |
1.1.0 | stored_customer_language | donor::accountCustomFields::RaiseNowNPOKit__SupporterLocale__c | |
1.1.0 | stored_customer_email_permission | donor::accountCustomFields::RaiseNowNPOKit__OptInEmail__c | |
1.1.0 | na | paymentInstrument::processorName | Always RaiseNow |
1.1.0 | epp_transaction_id | paymentInstrument::processorPaymentReference | |
1.1.0 | payment_provider | paymentInstrument::gatewayName | |
1.1.0 | payment_method | paymentInstrument::type | Mappings stored in Salesforce payment-instrument-map will be applied |
1.1.0 | bank_name | paymentInstrument::bankName | |
1.1.0 | iban | paymentInstrument::bankAccountNumber | |
1.1.0 | stored_customer_salutation | giftCommitmentCustomFields::RaiseNowNPOKit__SupporterSalutation__c | |
1.1.0 | stored_customer_message | giftCommitmentCustomFields::RaiseNowNPOKit__DonorMessage__c | |
1.1.0 | stored_customer_donation_receipt | giftCommitmentCustomFields::RaiseNowNPOKit__DonationReceiptRequested__c | |
1.1.0 | stored_crm_fundraiser_id | giftCommitmentCustomFields::RaiseNowNPOKit__CrmFundraiserIdentifier__c | |
1.1.0 | stored_marketing_location_identifier | giftCommitmentCustomFields::RaiseNowNPOKit__MarketingLocation__c | |
1.1.0 | subscription::raisenow_parameters::analytics::channel | giftCommitmentCustomFields::RaiseNowNPOKit__AnalyticsChannel__c | |
1.1.0 | stored_rnw_analytics_preselected_amount | giftCommitmentCustomFields::RaiseNowNPOKit__AnalyticsPreselectedAmount__c | |
1.1.0 | stored_rnw_analytics_suggested_amounts | giftCommitmentCustomFields::RaiseNowNPOKit__AnalyticssuggestedAmounts__c | |
1.1.0 | stored_rnw_source_url | giftCommitmentCustomFields::RaiseNowNPOKit__ProductSourceUrl__c | |
1.1.0 | https://manage.raisenow.com/epayment/transactions/{{epp_transaction_id}} | giftCommitmentCustomFields::RaiseNowNPOKit__SubscriptionLink__c | |
1.1.0 | stored_rnw_product_name | giftCommitmentCustomFields::RaiseNowNPOKit__ProductName__c | |
1.1.0 | stored_crm_attachment | giftCommitmentCustomFields::RaiseNowNPOKit__Attachment__c | |
1.1.0 | stored_cover_transaction_fee | giftCommitmentCustomFields::RaiseNowNPOKit__CoverTransactionFee__c | |
1.1.0 | stored_rnw_cover_fee_amount | giftCommitmentCustomFields::RaiseNowNPOKit__CoverTransactionFeeAmount__c | unit conversion applied |
1.1.0 | merchant_config | giftCommitmentCustomFields::RaiseNowNPOKit__AccountUuid__c | |
1.1.0 | epp_transaction_id | giftCommitmentCustomFields::RaiseNowNPOKit__SubscriptionUuid__c | |
1.1.0 | chqr_refno | giftCommitmentCustomFields::RaiseNowNPOKit__PaymentRequestReference__c |
Field Mappings GiftTransaction for transactions created through the legacy RaiseNow Manager
Introduced in version | RaiseNow Hub | Salesforce Fundraising BP API | Note |
---|---|---|---|
1.1.0 | status | transactionStatus | Mappings stored in Salesforce cpayment-instrument-map will be applied |
1.1.0 | created | receivedDate | Unit conversion applied |
1.1.0 | currency | currencyIsoCode | |
1.1.0 | stored_crm_commitment_identifier | commitmentId | Optional parameter to automatically map a payment to the designated GiftCommiment |
1.1.0 | amount | amount | Unit conversion applied |
1.1.0 | stored_rnw_cover_fee_amount | donorCoverAmount | Unit conversion applied |
1.1.0 | epp_transaction_id | processorReference | |
1.1.0 | payment::::pricing::fees | processorTransactionFee | Unit conversion applied |
1.1.0 | datatrans_upptransaction_id | stripe_payment_intent_id | paypal_transaction_id | gatewayReference | |
1.1.0 | paypal_transaction_fee_amount | gatewayTransactionFee | Fees other than PayPal may be added in subsequent operations through the RaiseNow reconciliation licensing option |
1.1.0 | stored_campaign_id | campaign::id | Mappings stored in Salesforce campaign-map will be applied |
1.1.0 | stored_campaign_subid | outreachSourceCode::id | Mappings stored in Salesforce outreach-source-code-map will be applied |
1.1.0 | stored_customer_company | donor::donorType | If a value is set, a Business Account will be created |
1.1.0 | stored_crm_account_identifier | donor::id | |
1.1.0 | stored_customer_company | donor::organizationName | |
1.1.0 | stored_customer_firstname | donor::firstName | |
1.1.0 | stored_customer_lastname | donor::lastName | |
1.1.0 | stored_customer_mobile_phone | donor::phone | |
1.1.0 | stored_customer_email | donor::email | |
1.1.0 | address-type::value | donor::address::type | Controlled through address-type configuration record in RaiseNowNPOKit__Configuration__c |
1.1.0 | stored_customer_street + stored_customer_street_number | donor::address::street | |
1.1.0 | stored_customer_city | donor::address::city | |
1.1.0 | stored_customer_state | donor::address::state | |
1.1.0 | stored_customer_zip_code | donor::address::postalCode | |
1.1.0 | stored_customer_country | donor::address::country | |
1.1.0 | stored_customer_address_addendum | donor::accountCustomFields::RaiseNowNPOKit__SupporterAddressAddendum__c | |
1.1.0 | stored_customer_pobox | donor::accountCustomFields::RaiseNowNPOKit__SupporterPostOfficeBox__c | |
1.1.0 | stored_customer_language | donor::accountCustomFields::RaiseNowNPOKit__SupporterLocale__c | |
1.1.0 | stored_customer_email_permission | donor::accountCustomFields::RaiseNowNPOKit__OptInEmail__c | |
1.1.0 | stored_customer_salutation | donor::accountCustomFields::SupporterSalutation__c | |
1.1.0 | payment_method | paymentInstrument::type | Mappings stored in Salesforce payment-instrument-map will be applied |
1.1.0 | card_holder_name | paymentInstrument::accountHolderName | |
1.1.0 | expy | paymentInstrument::expiryMonth | |
1.1.0 | expm | paymentInstrument::expiryYear | |
1.1.0 | masked_cc | paymentInstrument::last4 | |
1.1.0 | n/a | paymentInstrument::processorName | Always set to RaiseNow |
1.1.0 | bank_name | paymentInstrument::bankName | |
1.1.0 | iban | paymentInstrument::bankAccountNumber | |
1.1.0 | epp_transaction_id | paymentInstrument::processorPaymentReference | |
1.1.0 | payment::uuid | paymentInstrument::processorPaymentReference | |
1.1.0 | payment_provider | paymentInstrument::gatewayName | |
1.1.0 | datatrans_upptransaction_id | stripe_payment_intent_id | paypal_transaction_id | paymentInstrument::gatewayReference | |
1.1.0 | payment_method | stripe_source_brand | paymentInstrument::cardBrand | |
1.1.0 | stored_customer_message | giftTransactionCustomFields::RaiseNowNPOKit__DonorMessage__c | |
1.1.0 | stored_customer_donation_receipt | giftTransactionCustomFields::RaiseNowNPOKit__DonationReceiptRequested__c | |
1.1.0 | stored_crm_fundraiser_id | giftTransactionCustomFields::RaiseNowNPOKit__CrmFundraiserIdentifier__c | |
1.1.0 | stored_marketing_location_identifier | giftTransactionCustomFields::RaiseNowNPOKit__MarketingLocation__c | |
1.1.0 | stored_rnw_analytics_preselected_amount | giftTransactionCustomFields::RaiseNowNPOKit__AnalyticsPreselectedAmount__c | |
1.1.0 | stored_rnw_analytics_suggested_amounts | giftTransactionCustomFields::RaiseNowNPOKit__AnalyticsSuggestedAmounts__c | |
1.1.0 | stored_rnw_source_url | giftTransactionCustomFields::RaiseNowNPOKit__ProductSourceUrl__c | |
1.1.0 | https://manage.raisenow.com/epayment/transactions/{{epp_transaction_id}} | giftTransactionCustomFields::RaiseNowNPOKit__TransactionLink__c | |
1.1.0 | stored_rnw_product_name | giftTransactionCustomFields::RaiseNowNPOKit__ProductName__c | |
1.1.0 | stored_crm_attachment | giftTransactionCustomFields::RaiseNowNPOKit__Attachment__c | |
1.1.0 | stored_cover_transaction_fee | giftTransactionCustomFields::RaiseNowNPOKit__CoverTransactionFee__c | |
1.1.0 | merchant_config | giftTransactionCustomFields::RaiseNowNPOKit__AccountUuid__c | |
1.1.0 | chqr_refno | PaymentRequestReference__c |