Contact with Transaction
contact_with_transaction (example on postman)
Use this format for importing contact and transaction data in one record into a Kindful Organization account
Body Params
The id field is an (API) application-specific field and is used to prevent duplicates when multiple applications are connected to the same Organization account.
For more information about creating and updating records, please see Intro to Record Matching
If id is not provided then:
To remove duplicates, we match based upon an exact match of firstname + lastname + email or company_name + email.
This is not ideal, so specify an identifier if at all possible.
If a transaction_id isn't provided then we will generate a guid for it, to be used internally.
id
No
Contact ID
123ABC
String
first_name
Yes unless company_name is populated
last_name
Yes unless company_name is populated
String
company_name
Yes unless first and last name are populated
Use company_name if the contact is not an individual but a company. First and last name can be blank in this case, if you specify First and Last Name, this will be the Primary Contact Name on the Organization Record.
String
employer
No
Company that individual works for
No
valid email address
String
alt_email
No
valid email address
String
addr1
No
String
addr2
No
String
city
No
String
state
No
state abbreviation TN,NY
String
postal
No
valid country postal code. 5 digits if United States
String
country
No
United States
http://www.worldatlas.com/aatlas/ctycodes.htm the full name from the list above. the A2 (ISO) code also can be used.
title
No
Mr, Ms, Dr
String
birthday
No
yyyy/mm/dd
yyyy-mm-dd
String
primary_phone
No
digits or with () - -
String
alt_phone
No
String
fax_phone
No
String
spouse_first
No
String
spouse_last
No
String
gender
No
Male = M, Female=F, Unknown=U. if blank the gender will be guessed based on name
M
M/F/U
stripe_customer_id
No
cus_1234
authorize_customer_id
No
customer id in authorize.net's CIM
paypal_payer_id
No
payer_id from Paypal Basic
created_at
No
integer for unix timestamp (jan 1 1970) or string in UTC of ISO8601 or RFC3339 format
updated_at
No
Yes if action = update and you are updating that contact
integer for unix timestamp (jan 1 1970) or string in UTC of ISO8601 or RFC3339 format
transaction_id
No
234DEF
amount_in_cents
Yes
this is in cents. so 500 = $5.00
500
Must be > 0
currency
No
lowercase
usd
transaction_time
Yes
integer for unix timestamp (jan 1 1970) or string in UTC of ISO8601 or RFC3339 format
1444762572
2015-10-13 18:56:12 UTC
2015-10-13T18:56:12+00:00
transaction_updated_at
No
Yes if action = update
integer for unix timestamp (jan 1 1970) or string in UTC of ISO8601 or RFC3339 format
If not specified it will be set to transaction_time.
This field is required if an update is being performed
campaign
No
event or category of transaction. Defaults to Partner Name
Gala, General, Mail Appeal
String
campaign_id
No
campaign identifier to minimize duplicates
String
parent_campaign
No
parent_campaign is only needed if you organize your campaigns in a hierarchy (for example, you organize your campaigns into categories). If parent_campaign is provided, it will be the parent of the provided campaign.
Events, Galas
String
parent_campaign_id
No
String
fund
Yes (if unknown, pass 'General')
larger group or fund of where the money ends up
https://support.kindful.com/hc/en-us/articles/217204108
General, Restricted, Africa
String
fund_id
Yes (if unknown, pass '1')
fund identifier to minimize duplicates
String
acknowledged
No
used to determine if additional communication has occurred in addition to a transaction receipt email
Y,N,0,1,true,false
boolean
transaction_note
No
text details about transaction
Text (max 2000 characters)
stripe_charge_id
No
Stripe charge token for identifying charge
ch_12345
String
authorize_transaction_id
No
Authorize Transaction Id
String
paypal_transaction_id
No
Paypal Transaction Id
String
transaction_type
No
cash
check
consolidated
credit
eft
offline_recurring
one_time_transaction
paypal
payroll_deduction
shopify
square
stock
check
String
check_num
No
number on the check
card_type
No
credit card type. defaults to blank. if card_type is provided the transaction_type will be defaulted to "credit"
mastercard, master card,visa,discover,amex,american express,
String
non_tax_deductible_amount_in_cents
No
assumed to be zero
Integer
is_donation
No
assumed 'Yes' unless specified, this field affects verbiage on the activity record in Kindful. It has no bearing on the deductibility of transactions
Y,N,0,1,true,false
Boolean
cause
No
General
String
cause_id
No
12345
String
team
No
General
String
team_id
No
12345
String
team_member_first_name
No
John
String
team_member_last_name
No
Smith
String
team_member_id
No
12345
String
occupation
No
Dentist
String
retired_or_not_employed
No
True/False or Yes/No
False
To mark a transaction as refunded:
• Send the same transaction_id as an UPDATE
• Pass a negative transaction amount equivalent to the orginal value in cents. For example amount_in_cents: -500