Donation Push API¶

Order¶

Required fields:

• amount
• card_num, a dummy cc number, the last four digits are saved to core_order.card_num_last_four
• card_code, literal string "007"
• exp_date_month, 2 digit month
• exp_date_year, 4 digit year

Amount is required in the order or in a list of orderdetails. The amounts in both will be summed for you to create the resulting total in Order. Amounts should be supplied as a string like "10.00", not a bare integer or float value.

The card_num and card_code are required.

The "card_num" value can not be empty, but it shouldn't be a valid credit card number. The last four characters of the value you send will be saved in the core_order table, so you can send the full card number (but don't do that), or just the last four digits, or a placeholder value such as "4111111111111111".

The value for card_code must be 007, unless ActionKit support has told you otherwise. See Donation Action Requests for more details.

Optional fields:

• orderdetails, an array of order items and amounts

[ { "candidate": { "name": "Big Time Candidate" }, "amount": "13" },

{ "candidate": { "name": "Smaller Time Cnadidate" }, "amount: "5.00" } ]

We currently only support Candidates. The candidate dictionary should contain a name or an id field, e.g. { "id": 2 }. ActionKit will never update the name of a candidate from a request to /donationpush/

• created_at, timestamp for the order and action will be set, and for the user if this action creates a new one
• donation_date, timestamp for order will be set

You can use the created_at field to date the order and action. It will also date the user if the action creates a new user. Timestamps must be in Greenwich Mean Time (GMT) time zone. You can use the field donation_date to date only the order.

• payment_account, the name of a configured Import Stub payment account.

Import Stubs are payment accounts that do no actual processing. ActionKit support will add Import Stub payment accounts for you. You can use the stubs to add donations to DonationPages, without processing the donations in ActionKit.

Sending a payment_account with your request will override the payment_account of the DonationPage configured in ActionKit.

• donation_import_id, a unique ID that ActionKit will only import once

If you provide donation_import_id, ActionKit will check the database for orders with the same ID and return a 409 CONFLICT if one is found. The headers will include a Location of the existing order.

• currency, a three letter ISO currency code

If you provide a currency, ActionKit will save it to the order (and recurring order), and save a converted amount (using current exchange rates).

• donation_currency, a three letter ISO currency code - DEPRECATED
• total_converted, an amount in USD of the donation

If you send donation_currency with the request (as part of the order), ActionKit will save the Order with this currency in the currency column, and set total_converted to a converted USD amount. You can send total_converted if you wish to directly set the converted amount.

• trans_id, the ID of the transaction in the remote system

User¶

Required fields:

• email or akid

Optional fields:

• first_name
• last_name
• address1
• city
• country
• state / region
• zip / postal
• source

At least one of "email" or "akid" is required. The "name" field is required unless a user with the given email address already exists. The address-related fields are optional and may be skipped if you want to avoid overwriting the user's current location.

• fields

A list of custom user fields and values to assign to the user.

"fields': { "favorite_color": "#333300",

"favorite_flavor": ["Blueberry", "Vanilla"] }

ActionKit will remove the user prefix if you include it on the field names, will replace the value(s) of individual existing user fields, but will not replace the full set of existing fields.

• lists

A list of dictionaries describing Lists to which the user should be subscribed. You can send lists in two formats, a dictionary containing a name key or a simple ID.

lists: [ 2, { "name": "Another To Create" }, 45 ]

By default, users will be subsribed to the list associated with the DonationPage in ActionKit. You can send an empty list to prevent a user from being subscribed.

lists: []

• akid

If you include an akid, the action source will be set to the mailing id included in the akid. If the email submitted does not match the email of the user in the akid, the user id and the mailing id from the akid will be saved as the action's referring_user_id and referring_mailing_id, respectively.

• source

The source field will be used to set the value of core_user.source as well as core_action.source. You can set a distinct source for the action using an additional source field in the action data.

DonationPage¶

Required fields:

• name, a URL safe name for the page

Optional fields:

OMG SO MANY!!

You can send any field supported by the RESTful API here. We don't really recommend creating DonationPages this way, but you can. See /rest/v1/donationpage/schema/ for the full list of fields.

ActionKit will create the DonationPage if it does not exist, but will never update an existing page based on input provided here.

Action¶

Optional fields:

• created_at, a timestamp for the action
• source, a string used for the source field in the core_action table. If no source is set in user, this will be used for the core_user source field as well.
• fields, a dictionary of action fields
• skip_confirmation, if true do not send the confirmation email