Overview
This article lists the field mappings used by the Payments2Us integration when creating Gift Transactions 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_gift_transaction_post.htm
This help article is up to date for the 10.6 version of Payments2Us
Top-Level Gift Fields
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
amount |
Payment_Txn__c.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. |
receivedDate |
Prefer Payment_Txn__c.AAkPay__Bank_Deposit_Date__c; else Payment_Txn__c.AAkPay__Transaction_Date__c; else Today's Date
|
|
donorCoverAmount |
Payment_Txn__c.AAkPay__Surcharge__c
|
|
transactionStatus |
From Payment_Txn__c.AAkPay__Status__c + Payment_Txn__c.AAkPay__Banked_Payment__c
|
If Status == Direct Debit Processing ⇒ Pending; else if Banked Payment == YES ⇒ Paid; else Unpaid. |
commitmentId |
Payment_Txn__c.AAkPay__Gift_Commitment_Id__c
|
|
paymentIdentifier |
Payment_Txn__c.AAkPay__dpsTxnRef__c (if set) else Payment_Txn__cAAkPay__Reference__c
|
|
gatewayTransactionFee |
Payment_Txn__c.AAkPay__Merchant_Fee__c
|
|
processorTransactionFee |
— | Not sent |
processorReference |
Payment_Txn__c.AAkPay__Reference__c
|
|
gatewayReference |
Payment_Txn__c.AAkPay__Payment_TXN_No__c
|
|
lastGatewayResponseCode |
Payment_Txn__c.AAkPay__Payment_Response_Text__c
|
|
lastGatewayErrorMessage |
Payment_Txn__c.AAkPay__Payment_Response_DESC__c
|
|
lastGatewayProcessedDateTime |
Payment_Txn__c.AAkPay__Payment_Success_Date_Time__c
|
Only if not empty. |
Campaign
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
campaign.id |
Payment_Txn__c.AAkPay__Campaign__c |
Outreach Source Code
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
outreachSourceCode.sourceCode |
Payment_Txn__c.AAkPay__OutReach_Source_Code__c
|
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
|
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'. |
Donor Custom Fields
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
donor.accountCustomFields[] |
paymentTxn like-to-like fields with Account object |
List of { fieldName, fieldValue }. Includes custom field on account and payment txn with same API name (Like-to-Like matching) |
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 |
Gift Transaction Custom Fields (Optional)
| Fundraising API (JSON) | Source (Payments2Us) | Rule / Notes |
|---|---|---|
giftTransactionCustomFields[] |
paymentTxn like-to-like fields with gift transaction object |
List of { fieldName, fieldValue }. Includes custom field on gift transaction and payment txn with same API name (Like-to-Like matching) |