Overview
This article lists the field mappings used by the Payments2Us integration when creating Gift Commitments via the Salesforce Fundraising Business Process API. Where logic or defaults are applied, they’re noted in the “Rule/Notes” column. Please refer to salesforce help article for fundrasing API JSON fields: https://developer.salesforce.com/docs/atlas.en-us.nonprofit_cloud.meta/nonprofit_cloud/connect_resources_commitments_post.htm
This help article is up to date for the 10.6 version of Payments2Us
Top-Level Fields
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
amount |
AAkPay__Donation_Amount__c |
|
currencyIsoCode |
Prefer Payment_Txn__c.AAkPay__Currency__c else merchantFacility.AAkPay__Currency__c
|
If both empty then sends current user's default currency. |
transactionPeriod |
Payment_Txn__c.AAkPay__Regular_Pymt_Freq__c |
Helper decides frequency (e.g., monthly, yearly). |
transactionInterval |
Payment_Txn__c.AAkPay__Pay_Frequency__c |
Helper decides interval (E.g., every 3 months.) |
transactionDay |
Payment_Txn__c.AAkPay__Regular_Pymt_Day__c |
Helper decides day( E.g., fifth of month). |
startDate |
If set AAkPay__Start_Date__c else AAkPay__Sign_Up_Date__c; else AAkPay__Transaction_Date__c; else System.today()
|
|
endDate |
AAkPay__EndDate__c |
Lookup Relationship fields on Payment Txn Object
Please refer to Lookup relationship between NPC and P2Us objects for more details on establishing the relationship between payment txn and non-profit cloud related objects
Campaign
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
campaign.id |
AAkPay__Campaign__c |
Outreach Source Code
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
outreachSourceCode.sourceCode |
AAkPay__OutReach_Source_Code__c |
Donor
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
donor.donorType |
Payment_Txn__c.AAkPay__Donation_By__c
|
If value is Individual or In Memory Of ⇒ individual; else organizational. |
donor.id |
Payment_Txn__c.AAkPay__Account__c
|
|
donor.organizationName |
Payment_Txn__c.AAkPay__Donation_By_Name__c
|
Only when donorType != 'individual'; otherwise empty string. |
donor.firstName |
Payment_Txn__c.AAkPay__FirstName__c
|
|
donor.lastName |
Payment_Txn__c.AAkPay__LastName__c
|
|
donor.phone |
Prefer Payment_Txn__c.AAkPay__MobilePhone__c else Payment_Txn__c.AAkPay__Phone__c
|
Picks Mobile if present/non-blank, otherwise Phone. |
donor.email |
Payment_Txn__c.AAkPay__Email__c
|
Donor Addresses (array)
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
donor.address[] (mailing) |
Payment_Txn__c.AAkPay__MailingStreet__c, Payment_Txn__c.AAkPay__MailingCity__c, Payment_Txn__c.AAkPay__MailingState__c, Payment_Txn__c.AAkPay__MailingPostalCode__c, Payment_Txn__c.AAkPay__MailingCountry__c
|
Included only if AAkPay__MailingStreet__c is non-blank. addressType = 'mailing'. |
donor.address[] (other) |
Payment_Txn__c.AAkPay__OtherStreet__c, Payment_Txn__c.AAkPay__OtherCity__c, Payment_Txn__c.AAkPay__OtherState__c, Payment_Txn__c.AAkPay__OtherPostalCode__c, Payment_Txn__c.AAkPay__OtherCountry__c
|
Included only if AAkPay__OtherStreet__c is non-blank. addressType = 'other'. |
Payment Instrument
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
paymentInstrument.type |
Payment_Txn__c.AAkPay__Method_of_Payment__c
|
If ApplePay / GooglePay / China UnionPay ⇒ send Credit Card; else send the method value. |
accountHolderName |
Payment_Txn__c.AAkPay__Payment_CC_Cardholder_Name__c
|
|
expiryMonth |
Payment_Txn__c.AAkPay__Payment_CC_Exp_Date_Month__c
|
|
expiryYear |
Payment_Txn__c.AAkPay__Payment_CC_Exp_Date_Year__c
|
|
last4 |
Prefer Payment_Txn__c.AAkPay__Payment_CC_No__c;else AAkPay__Recurring_Payment__c.Payment_Txn__c
|
|
cardBrand |
Payment_Txn__c.AAkPay__Payment_CC__c
|
|
digitalWalletProvider |
Payment_Txn__c.AAkPay__Method_of_Payment__c
|
Set to ApplePay or GooglePay if that’s the method; otherwise blank. |
bankAccountHolderType |
Literal 'primary'
|
Only sent if method is one of: ACH, eCheck, Direct Debit, Bank Transfer, PayID. |
bankAccountType |
Payment_Txn__c.AAkPay__Account_Type__c
|
Sent only for bank methods above. |
bankAccountNumber |
Payment_Txn__c.AAkPay__BSB_No__c + ' ' + Payment_Txn__c.AAkPay__Account_No__c + ' ' + Payment_Txn__cAAkPay__Account_Suffix__c
|
Concatenated; sent only for bank methods above. |
bankCode |
Payment_Txn__cAAkPay__Bank__c
|
Sent only for bank methods above. |
gatewayName |
merchantFacility.AAkPay__Payment_Gateway__c |
|
processorName |
merchantFacility.Name |
|
processorPaymentReference |
Payment_Txn__c.AAkPay__Reference__c
|
|
gatewayReference |
Payment_Txn__c.AAkPay__Payment_TXN_No__c
|
Designations (Optional)
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
designations[] |
paymentTxn.AAkPay__Gift_Designation__c OR paymentItem.AAkPay__Gift_Designation__c
|
Check Payments2Us Support for Gift Designation for further details |
First Transaction (Optional)
First transaction is included only when Payment_Txn__c.AAkPay__Banked_Payment__c = ‘YES’
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
firstTransaction.amount |
AAkPay__Donation_Amount__c |
|
firstTransaction.receivedDate |
Prefer AAkPay__Bank_Deposit_Date__c; else AAkPay__Transaction_Date__c; else System.today()
|
|
firstTransaction.donorCoverAmount |
AAkPay__Surcharge__c |
|
firstTransaction.transactionStatus |
Derived from AAkPay__Status__c and AAkPay__Banked_Payment__c
|
Same logic as Gift Transaction: Direct Debit ⇒ Pending; Banked = YES ⇒ Paid; else Unpaid. |
firstTransaction.gatewayTransactionFee |
AAkPay__Merchant_Fee__c |
|
firstTransaction.processorTransactionFee |
— | Not populated (commented). |
firstTransaction.processorReference |
AAkPay__dpsTxnRef__c (if set) else AAkPay__Reference__c
|
|
firstTransaction.gatewayReference |
AAkPay__Payment_TXN_No__c |
|
firstTransaction.lastGatewayResponseCode |
AAkPay__Payment_Response_Text__c |
|
firstTransaction.lastGatewayErrorMessage |
AAkPay__Payment_Response_DESC__c |
|
firstTransaction.lastGatewayProcessedDateTime |
AAkPay__Payment_Success_Date_Time__c |
Commitment Custom Fields (Optional)
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
giftCommitmentCustomFields[] |
paymentTxn like-to-like fields with gift commitment object |
List of { fieldName, fieldValue }. Included only if values exist. |
giftCommitmentScheduleCustomFields[] |
paymentTxn like-to-like fields with gift commitment schedule object |
List of { fieldName, fieldValue }. Included only if values exist. |
Like/Like Field Relationship
Please refer to How do the Like/Like field relationship work in Payments2Us for further details.